Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[cli-consistency] CLI Consistency Issues - 2026-10-20

クローズ 初心者向け
  • 何か問題がありますか？
#70,526 コメント 44 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
github-actions, go
領域
cli, documentation

調査の方向性

docs/src/content/docs/setup/cli.md の1247～1275行あたりを読み、作業キューのセクションを help-output/ にある各コマンドのヘルプ出力と比較してください。列挙されているフラグの説明を該当するサブコマンドの項目に追加するか、各サブコマンドの --help を参照するよう読者に案内してください。すべてのフラグが網羅され、セットアップページがヘルプ出力と一致すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

automation cli cookie documentation
Summary

Inspected the pre-collected help output (/tmp/gh-aw/agent/all-help.txt plus per-command files in help-output/) and compared it with docs/src/content/docs/setup/cli.md.

Severity Count
high 0
medium 0
low 1

No typos were found in the help text, and every top-level command appears in cli.md.

Documentation gaps
1. work-queue subcommand flags are missing from cli.md (low)

Affected commands: work-queue cancel-claim, deploy, dispatch-next, explain, inspect, policy, replay, reprioritize, state, submit-graph, submit-work, trace.

Actual: the work-queue section of cli.md (about lines 1247–1275) lists only some flags. The help output documents these flags, and none of them appear anywhere in cli.md:

submit-work: --pool ("Approved scheduling pool (default "default")"), --worker-profile, --priority, --execution-ref, --expires-at, --file
deploy: --from-config, --pool, --worker-profile
dispatch-next: --pool, --max-claims, --max-dispatches
replay: --pool, --file, --run-id, --max-claims, --max-dispatches
explain: --pool, --before-claim
state: --pool, --offset, --search
trace: --claim-id, --offset
cancel-claim / inspect: --claim-id
policy: --epoch, --file, --from-config
reprioritize: --priority
submit-graph: --file

Expected: the cli.md table or text covers these flags, or points readers to gh aw work-queue <subcommand> --help. Some are mentioned in the reference docs, for example --pool in 7 places. The setup CLI page is the one place where the flag set is incomplete.

Suggested fix: add a flag row or sentence per subcommand to the work-queue table in cli.md. Alternatively, generate that table from the help output.

Priority: low.

Inspection metadata
  • Date: 2026-10-20
  • Run: 39429930172
  • Method: Scanned all-help.txt and the per-command help files for typos, then did a scripted cross-check of every long flag in the help files against cli.md.
  • Scope: about 570 help files, including the --banner and --version variants. The top-level command list was checked against cli.md.
  • Not flagged: work-queue --repo says "(owner/repo format)", while other commands say "([HOST/]owner/repo format)". The docs describe this as intentional ("no host prefix").

Generated by ✅ CLI Consistency Checker · copilot · auto · 22.7 AIC · ⌖ 0.612 AIC · ⊞ 8.5K · ◷

  • expires on Oct 22, 2026, 5:34 AM UTC-08:00
主要言語
Go
スター
5.4k
フォーク
596
平均マージ
3時間 40分
マージ済み PR（30日）
830

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/gh-aw のほかの issue

github/gh-aw の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。