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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#70,526 44 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
78/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github-actions, go
Área
cli, documentation

Línea de trabajo

Lee docs/src/content/docs/setup/cli.md alrededor de las líneas 1247–1275 y compara la sección de la cola de trabajo con la salida de ayuda de cada comando en help-output/. Añade documentación para las opciones enumeradas en las entradas de los subcomandos pertinentes o indica a los lectores que consulten --help de cada subcomando. La tarea estará completa cuando se cubran todas las opciones enumeradas y la página de configuración coincida con la salida de ayuda.

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 (/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
Lenguaje dominante
Go
Estrellas
5.4k
Forks
596
Merge medio
3 h 24 min
PR fusionados (30 d)
824

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.