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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#66,893 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
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go
Área
cli, documentation

Línea de trabajo

Empieza con docs/src/content/docs/setup/cli.md y la salida de ayuda de gh aw work-queue mencionada en la issue; compara las entradas cercanas de comandos de utilidad y las convenciones compartidas para los flags. Documenta el comando experimental, sus subcomandos y flags enumerados, y ajusta las definiciones de los flags o explica cualquier diferencia intencionada. La tarea estará terminada cuando la documentación de la CLI cubra work-queue y sus opciones, y los flags sigan las convenciones indicadas o se documente su excepción.

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

Descripción

automation cli cookie documentation
Summary

Inspected ~45 top-level commands (plus subcommands, 510 help files) from /tmp/gh-aw/agent/all-help.txt. Found 2 issues: 0 high, 1 medium, 1 low.

Documentation gaps

1. work-queue is not documented in docs/src/content/docs/setup/cli.md (medium)

  • Affected: gh aw work-queue and subcommands cancel-claim, cancel-work, claim, compact, finish, replay, stats, submit-work.
  • CLI output: work-queue Experimental: inspect and update a Git-backed work queue (listed under "Utilities").
  • Actual: every other top-level command has a gh aw <cmd> entry in cli.md; work-queue has none (neither its flags --branch, --claim-id, --work-id, --attempt-id, --run-id, --file).
  • Suggested fix: add a section (marked experimental) under "Utility Commands" covering the subcommands and flags.
Flag-naming inconsistencies

2. work-queue uses non-standard --repo / --json flags (low)

  • Quoted output: 
    --json            Output JSON
--repo string     GitHub repository owner/repo
  • Elsewhere (164 and 116 occurrences respectively): -j, --json Output results in JSON format and -r, --repo string Target repository ([HOST/]owner/repo format). Defaults to current repository.
  • Expected: short flags -j/-r and the standard description wording (or a documented reason for omitting GHES host support).
  • Suggested fix: align work-queue flag definitions with the shared helpers used by other commands.
Inspection metadata
  • Date: 2026-10-08; method: scripted comparison of all flags in per-command help files against cli.md, plus review of flag/description patterns (--engine, --repo, --json, --output).

Generated by ✅ CLI Consistency Checker · copilot · auto · 20 AIC · ⌖ 0.593 AIC · ⊞ 8.4K · ◷

  • expires on Oct 10, 2026, 5:34 AM UTC-08:00
Lenguaje dominante
Go
Estrellas
5.4k
Forks
576
Merge medio
8 h 29 min
PR fusionados (30 d)
783

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.