Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta Adatta ai principianti
  • Qualcosa non va?
#369 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

@BlueLabelscotch ci sta già lavorando.

Dal 28/10/2026.

  • #372 di @BlueLabelscotch — aperta
  • #373 di @BlueLabelscotch — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
cli, documentation

Direzione di ricerca

Le discrepanze sono nella Command Reference, nelle FAQ e in docs/claude-skill.md, con docs/mutation.md come riferimento per quali sostantivi accettano --set. Conferma ogni affermazione eseguendo l'output di --help per i comandi indicati (delete trigger, list audit_event, get pipeline, get service, update pipeline, list module) e confrontalo con il testo. Fatto significa che ciascuno dei sei elementi corrisponde all'output di aiuto del binario, con la regola di gating di kg enunciata allo stesso modo su entrambe le pagine.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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. --set is not on every create/update

docs/claude-skill.md says create takes -f or --set key=value, and update takes --set/--del or -f. harness update pipeline --help lists only -f/--file. Fix: scope the --set/--del statement to nouns that support it (see docs/mutation.md), or add --set to update pipeline.

6. kg module visibility: FAQ and Command Reference disagree

FAQ lists kg among modules hidden unless the profile is on a harness.io account; Command Reference says kg ships for all users. harness list module currently shows kg as builtin. Fix: align both pages with the real gating rule.

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.

Lingua principale
Go
Stelle
28
Fork
16
Merge medio
2g 11h
PR unite (30g)
67

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di harness/cli

Tutte le issue di harness/cli

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.