コンテンツにスキップ

環境変数

環境変数を設定すると、頻繁に使うフラグを省略できます。

BACKLOG_SPACE
デフォルトのスペースホスト名(例: xxx.backlog.com)。設定すると、bee auth login でスペースの入力を省略できます。BACKLOG_API_KEY と併用すると、ログイン不要で bee を利用できます。
BACKLOG_PROJECT
デフォルトのプロジェクト ID またはプロジェクトキー(例: MY_PROJECT)。設定すると、--project フラグを省略できます。
BACKLOG_REPO
デフォルトのリポジトリ名(例: my-repo)。設定すると、--repo フラグを省略できます。
BACKLOG_API_KEY
API キーによる認証に使用します。BACKLOG_SPACE と併用すると、bee auth login を実行しなくても認証済みの状態で bee を利用できます。CI/CD 環境で特に便利です。
BACKLOG_OAUTH_CLIENT_ID
OAuth 認証で使用するクライアント ID。bee auth login --method oauth で必須です。
BACKLOG_OAUTH_CLIENT_SECRET
OAuth 認証で使用するクライアントシークレット。bee auth login --method oauth で必須です。
BACKLOG_OAUTH_PORT
OAuth 認証で使用するコールバックサーバーのポート番号。デフォルトは 5033。別のアプリケーションとポートが競合する場合に変更できます。

毎回 --project を指定する代わりに、環境変数を設定します。

Terminal window
export BACKLOG_PROJECT=MY_PROJECT
bee issue list # --project MY_PROJECT と同じ
bee issue create # プロジェクトが自動選択される
bee issue list --project OTHER_PROJECT # フラグで上書きも可能

.bashrc.zshrc に追加して永続化します。

Terminal window
export BACKLOG_SPACE=your-space.backlog.com
export BACKLOG_PROJECT=YOUR_PROJECT

プロジェクトごとに環境変数を固定するには、mise の [env] セクションが便利です。

mise.toml
[env]
BACKLOG_SPACE = "your-space.backlog.com"
BACKLOG_PROJECT = "YOUR_PROJECT"

非対話環境では BACKLOG_API_KEY を設定して使います。詳しくは CI/CD での利用 を参照してください。

.github/workflows/example.yml
env:
BACKLOG_API_KEY: ${{ secrets.BACKLOG_API_KEY }}
BACKLOG_SPACE: ${{ secrets.BACKLOG_SPACE }}