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

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#72,701 0 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 con docs/src/content/docs/setup/cli.md y compara las líneas de Options de init, add, add-wizard, update, upgrade y deploy con la salida de ayuda descrita en la issue. Comprueba los ejemplos de --pr en pkg/cli/add_command.go:244 y compara lint --json con los indicadores JSON de otros comandos. El trabajo estará terminado cuando la documentación y la ayuda de los indicadores coincidan con el comportamiento previsto de la CLI.

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

Descripción

automation cli cookie documentation
Summary

Compared the pre-collected help output (all-help.txt, help-output/) with docs/src/content/docs/setup/cli.md. I found 3 minor issues: 0 high, 1 medium, 2 low. I found no typos in the help text.

Documentation gaps

1. --pr-message missing from the Options lines (medium)

  • Commands: init, add, add-wizard, update, upgrade, deploy
  • The help output lists --pr-message string Append a custom Markdown message to the generated pull request description.
  • The **Options:** lines for these commands in cli.md do not list --pr-message. It is described only in the shared pull-request section, around line 110.
  • Suggested fix: add --pr-message to each command's Options line.
Flag inconsistencies

2. --pr is hidden but used in help examples (low)

  • Commands: add, update, init, upgrade

  • pkg/cli/add_command.go:244 runs MarkHidden("pr"), with the comment "Hide the short alias from help output".

  • The help examples and flag descriptions still use it:

    • gh aw add githubnext/agentics/ci-doctor --pr --auto-merge
    • Enable auto-merge on the created pull request (requires --pr or --create-pull-request)

  • The Flags list never shows --pr, so readers cannot see it is a valid flag.

  • Suggested fix: unhide --pr, or use only --create-pull-request in help text.

3. lint --json has no -j short flag (low)

  • 17 commands define -j, --json Output results in JSON format.
  • gh aw lint shows --json Emit structured diagnostics (requires --rules) with no -j.
  • Suggested fix: add -j for consistency, or document why lint differs.
Inspection metadata
  • Date: 2026-10-28
  • Run: 40694787288
  • Method: scripted comparison of flags in help-output/--banner-*.txt against the **Options:** lines in cli.md. I also did a typo scan and a short-flag pairing comparison across commands.
  • Commands inspected: about 45 top-level commands plus subcommands.

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

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

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.