出力形式

Backlog CLIは用途に応じて出力形式を切り替えられます。ターミナルでの確認にはテーブル形式、スクリプトやCIでの連携にはJSON形式が便利です。

テーブル形式（デフォルト）

フラグを指定しない場合、人間が読みやすいテーブル形式で出力されます。

backlog issue list --project PROJ

#    種別    優先度  担当者   件名
123  タスク  中      yamada   API エンドポイントの設計
124  バグ    高      tanaka   ログインページの表示崩れ

JSON 形式

--json フラグを付けるとJSON形式で出力されます。

# 全フィールドを JSON で出力
backlog issue list --project PROJ --json

# 特定のフィールドのみ出力
backlog issue list --project PROJ --json issueKey,summary,status

ターミナル（TTY）に接続されている場合はインデント付きの整形JSONが、パイプに接続されている場合はコンパクトな1行JSONが出力されます。

スクリプトでの活用

JSON出力と jq を組み合わせることで、さまざまなデータ加工が可能です。

# 課題キーだけを抽出
backlog issue list --project PROJ --json | jq '.[].issueKey'

# 高優先度の課題だけをフィルタ
backlog issue list --project PROJ --json | jq '[.[] | select(.priority.name == "高")]'

# 課題キーの一覧を取得してループ処理
backlog issue list --project PROJ --json | jq -r '.[].issueKey' | while read key; do
  backlog issue close "$key"
done

対応コマンド

--json フラグは以下のカテゴリのコマンドで利用できます。

コマンドの種類	--json の出力形式	例
一覧系（list）	配列	backlog issue list
詳細表示（view）	オブジェクト	backlog issue view PROJ-1
カウント（count）	{ count: number }	backlog notification count
ダッシュボード	ユーザー情報・課題・通知をまとめたオブジェクト	backlog dashboard