gh-cli について
gh-cliは、GitHubのタスクでghを使う人向けに公式マニュアルを補足するガイドです。リスト出力の制限、スクリプト向けJSON、gh apiによるPR行内コメントを扱います。
主な機能
- 01リストコマンドの取得件数を制限
- 02スクリプトでは--jsonとjqを使用
- 03gh apiでPR行内コメントを投稿
- 04レビュー前に差分を確認
活用シーン
- 01PR、Issue、実行履歴の一覧を絞る
- 02ghの出力をスクリプトで処理
- 03PR差分の特定行にコメント
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ fredrikaverpil/ dotfiles --skill gh-cliインストール後、Claude Code で/gh-cliを入力して読み込まれたか確認します。
詳細
gh CLI
gh --help および https://cli.github.com/manual にコマンドの一覧が記載されています。このスキルでは、それらで説明されていない内容のみを扱います。
規約
- すべての一覧表示コマンド(
pr list、issue list、run list)に--limit Nを指定してください。デフォルトでは、ターミナルで必要な量を大幅に超える内容が表示されます。 - 出力をスクリプトに渡す場合は
--json FIELDSを指定し、そこからjqにパイプしてください。
行単位のコメントを付けて PR をレビューする
gh pr review で送信できるのは全体向けの本文のみです。インラインコメントには gh api が必要です。これを使うと、コメントと概要を1回の呼び出しで投稿できます。まず差分を確認してから(gh pr diff NUMBER)、次のようにします。
gh api repos/{owner}/{repo}/pulls/NUMBER/reviews --input - <<'EOF'
{
"commit_id": "LATEST_COMMIT_SHA",
"event": "COMMENT",
"body": "Overall: solid changes with a few suggestions.",
"comments": [
{
"path": "src/example.go",
"line": 42,
"side": "RIGHT",
"body": "This variable is unused."
}
]
}
EOF
side は追加の場合は RIGHT、削除の場合は LEFT です。複数行のコメントでは start_line と start_side を追加します。body には、置き換えるコードを提案する GitHub のサジェストブロック(```suggestion)を含めることができます。
event は COMMENT、APPROVE、または REQUEST_CHANGES です。送信前にどれにするか私に確認し、指定がなければ COMMENT を使用してください。
コメント
Markdown 対応