[cli-consistency] CLI Consistency Issues - 2026-10-29
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 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 内容生成。
描述
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 thelogssection at line ~1271 does ("All available artifact sets: ... mcp, outcomes, usage, work-queue"). - Fix: add
outcomesto the audit artifact list incli.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-queuesection 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> --helpis authoritative.
Inspection metadata
- Method: scanned the flag list in
all-help.txtagainstcli.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 小时 35 分钟
- 30 天内合并 PR
- 807
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/gh-aw 的其他 Issue
-
automation doc-healer documentation
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
agent-research
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
automation cookie
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
agentic-workflows automation aw-essential cookie
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
automated-analysis code-quality cookie refactoring
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
相似的 Issue
-
docs(prompts): IF BLOCKED workflow-scope branch says to comment on the issue on jira/local trackers未关闭agent-butler-finding bug
难度 2/5 1-3 小时 新手友好度 77/100
jordansmall/spindrift#6238 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
microcks/microcks-cli#608 · 1 条评论 ·
维护者通常 1 天内回复
-
bug from-studio
难度 2/5 1-3 小时 新手友好度 65/100
esengine/DeepSeek-Reasonix#14868 ·
维护者通常 1 天内回复
-
Install notes print "Camunda REST API: https://" without a host when global.host is set可能已有人在做 @irisfield 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
camunda/camunda-platform-helm#7790 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
wso2/agent-manager#2220 ·
维护者通常 1 天内回复