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

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

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

@github-actions がすでに取り組んでいます。

2026年10月31日 から。

  • #73593 @github-actions による — オープン

評価

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

調査の方向性

docs/src/content/docs/setup/cli.mdを開き、監査成果物の一覧とwork-queueのセクションを確認してください。work-queueのドキュメントを、issueに記載されたサブコマンドのフラグと照合してください。issueでは、それらのフラグをドキュメントに記載するか、gh aw work-queue <subcommand> --helpが正式な情報源であると明記することも提案されています。outcomesセットとwork-queueのフラグに関する案内がドキュメントに記載されれば完了です。

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

説明

automation cli cookie documentation
Summary

Inspected the pre-collected help output (all-help.txt and the per-command files) against docs/src/content/docs/setup/cli.md. Found 2 documentation gaps: 0 high, 1 medium, 1 low.

Findings
1. audit --artifacts docs omit the outcomes set (medium)
  • Command: gh aw audit
  • CLI help: Valid sets: activation, agent, all, detection, evals, experiment, firewall, github-api, graders, info, mcp, outcomes, usage, work-queue
  • Docs (cli.md, line ~820): Valid sets include activation, agent, all, detection, evals, experiment, firewall, github-api, graders, info, mcp, usage, and work-queue.
  • Expected: the docs list outcomes, as the logs section at line ~1271 does ("All available artifact sets: ... mcp, outcomes, usage, work-queue").
  • Fix: add outcomes to the audit artifact list in cli.md.
2. work-queue subcommand flags missing from cli.md (low)

These flags appear in gh aw work-queue ... --help but nowhere in cli.md:
--before-claim, --claim-id, --epoch, --execution-ref, --expires-at, --file, --from-config, --max-claims, --max-dispatches, --offset, --pool, --priority, --run-id, --worker-profile.

Examples from the help output:

  • --pool string Predict a fair dispatch from the captured ledger without writes or launches

  • --file string Replay a downloaded work-queue.snapshot.json (read only)

  • --from-config Resolve current scheduling and approved AW workers from the target repository's immutable default ref

  • Expected: the work-queue section documents per-subcommand flags, or links to a reference page that does.

  • Fix: add the flags to the subcommand table, or state that gh aw work-queue <subcommand> --help is authoritative.

Inspection metadata
  • Method: scanned the flag list in all-help.txt against cli.md. Also checked for typos and --no-* naming patterns. No typos or --no-* inconsistencies were found.
  • Commands inspected: all top-level commands and the work-queue subcommands in the pre-collected output.
  • Date: 2026-10-29

References: §40880383913

Generated by ✅ CLI Consistency Checker · copilot · auto · ~23 AIC · ⌖ ~1 AIC · ⊞ 4.3K · ◷

  • expires on Oct 31, 2026, 5:32 AM UTC-08:00
主要言語
Go
スター
5.5k
フォーク
606
平均マージ
4時間 44分
マージ済み PR（30日）
799

環境構築

Codespaces で開く

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

はじめの一歩

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

github/gh-aw のほかの issue

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

似ている issue

Go の issue をもっと見る

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

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