Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
  • 何か問題がありますか？
#369 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

@BlueLabelscotch がすでに取り組んでいます。

2026年10月28日 から。

  • #372 @BlueLabelscotch による — オープン
  • #373 @BlueLabelscotch による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
領域
cli, documentation

調査の方向性

不一致は Command Reference、FAQ、docs/claude-skill.md にあり、どの名詞が --set を受け付けるかについては docs/mutation.md を参照してください。各主張は、--help 出力を指定されたコマンド（delete trigger、list audit_event、get pipeline、get service、update pipeline、list module）で実行し、テキストと比較することで確認してください。完了とは、6 項目のそれぞれがバイナリのヘルプ出力と一致し、kg のゲーティングルールが両方のページで同じように記載されていることです。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Go
スター
28
フォーク
16
平均マージ
2日 11時間
マージ済み PR（30日）
67

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

harness/cli のほかの issue

harness/cli の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。