Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta Adatta ai principianti
  • Qualcosa non va?
#70,526 44 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github-actions, go
Ambito
cli, documentation

Direzione di ricerca

Leggi docs/src/content/docs/setup/cli.md intorno alle righe 1247–1275 e confronta la sezione sulla coda di lavoro con l’output di aiuto di ciascun comando in help-output/. Aggiungi la documentazione delle opzioni elencate alle voci dei sottocomandi pertinenti oppure rimanda i lettori all’output --help di ciascun sottocomando. Il lavoro è completato quando tutte le opzioni elencate sono documentate e la pagina di configurazione corrisponde all’output di aiuto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

automation cli cookie documentation
Summary

Inspected the pre-collected help output (/tmp/gh-aw/agent/all-help.txt plus per-command files in help-output/) and compared it with docs/src/content/docs/setup/cli.md.

Severity Count
high 0
medium 0
low 1

No typos were found in the help text, and every top-level command appears in cli.md.

Documentation gaps
1. work-queue subcommand flags are missing from cli.md (low)

Affected commands: work-queue cancel-claim, deploy, dispatch-next, explain, inspect, policy, replay, reprioritize, state, submit-graph, submit-work, trace.

Actual: the work-queue section of cli.md (about lines 1247–1275) lists only some flags. The help output documents these flags, and none of them appear anywhere in cli.md:

submit-work: --pool ("Approved scheduling pool (default "default")"), --worker-profile, --priority, --execution-ref, --expires-at, --file
deploy: --from-config, --pool, --worker-profile
dispatch-next: --pool, --max-claims, --max-dispatches
replay: --pool, --file, --run-id, --max-claims, --max-dispatches
explain: --pool, --before-claim
state: --pool, --offset, --search
trace: --claim-id, --offset
cancel-claim / inspect: --claim-id
policy: --epoch, --file, --from-config
reprioritize: --priority
submit-graph: --file

Expected: the cli.md table or text covers these flags, or points readers to gh aw work-queue <subcommand> --help. Some are mentioned in the reference docs, for example --pool in 7 places. The setup CLI page is the one place where the flag set is incomplete.

Suggested fix: add a flag row or sentence per subcommand to the work-queue table in cli.md. Alternatively, generate that table from the help output.

Priority: low.

Inspection metadata
  • Date: 2026-10-20
  • Run: 39429930172
  • Method: Scanned all-help.txt and the per-command help files for typos, then did a scripted cross-check of every long flag in the help files against cli.md.
  • Scope: about 570 help files, including the --banner and --version variants. The top-level command list was checked against cli.md.
  • Not flagged: work-queue --repo says "(owner/repo format)", while other commands say "([HOST/]owner/repo format)". The docs describe this as intentional ("no host prefix").

Generated by ✅ CLI Consistency Checker · copilot · auto · 22.7 AIC · ⌖ 0.612 AIC · ⊞ 8.5K · ◷

  • expires on Oct 22, 2026, 5:34 AM UTC-08:00
Lingua principale
Go
Stelle
5.4k
Fork
596
Merge medio
3h 24m
PR unite (30g)
824

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/gh-aw

Tutte le issue di github/gh-aw

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.