コンテンツにスキップ
Backlog CLI Backlog CLI

認証

bee は 2 つの認証方式をサポートしています。

API キー認証

Section titled “API キー認証”

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

Terminal window
bee auth login

対話形式でスペースのホスト名（例: xxx.backlog.com）と API キーの入力を求められます。API キーは Backlog の 個人設定 > API から発行できます。

Terminal window
export BACKLOG_API_KEY=your-api-key
export BACKLOG_SPACE=xxx.backlog.com
bee issue list --project MY_PROJECT

パイプで API キーを渡す

Section titled “パイプで API キーを渡す”

--with-token フラグを使うと、標準入力から API キーを渡せます。セットアップスクリプトや CI 環境で便利です。

Terminal window
# ファイルから読み込む（シェル履歴に残らない）
bee auth login --with-token < ~/.backlog-api-key


# 環境変数から渡す
echo "$BACKLOG_API_KEY" | BACKLOG_SPACE=xxx.backlog.com bee auth login --with-token

OAuth 認証

Section titled “OAuth 認証”

OAuth を使うと、API キーを直接扱わずに認証できます。

OAuth クライアントの登録

Section titled “OAuth クライアントの登録”

事前に Backlog で OAuth クライアントを登録する必要があります。

  1. Backlog のスペース設定を開きます
  2. スペース設定 > OAuth アプリケーション に移動します
  3. 「新しいアプリケーションを登録」をクリックします
  4. 以下を入力して登録します
    • 名前: 任意（例: bee）
    • リダイレクト URI: http://localhost:5033/callback
  5. 登録後に表示される Client ID と Client Secret をメモします

ログイン

Section titled “ログイン”
Terminal window
bee auth login --method oauth

ブラウザが開き、Backlog の認証画面が表示されます。承認するとトークンが自動的に取得されます。

事前に環境変数 BACKLOG_OAUTH_CLIENT_ID と BACKLOG_OAUTH_CLIENT_SECRET を設定してください。

Terminal window
export BACKLOG_OAUTH_CLIENT_ID=YOUR_ID
export BACKLOG_OAUTH_CLIENT_SECRET=YOUR_SECRET
bee auth login --method oauth

どちらを選ぶべきか

Section titled “どちらを選ぶべきか”

API キーがおすすめな場合

手軽に始めたいなら API キーが最適です。

個人利用や CI/CD
セットアップがシンプルで、環境変数だけで完結します。
すぐに使い始めたい場合
Backlog の個人設定から API キーを発行するだけで利用できます。

OAuth がおすすめな場合

セキュリティを重視するなら OAuth がおすすめです。

チームでの利用
OAuth クライアントを共有し、各メンバーが自分のアカウントで認証できます。
有効期限の短いトークン
OAuth のアクセストークンは有効期限が短いため、AI ツールや外部サービスにトークンを渡す場合でも、漏洩時のリスクを抑えられます。期限切れ時は bee が自動で更新します。

複数スペースの管理

Section titled “複数スペースの管理”

複数の Backlog スペースにログインしている場合、bee auth switch でアクティブなスペースを切り替えられます。

Terminal window
bee auth switch

現在の認証状態は bee auth status で確認できます。

Terminal window
bee auth status

認証情報の外部管理

Section titled “認証情報の外部管理”

パスワードマネージャーや OS のクレデンシャルストアを使うと、環境変数経由で認証情報を渡せます。この方法では ~/.beerc に認証情報が保存されません。

1Password CLI (op) を使う場合:

Terminal window
BACKLOG_API_KEY=$(op read "op://vault/backlog/api-key") \
  BACKLOG_SPACE=xxx.backlog.com \
  bee issue list --project MY_PROJECT

シェルの設定ファイルにエイリアスを登録しておくと便利です。

Terminal window
alias bee='BACKLOG_API_KEY=$(op read "op://vault/backlog/api-key") BACKLOG_SPACE=xxx.backlog.com bee'

関連コマンド

Section titled “関連コマンド”
auth login ログイン
auth logout ログアウト
auth status 認証状態の確認
auth switch スペースの切り替え
auth token トークンの表示
auth refresh OAuth トークンの更新