[cli-consistency] CLI Consistency Issues - 2026-10-28
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 76/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions, go
- 领域
- cli, documentation
调研方向
从 docs/src/content/docs/setup/cli.md 开始，将 init、add、add-wizard、update、upgrade 和 deploy 的 Options 行与 issue 中描述的帮助输出进行比较。根据 pkg/cli/add_command.go:244 检查 --pr 示例，并将 lint --json 与其他命令的 JSON 标志进行比较。当文档和标志帮助与预期的 CLI 行为一致时，工作即告完成。
由索引模型根据 Issue 内容生成。
描述
Summary
Compared the pre-collected help output (all-help.txt, help-output/) with docs/src/content/docs/setup/cli.md. I found 3 minor issues: 0 high, 1 medium, 2 low. I found no typos in the help text.
Documentation gaps
1. --pr-message missing from the Options lines (medium)
- Commands:
init,add,add-wizard,update,upgrade,deploy - The help output lists
--pr-message string Append a custom Markdown message to the generated pull request description. - The
**Options:**lines for these commands incli.mddo not list--pr-message. It is described only in the shared pull-request section, around line 110. - Suggested fix: add
--pr-messageto each command's Options line.
Flag inconsistencies
2. --pr is hidden but used in help examples (low)
-
Commands:
add,update,init,upgrade -
pkg/cli/add_command.go:244runsMarkHidden("pr"), with the comment "Hide the short alias from help output". -
The help examples and flag descriptions still use it:
gh aw add githubnext/agentics/ci-doctor --pr --auto-mergeEnable auto-merge on the created pull request (requires --pr or --create-pull-request)
-
The Flags list never shows
--pr, so readers cannot see it is a valid flag. -
Suggested fix: unhide
--pr, or use only--create-pull-requestin help text.
3. lint --json has no -j short flag (low)
- 17 commands define
-j, --json Output results in JSON format. gh aw lintshows--json Emit structured diagnostics (requires --rules)with no-j.- Suggested fix: add
-jfor consistency, or document whylintdiffers.
Inspection metadata
- Date: 2026-10-28
- Run: 40694787288
- Method: scripted comparison of flags in
help-output/--banner-*.txtagainst the**Options:**lines incli.md. I also did a typo scan and a short-flag pairing comparison across commands. - Commands inspected: about 45 top-level commands plus subcommands.
Generated by ✅ CLI Consistency Checker · copilot · auto · ~31 AIC · ⌖ ~1 AIC · ⊞ 4.3K · ◷
- expires on Oct 30, 2026, 5:29 AM UTC-08:00
- 主要语言
- Go
- 星标
- 5.5k
- 派生
- 606
- 平均合并
- 4 小时 8 分钟
- 30 天内合并 PR
- 813
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/gh-aw 的其他 Issue
-
agent-research
难度 2/5 1-3 小时 新手友好度 64/100
维护者通常 1 天内回复
-
automation documentation enhancement
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 1 天内回复
-
ai-inspected
难度 2/5 1-3 小时 新手友好度 83/100
维护者通常 1 天内回复
-
[doc-healer] DDUw improvement: retry integrity-filtered issue reads with direct single-item lookups未关闭automation documentation
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
automated-analysis code-quality cookie testing
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
Gaurav-Gosain/tuios#1316 ·
维护者通常 1 天内回复
-
area:auth documentation priority:low
难度 1/5 1-3 小时 新手友好度 86/100
维护者通常 1 天内回复
-
Mend: dependency security vulnerability
难度 2/5 1-3 小时 新手友好度 65/100
kube-tarian/sigrun#203 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
kubernetes-csi/csi-driver-iscsi#485 ·
维护者通常 1 天内回复
-
good first issue
难度 2/5 1-3 小时 新手友好度 72/100
eugenioenko/ttt#1276 ·
维护者通常 1 天内回复