review-state update should support --help flag #202

New issue

Closed

opened 2026-02-17 09:30:34 +00:00 by mprihoda · 2 comments

mprihoda commented

2026-02-17 09:30:34 +00:00

(Migrated from github.com)

Running './iw review-state update --help' currently executes a default update instead of showing usage information. It should display available options (--status, --display-text, --display-subtext, --display-type, --message, --needs-attention, --pr-url, --append-badge, --append-artifact, --append-action, --checkpoint, --input) and exit without modifying any state.

mph referenced this issue

2026-08-27 08:05:50 +00:00

Help must be able to guide an agent: an overview index, and a --help on every command that prints instead of executing #463

mph commented

2026-08-27 08:05:54 +00:00

Owner

Superseded by #463, which requires a --help on every subcommand, dispatched before the action so it can never perform an update. Closing in favour of #463.

mph closed this issue

2026-08-27 08:05:57 +00:00

mph referenced this issue from a commit

2026-09-01 16:28:59 +00:00

Phase 3 Step 8: annotate, sweep, wrap up

mph commented

2026-09-05 14:56:13 +00:00

Owner

Delivered in IW-463 Phase 6.

iw review-state update --help now prints the update subcommand's own rendered help at a real terminal and exits 0, modifying nothing:

Usage: iw review-state update [--issue-id ID] [--status STATUS] [--clear-status] ...

Every flag this issue listed is named, with what it does and how its absence resolves, together with the exit codes and an example. The help is rendered from ReviewState's declaration, which the parser reads too, so the two cannot say different things.

How it is reached: the launcher's pre-filter fires on an exact --help or -h token, resolves the command, and hands the caller's own argv to iw.core.commands.Help. That walks CommandArgParser.dispatch down through the subcommands, so update is reached by exactly the tokens that reach it when the command runs — no second resolution rule. Dispatch happens before any action, so the update can never be performed on a help request.

Covered at two tiers: core/test/HelpTest.scala asserts the declaration reached is review-state update (not a string the parent's help also renders), and test/help-intercept.bats case 4c asserts the same invocation end to end through iw-run.

This issue was already closed on 2026-08-27 as superseded by #463; it stays closed. This comment records that the behaviour it asked for now exists.

Delivered in IW-463 Phase 6. `iw review-state update --help` now prints the `update` subcommand's own rendered help at a real terminal and exits 0, modifying nothing: Usage: iw review-state update [--issue-id ID] [--status STATUS] [--clear-status] ... Every flag this issue listed is named, with what it does and how its absence resolves, together with the exit codes and an example. The help is rendered from `ReviewState`'s declaration, which the parser reads too, so the two cannot say different things. How it is reached: the launcher's pre-filter fires on an exact `--help` or `-h` token, resolves the command, and hands the caller's own argv to `iw.core.commands.Help`. That walks `CommandArgParser.dispatch` down through the subcommands, so `update` is reached by exactly the tokens that reach it when the command runs — no second resolution rule. Dispatch happens before any action, so the update can never be performed on a help request. Covered at two tiers: `core/test/HelpTest.scala` asserts the declaration reached is `review-state update` (not a string the parent's help also renders), and `test/help-intercept.bats` case 4c asserts the same invocation end to end through `iw-run`. This issue was already closed on 2026-08-27 as superseded by #463; it stays closed. This comment records that the behaviour it asked for now exists.

mph referenced this issue from a commit

2026-09-05 17:54:57 +00:00

feat(IW-463): the Help entry point, with the subcommand walk that closes #202's content

mph referenced this issue from a commit

2026-09-05 17:54:57 +00:00

docs(IW-463): Phase 6 Steps 6-7 — iw-bootstrap, the docs, the log and #202

mph referenced this issue from a pull request that will close it,

2026-09-08 21:29:35 +00:00

IW-463: Help must be able to guide an agent #541