cli: make bundled help self-describing
This commit is contained in:
@@ -113,6 +113,15 @@ Rules:
|
||||
|
||||
The binary name is `inbox`.
|
||||
|
||||
Built-in help should be sufficient for first use:
|
||||
|
||||
- root help should explain the worker role and the normal fetch -> claim -> update -> wait-reply -> done/fail loop
|
||||
- command help should explain when to use the command, not just list flags
|
||||
- high-frequency commands should include concrete examples that can be copied directly
|
||||
- `list` help should explain how it differs from `fetch`
|
||||
- `show` help should explain that it is the thread-history inspection command
|
||||
- `watch` help should explain how it differs from `wait-reply`
|
||||
|
||||
### Global Flags
|
||||
|
||||
- `--db PATH`
|
||||
|
||||
@@ -110,6 +110,16 @@ The leader should block on `orch wait`, not on ad hoc `sleep`.
|
||||
|
||||
The binary name is `orch`.
|
||||
|
||||
Built-in help should be sufficient for first use:
|
||||
|
||||
- root help should explain the leader role and the normal run -> task -> dep -> ready -> dispatch -> wait/status loop
|
||||
- command help should explain the scheduling contract, not just list flags
|
||||
- `dispatch` help should explicitly explain `--execution-mode analysis|code` and which flags only apply to code mode
|
||||
- high-frequency commands should include concrete examples that can be copied directly
|
||||
- `status` help should explain that it is the main operational dashboard command
|
||||
- `blocked` help should explain that it is the compact queue to inspect before `answer`
|
||||
- `cleanup` help should explain how `--task`, `--attempt`, and `--all-completed` change cleanup scope
|
||||
|
||||
### Global Flags
|
||||
|
||||
- `--db PATH`
|
||||
|
||||
Reference in New Issue
Block a user