コンテンツにスキップ

認証

Backlog CLIを使うには、まずBacklogスペースへの認証が必要です。APIキーとOAuth 2.0の2つの認証方式に対応しています。

最もシンプルな認証方式です。Backlogの「個人設定 > API」ページからAPIキーを発行して使用します。

Terminal window
backlog auth login --method api-key

対話形式でホスト名とAPIキーの入力を求められます。パイプでAPIキーを渡すことも可能です。

Terminal window
echo "YOUR_API_KEY" | backlog auth login --with-token

ブラウザベースの認証フローで、APIキーの手動管理が不要な認証方式です。

Terminal window
backlog auth login --method oauth

ブラウザが自動で開き、認証が完了するとトークンが保存されます。トークンの有効期限が切れた場合はリフレッシュできます。

Terminal window
backlog auth refresh

現在の認証状態を確認するには、次のコマンドを実行します。

Terminal window
backlog auth status

特定のスペースの認証状態を確認したい場合は --space フラグを指定します。

Terminal window
backlog auth status --space your-space.backlog.com

トークンの値を確認する場合は --show-token フラグを付けます。

Terminal window
backlog auth status --show-token

複数のBacklogスペースに認証し、切り替えながら使うことができます。

Terminal window
# スペース A に認証
backlog auth login --space space-a.backlog.com
# スペース B に認証
backlog auth login --space space-b.backlog.com

デフォルトスペースの切り替え

Section titled “デフォルトスペースの切り替え”

普段使うスペースを切り替えるには auth switch を使います。

Terminal window
backlog auth switch --space space-b.backlog.com

コマンド実行時のスペース指定

Section titled “コマンド実行時のスペース指定”

--space グローバルフラグを使うと、デフォルトスペースを変更せずに一時的に別のスペースを対象にできます。

Terminal window
backlog issue list --project PROJ --space space-b.backlog.com

Backlog CLIは次の優先順位でスペースを決定します。

  1. --space フラグ / BACKLOG_SPACE 環境変数 / 設定ファイルの defaultSpace + 設定ファイルの認証情報
  2. BACKLOG_API_KEY + BACKLOG_SPACE 環境変数(フォールバック)

環境変数による認証(CI / AI エージェント向け)

Section titled “環境変数による認証(CI / AI エージェント向け)”

backlog auth login を実行できない非インタラクティブ環境(CIパイプライン、AIエージェント等)では、環境変数だけで認証できます。

Terminal window
export BACKLOG_SPACE=your-space.backlog.com
export BACKLOG_API_KEY=your-api-key
# backlog auth login なしで利用可能
backlog issue list --project YOUR_PROJECT

CI環境でのセットアップの詳細は CI での利用ガイド を参照してください。

認証情報は ~/.backlogrc ファイルに保存されます。環境変数 XDG_CONFIG_HOME が設定されている場合は $XDG_CONFIG_HOME/.backlogrc に保存されます。

設定ファイルの管理には rc9 を使用しています。

スペースの認証情報を削除するには auth logout を使います。

Terminal window
# デフォルトスペースからログアウト
backlog auth logout
# 特定のスペースからログアウト
backlog auth logout --space your-space.backlog.com