Skip to content

Commit b8b7b87

Browse files
committed
docs: update
1 parent db4a364 commit b8b7b87

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

docs/listing.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
`vp run --list` shows all available tasks across the workspace and exits without running anything. Combined with `--json`, it produces machine-readable output for CI pipelines, shell completion, and tooling integration.
44

5-
## `--list`
5+
`vp run --help` displays a hint about the `--list` flag so that users (and AI agents) can discover it.
6+
7+
## `--list` / `-l`
68

79
```sh
810
vp run --list
11+
vp run -l # short alias
912
```
1013

1114
Prints a flat list of all tasks with their commands:
@@ -168,3 +171,18 @@ vp run --list --filter "./infra/*"
168171
| `--last-details` | **Error** — mutually exclusive |
169172

170173
`--json` without `--list` is an error.
174+
175+
## Discoverability
176+
177+
`vp run --help` includes a hint about the `--list` flag so that users and AI agents can discover it without prior knowledge:
178+
179+
```
180+
Options:
181+
-l, --list List all available tasks and exit without running
182+
--json Output task list as JSON (requires --list)
183+
...
184+
185+
Tip: use `--list` to see all available tasks.
186+
```
187+
188+
This hint is rendered via clap's `after_help` attribute on the `run` subcommand.

0 commit comments

Comments
 (0)