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

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

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

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

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

評価

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

調査の方向性

docs/src/content/docs/setup/cli.mdから始め、compile --actions-lockの段落とwork-queueサブコマンドの表を、issueで言及されているコマンドヘルプと比較してください。コンパイラがドキュメントに記載されたフラグの組み合わせを拒否するか確認し、--read-onlyを削除するか実装するかを判断してください。それに応じてドキュメントまたはフラグの動作を更新し、work-queueフラグがドキュメントに記載されているか、ページがサブコマンドのヘルプを参照するよう案内していることを確認してください。

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

説明

automation cli cookie documentation
Summary

Compared /tmp/gh-aw/agent/all-help.txt and per-command help files with docs/src/content/docs/setup/cli.md. Found 2 low-severity documentation gaps. Severity: high 0, medium 0, low 2.

Documentation mismatches
1. compile --actions-lock docs reference a nonexistent --read-only flag (low)
  • Affected command: gh aw compile
  • Docs (cli.md, --actions-lock paragraph): "Cannot be combined with --no-emit, --read-only, --watch, or --dry-run"
  • Actual help: compile lists --no-emit, --watch, --dry-run and --actions-lock, but no --read-only flag.
  • Suggested fix: Remove --read-only from the docs, or add the flag if it is intended. Also confirm that the compiler rejects the intended combinations.
2. work-queue subcommand flags are only partially documented (low)
  • Affected commands: gh aw work-queue <subcommand> (alias work)
  • Docs: cli.md has a per-subcommand table that does not mention these flags.
  • Actual help: these flags appear only in all-help.txt: --before-claim, --claim-id, --epoch, --execution-ref, --expires-at, --file, --from-config, --graph, --max-claims, --max-dispatches, --offset, --pool, --priority, --run-id, --worker-profile. Example help lines: --pool string Limit deployment updates to this existing scheduling pool, --priority int New class 1..5 (configured weighted shares, not strict priority).
  • Suggested fix: Add the missing flags to the subcommand table, or state explicitly that gh aw work-queue <subcommand> --help is the reference for them. The docs already say to use --help for subcommand options.
Inspection metadata
  • Date: 2026-10-27
  • Method: Compared the flag sets in all-help.txt and cli.md, grepped for common typos, and checked short/long flag pairings.
  • Scope: all top-level commands and work-queue subcommands in all-help.txt.
  • No typos or short-flag conflicts were found.
  • Run: 40511994232

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

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

環境構築

Codespaces で開く

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

はじめの一歩

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

github/gh-aw のほかの issue

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

似ている issue

Go の issue をもっと見る

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

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