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

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

Direzione di ricerca

Apri docs/src/content/docs/setup/cli.md e rivedi l’elenco degli artefatti di audit e la sezione work-queue. Confronta la documentazione di work-queue con i flag dei sottocomandi elencati nell’issue; l’issue suggerisce anche di documentare quei flag o di dichiarare che gh aw work-queue <subcommand> --help è autorevole. Il lavoro è completato quando sono documentati l’insieme outcomes e le indicazioni sui flag di work-queue.

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

Descrizione

automation cli cookie documentation
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 the logs section at line ~1271 does ("All available artifact sets: ... mcp, outcomes, usage, work-queue").
  • Fix: add outcomes to the audit artifact list in cli.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-queue section 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> --help is authoritative.

Inspection metadata
  • Method: scanned the flag list in all-help.txt against cli.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
Lingua principale
Go
Stelle
5.5k
Fork
606
Merge medio
4h 18m
PR unite (30g)
796

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.