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

Chiusa Adatta ai principianti
  • Qualcosa non va?
#66,893 0 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
go
Ambito
cli, documentation

Direzione di ricerca

Inizia da docs/src/content/docs/setup/cli.md e dall’output della guida di gh aw work-queue citato nell’issue; confronta le voci vicine relative ai comandi di utilità e le convenzioni condivise per i flag. Documenta il comando sperimentale, i suoi sottocomandi e flag elencati, e allinea le definizioni dei flag oppure spiega qualsiasi differenza intenzionale. Il lavoro è concluso quando la documentazione della CLI copre work-queue e le sue opzioni, e i flag rispettano le convenzioni indicate oppure la loro eccezione è documentata.

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

Descrizione

automation cli cookie documentation
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-queue and subcommands cancel-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-queue has 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 format and -r, --repo string Target repository ([HOST/]owner/repo format). Defaults to current repository.
  • Expected: short flags -j/-r and the standard description wording (or a documented reason for omitting GHES host support).
  • Suggested fix: align work-queue flag 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
Lingua principale
Go
Stelle
5.4k
Fork
584
Merge medio
3h 59m
PR unite (30g)
823

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.