クイックスタート

このガイドでは、Backlog CLI のセットアップから基本的な操作までを説明します。

セットアップ

認証する

まず Backlog スペースに認証する。対話形式でホスト名と認証方式を選択できる。
Terminal window
```
backlog auth login
```
API キーを使う場合は、ホスト名と認証方式を直接指定できる。
Terminal window
```
backlog auth login --space your-space.backlog.com --method api-key
```
認証状態を確認する

認証が正しく設定されたことを確認する。
Terminal window
```
backlog auth status
```
ダッシュボードを表示する

ダッシュボードが表示されれば準備完了である。
Terminal window
```
backlog dashboard
```

プロジェクトの課題を一覧表示します。

backlog issue list --project YOUR_PROJECT

新しい課題を作成します。--type と --priority には日本語名をそのまま指定できます。

backlog issue create --project YOUR_PROJECT --title "新しい課題" --type バグ --priority 高

課題キーを指定して詳細を表示します。プロジェクトキーが課題キーに含まれるため、--project の指定は不要です。

backlog issue view PROJECT-123

アクセス可能なプロジェクトを一覧表示します。

backlog project list

未読の通知を確認します。

backlog notification list

自分に割り当てられた課題と未読通知の概要を一画面で確認できます。

backlog dashboard

デフォルトではテーブル形式で出力されます。--json フラグを付けると JSON 形式で取得できるため、他のツールとの連携に便利です。

# JSON で出力
backlog issue list --project YOUR_PROJECT --json

# 特定のフィールドだけを出力
backlog issue list --project YOUR_PROJECT --json issueKey,summary,status

詳しくは出力形式ガイドを参照してください。

各コマンドの詳しい使い方は --help フラグで確認できます。

backlog --help
backlog issue --help
backlog issue create --help