Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#72,983 13 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
84/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go
Área
cli, documentation

Línea de trabajo

Abre docs/src/content/docs/setup/cli.md y revisa la lista de artefactos de auditoría y la sección de work-queue. Compara la documentación de work-queue con las opciones de los subcomandos enumeradas en el issue; el issue también sugiere documentar esas opciones o indicar que gh aw work-queue <subcommand> --help es la fuente de autoridad. Se considera terminado cuando estén documentados el conjunto outcomes y las indicaciones sobre las opciones de work-queue.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Go
Estrellas
5.5k
Forks
606
Merge medio
4 h 18 min
PR fusionados (30 d)
796

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/gh-aw

Todos los issues de github/gh-aw

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.