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-09

Aperta Adatta ai principianti
  • Qualcosa non va?
#67,211 3 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
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github
Ambito
cli, documentation

Direzione di ricerca

Le lacune si trovano in docs/src/content/docs/setup/cli.md. Esegui gh aw work-queue --help e gh aw compile --help per ottenere i sottocomandi e il testo di --allow-experimental, e controlla patterns/workqueue-ops.md per eventuali formulazioni già presenti. Il lavoro è completo quando cli.md contiene una sezione work-queue con i suoi sottocomandi e flag, e il paragrafo su --dry-run copre --allow-experimental.

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

Descrizione

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
Lingua principale
Go
Stelle
5.4k
Fork
576
Merge medio
8h 22m
PR unite (30g)
798

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.