Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

docs: flags and behaviour in Command Reference/FAQ/claude-skill don't match the binary (-y, --since, --yaml, envelope, --set, kg)

Abierto Apto para principiantes
  • ¿Algo no está bien?
#369 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

@BlueLabelscotch ya está trabajando en esto.

Desde el 28/10/2026.

  • #372 de @BlueLabelscotch — abierto
  • #373 de @BlueLabelscotch — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Área
cli, documentation

Línea de trabajo

Las discrepancias están en la Command Reference, la FAQ y docs/claude-skill.md, con docs/mutation.md como referencia de qué sustantivos aceptan --set. Confirma cada afirmación ejecutando la salida de --help para los comandos indicados (delete trigger, list audit_event, get pipeline, get service, update pipeline, list module) y compárala con el texto. Hecho significa que cada uno de los seis elementos coincide con la salida de ayuda del binario, con la regla de gating de kg enunciada de la misma manera en ambas páginas.

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

Descripción

Summary

While testing the CLI as the default tool for coding agents (instead of the Harness MCP), several places in the docs (Command Reference, FAQ, docs/claude-skill.md) describe flags and behaviour that don't match the binary. Each item below was re-checked against current main (3.10.2-dev). All are read-only observations.

Mismatches

1. Delete confirmation: --force, not -y

Docs say delete flows use "interactive confirm; use -y to skip".

harness delete trigger <pipeline>/<trigger> -y     # unknown shorthand flag: 'y' in -y
harness delete trigger <pipeline>/<trigger>        # Request canceled: stdin is not a terminal; re-run with --force to skip this prompt

harness delete trigger --help only lists --force. Same for input_set, template_version, connector, pipeline. Fix: replace -y with --force.

2. list audit_event --since does not exist

FAQ example harness list audit_event --since 24h fails with unknown flag: --since. Actual filters: --action, --module, --resource_type. Fix: change the example (a time-window filter would be a separate feature request).

3. get --yaml is not available on every noun

Cheat sheet describes yaml on get as the envelope-stripped body for update -f / create -f. harness get pipeline --help offers --format: text, json (no --yaml); harness get service --help offers text, json, yaml and --yaml. Fix: document the supported formats per noun, or add --yaml consistently.

4. Default --format json is not "envelope included"

docs/claude-skill.md ("Output formats") says json includes the full envelope. In practice the envelope is only present with --raw (--raw is "only with --format json"). Default get pipeline --format json returns just the pipeline and url keys. Fix: say the envelope requires --raw.

5, 6. Moved
  • --set not on every create/update: #370
  • kg module visibility: #371

Out of scope

Behaviour/ergonomics gaps from the same review (get noun field names vs JSON keys, no paging indicator in JSON output, inconsistent JSON key casing, matrix JSON types, structured JSON errors, scope error messages, epoch timestamps) will be filed separately.

Lenguaje dominante
Go
Estrellas
28
Forks
16
Merge medio
2 d 19 h
PR fusionados (30 d)
60

Preparar el entorno

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 harness/cli

Todos los issues de harness/cli

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.