Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#369 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

@BlueLabelscotch is already working on this.

Since Oct 28, 2026.

  • #372 by @BlueLabelscotch — open
  • #373 by @BlueLabelscotch — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
cli, documentation

Research direction

The mismatches live in the Command Reference, the FAQ and docs/claude-skill.md, with docs/mutation.md as the reference for which nouns accept --set. Confirm each claim by running the --help output for the named commands (delete trigger, list audit_event, get pipeline, get service, update pipeline, list module) and compare it with the text. Done means each of the six items matches the binary's help output, with the kg gating rule stated the same way on both pages.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Go
Stars
28
Forks
16
Avg merge
2d 14h
Merged PRs (30d)
65

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from harness/cli

All issues in harness/cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.