Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

已关闭 适合新手
  • 哪里不对？
#67,211 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
72/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
github
领域
cli, documentation

调研方向

缺口位于 docs/src/content/docs/setup/cli.md。运行 gh aw work-queue --help 和 gh aw compile --help，获取子命令以及 --allow-experimental 的说明文字，并检查 patterns/workqueue-ops.md 中是否已有现成的表述。完成的标准是：cli.md 中有一个包含子命令和参数的 work-queue 小节，并且 --dry-run 段落涵盖了 --allow-experimental。

由索引模型根据 Issue 内容生成。

描述

automation cli cookie documentation
Summary

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

Documentation gaps
1. gh aw work-queue command family is not documented in cli.md (medium)
  • Affected: gh aw work-queue and subcommands (cancel-claim, cancel-work, compact, control, dispatch-next, evidence, explain, ...).
  • CLI output: work-queue Inspect and publish the current fair Git-backed DAG work queue
  • Actual: cli.md has no gh aw work-queue section. The only mentions are --artifacts work-queue and the --dry-run note. Flags such as --storage, --branch, --request-id, --claim-id, --work-id, --pool, --max-claims, --max-dispatches and --max-bytes are absent from the CLI reference.
  • Expected: a command section, or a link to patterns/workqueue-ops.md from cli.md.
  • Suggested fix: add a work-queue section listing subcommands and flags, based on gh aw work-queue --help.
2. gh aw compile --allow-experimental is not documented (medium)
  • CLI output: --allow-experimental Accept experimental-feature notices during dry-run compilation; notices remain visible and all other warnings and scanner failures remain fatal
  • Actual: the flag does not appear in cli.md, including the --dry-run paragraph, which says warnings are errors.
  • Expected: the flag is documented alongside --dry-run.
  • Suggested fix: add a sentence to the --dry-run paragraph, or a flag entry, describing --allow-experimental.
Inspection metadata
  • Date: 2026-10-09
  • Method: automated flag-by-flag comparison of every command's help against cli.md, plus a typo scan of all-help.txt. No typos were found.
  • Scope: all top-level commands in all-help.txt (about 45) and their help files. Run: 37936811221.

Generated by ✅ CLI Consistency Checker · copilot · auto · 18.9 AIC · ⌖ 0.597 AIC · ⊞ 8.4K · ◷

  • expires on Oct 11, 2026, 5:33 AM UTC-08:00
主要语言
Go
星标
5.4k
派生
584
平均合并
3 小时 26 分钟
30 天内合并 PR
822

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

github/gh-aw 的其他 Issue

查看 github/gh-aw 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。