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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#72,447 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
76/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

Empieza por docs/src/content/docs/setup/cli.md y compara el párrafo de compile --actions-lock y la tabla de subcomandos de work-queue con la ayuda del comando mencionada en la issue. Comprueba si el compilador rechaza las combinaciones de flags documentadas y decide si se debe eliminar --read-only o implementarlo. Actualiza la documentación o el comportamiento de los flags según corresponda, y confirma que los flags de work-queue están documentados o que la página remite a la ayuda de los subcomandos.

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

Descripción

automation cli cookie documentation
Summary

Compared /tmp/gh-aw/agent/all-help.txt and per-command help files with docs/src/content/docs/setup/cli.md. Found 2 low-severity documentation gaps. Severity: high 0, medium 0, low 2.

Documentation mismatches
1. compile --actions-lock docs reference a nonexistent --read-only flag (low)
  • Affected command: gh aw compile
  • Docs (cli.md, --actions-lock paragraph): "Cannot be combined with --no-emit, --read-only, --watch, or --dry-run"
  • Actual help: compile lists --no-emit, --watch, --dry-run and --actions-lock, but no --read-only flag.
  • Suggested fix: Remove --read-only from the docs, or add the flag if it is intended. Also confirm that the compiler rejects the intended combinations.
2. work-queue subcommand flags are only partially documented (low)
  • Affected commands: gh aw work-queue <subcommand> (alias work)
  • Docs: cli.md has a per-subcommand table that does not mention these flags.
  • Actual help: these flags appear only in all-help.txt: --before-claim, --claim-id, --epoch, --execution-ref, --expires-at, --file, --from-config, --graph, --max-claims, --max-dispatches, --offset, --pool, --priority, --run-id, --worker-profile. Example help lines: --pool string Limit deployment updates to this existing scheduling pool, --priority int New class 1..5 (configured weighted shares, not strict priority).
  • Suggested fix: Add the missing flags to the subcommand table, or state explicitly that gh aw work-queue <subcommand> --help is the reference for them. The docs already say to use --help for subcommand options.
Inspection metadata
  • Date: 2026-10-27
  • Method: Compared the flag sets in all-help.txt and cli.md, grepped for common typos, and checked short/long flag pairings.
  • Scope: all top-level commands and work-queue subcommands in all-help.txt.
  • No typos or short-flag conflicts were found.
  • Run: 40511994232

Generated by ✅ CLI Consistency Checker · copilot · auto · ~25 AIC · ⌖ ~1 AIC · ⊞ 4.3K · ◷

  • expires on Oct 29, 2026, 5:42 AM UTC-08:00
Lenguaje dominante
Go
Estrellas
5.5k
Forks
606
Merge medio
4 h 8 min
PR fusionados (30 d)
813

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.