[cli-consistency] CLI Consistency Issues - 2026-11-05

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

Línea de trabajo

Lee la ayuda de la opción lint y las entradas **Options:** de lint y logs en docs/src/content/docs/setup/cli.md. Encuentra las definiciones de las opciones de los comandos y su fuente de documentación; después, actualiza la forma abreviada de lint e incluye las tres opciones que faltan para logs. La tarea estará completa cuando la ayuda y la documentación muestren estas opciones de forma coherente.

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 for about 45 top-level commands, plus subcommand and flag help files, against docs/src/content/docs/setup/cli.md.

Severity: high 0, medium 0, low 2. No typos were found by keyword scan. Every top-level command is documented. All --dir defaults use .github/workflows consistently.

Findings
1. gh aw lint --json has no -j short flag (low)

  • Every other command with --json pairs it with -j: audit, checks, compile, doctor, domains, forecast, health, list, logs, models, run, status, trial, upgrade and validate.

  • lint help shows the flag with no short form:

      --json                                  Emit structured diagnostics (requires --rules)

  • Expected: -j, --json, or an explicit note that the omission is intentional.

  • The docs **Options:** line for lint also lists plain --json.

  • Suggested fix: add the -j shorthand to lint and update the docs.

2. Docs logs Options line omits --episodes, --outcomes and --outcomes-dir (low)

  • Help for gh aw logs includes these flags. The quoted lines below are from help-output/logs.txt:

    Use --outcomes to evaluate the current GitHub state of each selected run's safe
...
    --episodes                        Include recorded episode membership and hops; combine with --outcomes for episode outcome summaries

  • The main **Options:** list for logs in cli.md (about line 754) does not mention them.

  • They are only documented in the separate logs --outcomes section (about line 1047), and that section's options line omits --outcomes itself.

  • Suggested fix: add the three flags to the main logs Options list.

Inspection metadata

  • Date: 2026-11-05

  • Run: 42033865672

  • Method:

    • Read /tmp/gh-aw/agent/all-help.txt and help-output/*.txt.
    • Cross-checked the **Options:** lines in cli.md against help flags, using a script.
    • Compared short and long flag pairings across commands.
    • Scanned for typos.

  • Not reported: --pr is a documented compatibility alias for --create-pull-request. It appears in cli.md but not as a flag line in help, and it is mentioned in the help text of add, deploy and others.

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

  • expires on Nov 7, 2026, 5:31 AM UTC-08:00
Lenguaje dominante
Go
Estrellas
5.6k
Forks
615
Merge medio
5 h 36 min
PR fusionados (30 d)
805

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.