出力形式
Backlog CLI はさまざまな出力形式をサポートしています。
テーブル形式(デフォルト)
Section titled “テーブル形式(デフォルト)”フラグを指定しない場合、人間が読みやすいテーブル形式で出力されます。
backlog issue list --project PROJJSON 形式
Section titled “JSON 形式”--json フラグで JSON 形式の出力を取得できます。
# 全フィールドを JSON で出力backlog issue list --project PROJ --json
# 特定のフィールドのみ出力backlog issue list --project PROJ --json issueKey,summary,statusTTY(ターミナル)接続時は整形された JSON が出力され、パイプ時はコンパクトな JSON が出力されます。
スクリプトでの利用
Section titled “スクリプトでの利用”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 echo "Processing $key"done対応コマンド
Section titled “対応コマンド”--json フラグは以下のコマンドカテゴリで利用できます。
- 一覧系コマンド (
list): 配列として出力 - 詳細表示コマンド (
view): オブジェクトとして出力 - カウントコマンド (
count):{ count: number }として出力 - ダッシュボード (
status): ユーザー情報・課題・通知をまとめたオブジェクトとして出力