[cli-consistency] CLI Consistency Issues - 2026-10-08
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 78/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- go
- 领域
- cli, documentation
调研方向
从 docs/src/content/docs/setup/cli.md 和 issue 中引用的 gh aw work-queue 帮助输出开始；比较附近的实用工具命令条目和共享的 flag 约定。记录这个实验性命令、列出的子命令和 flag，并统一 flag 定义，或说明任何有意的差异。完成标准是 CLI 文档涵盖 work-queue 及其选项，并且 flag 符合所述约定，或者其例外情况已记录。
由索引模型根据 Issue 内容生成。
描述
Summary
Inspected ~45 top-level commands (plus subcommands, 510 help files) from /tmp/gh-aw/agent/all-help.txt. Found 2 issues: 0 high, 1 medium, 1 low.
Documentation gaps
1. work-queue is not documented in docs/src/content/docs/setup/cli.md (medium)
- Affected:
gh aw work-queueand subcommandscancel-claim,cancel-work,claim,compact,finish,replay,stats,submit-work. - CLI output:
work-queue Experimental: inspect and update a Git-backed work queue(listed under "Utilities"). - Actual: every other top-level command has a
gh aw <cmd>entry in cli.md;work-queuehas none (neither its flags--branch,--claim-id,--work-id,--attempt-id,--run-id,--file). - Suggested fix: add a section (marked experimental) under "Utility Commands" covering the subcommands and flags.
Flag-naming inconsistencies
2. work-queue uses non-standard --repo / --json flags (low)
- Quoted output:
--json Output JSON --repo string GitHub repository owner/repo - Elsewhere (164 and 116 occurrences respectively):
-j, --json Output results in JSON formatand-r, --repo string Target repository ([HOST/]owner/repo format). Defaults to current repository. - Expected: short flags
-j/-rand the standard description wording (or a documented reason for omitting GHES host support). - Suggested fix: align
work-queueflag definitions with the shared helpers used by other commands.
Inspection metadata
- Date: 2026-10-08; method: scripted comparison of all flags in per-command help files against cli.md, plus review of flag/description patterns (
--engine,--repo,--json,--output).
Generated by ✅ CLI Consistency Checker · copilot · auto · 20 AIC · ⌖ 0.593 AIC · ⊞ 8.4K · ◷
- expires on Oct 10, 2026, 5:34 AM UTC-08:00
- 主要语言
- Go
- 星标
- 5.4k
- 派生
- 576
- 平均合并
- 8 小时 29 分钟
- 30 天内合并 PR
- 783
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/gh-aw 的其他 Issue
-
[duplicate-code] Duplicate Code: pull_request event detection duplicated across safe_update files未关闭automated-analysis code-quality cookie refactoring
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
[deep-report] Migrate manual os.Setenv/Unsetenv restore patterns to t.Setenv in 2 pkg/cli test files未关闭automation code-quality cookie deep-report improvement quick-win task-mining
难度 2/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
automation code-quality cookie deep-report improvement quick-win task-mining
难度 2/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
-
automation code-quality cookie deep-report improvement quick-win task-mining
难度 2/5 1 小时以内 新手友好度 76/100
维护者通常 1 天内回复
-
ai-generated cookie high-priority security
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
相似的 Issue
-
agent-research agent-review-finding chore
难度 2/5 1-3 小时 新手友好度 66/100
jordansmall/spindrift#4922 ·
维护者通常 1 天内回复
-
gcsartifact: deleting a missing version returns an error可能已有人在做 @ktsoator 今天认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 2 天内回复
-
govulncheck
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
Change wording for init command success message可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
-
enhancement pkg:sdk
难度 2/5 1-3 小时 新手友好度 80/100
aws/aws-durable-execution-sdk-go#144 ·
维护者通常 1 天内回复