claude-code-kanban 5.4.0 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,73 +1,35 @@
1
1
  # Dispatch guide
2
2
 
3
- A dispatch is one Claude Code session that cck starts for a task, in its embedded terminal. It is an ordinary session, not a child: it shows in the sidebar like any other, and the user can open its terminal at any time.
3
+ A dispatch is a plain Claude Code session that cck starts in its embedded terminal, with your spec as the first message. It is an ordinary session: it shows in the sidebar, its card links back to you, and the user can open its terminal at any time. cck only starts it.
4
4
 
5
- A dispatch **reports back** by default: start it with `--report` and `--peer`, then collect and verify the outcome (With `--report`, below). When the user's request says `--no-report`, it is **fire-and-forget**: start it with neither flag (Fire-and-forget, below). `--no-report` lives only in the user's request; `dispatch start` has no such flag.
5
+ ## Spec
6
6
 
7
- ## Write the spec
7
+ The started session sees only the spec, not this conversation, so the spec carries everything it needs.
8
8
 
9
- The started session sees only the spec, not this conversation, so every spec is self-contained. Name:
10
-
11
- - **Target:** the files, component, or environment in scope.
12
- - **Change:** the concrete result to produce.
13
- - **Constraints:** invariants and do-not-touch boundaries.
14
- - **Ownership:** what it may edit. Two dispatches edit the same files only when each runs in its own `--worktree`.
15
- - **Acceptance:** the test, output, or evidence that proves it is done.
16
-
17
- Dispatch when the task can run on its own. Do the work yourself when it is small or needs context from this conversation that you cannot write down.
9
+ cck sends nothing back. To hear from the session, the spec tells it to `SendMessage` you and names you. Your name is auto-assigned (e.g. `claude-code-hub-06`); `ListAgents` prints it as "This session is <name>".
18
10
 
19
11
  ## Start
20
12
 
21
13
  ```bash
22
- claude-code-kanban dispatch start --cwd <dir> --spec-file <spec.md> --name <name> --group <group> --peer <your-peer> --report --json
14
+ claude-code-kanban dispatch start --cwd <dir> --spec-file <spec.md> --name <name> --group <group> --json -- <claude args>
23
15
  ```
24
16
 
25
- `claude-code-kanban help dispatch start` lists every flag (model, worktree, and the rest). `project list` shows the folders `--cwd` accepts. How to choose the values:
26
-
27
- - `--peer` is your own peer name: the first line of `ListAgents` ("This session is `<name>`"). Pass it when you have the `ListAgents` tool. cck then tells the started session to ask you with `SendMessage` instead of failing on a question. See [Peer](#peer).
28
- - `--spec-file` over `--spec` for anything longer than a line: no shell quoting.
29
- - `--name` is what the user sees in the sidebar. Kebab-case, saying what the session does: `fix-login-redirect`, not `task-1`.
30
- - `--group` names the effort, in kebab-case (`auth-refactor`), and shows the new session under that sidebar group. This session stays where it is. Pass it on your first dispatch; later dispatches join the same group without it. A group goes away when its sessions end, unless the user pins a member or keeps the group.
31
- - The result holds the `dispatch` id and the `session` id.
32
-
33
- ## Fire-and-forget
17
+ - `--name` is the sidebar name and the session's peer name. Kebab-case and unique: `fix-login-redirect`.
18
+ - `--group` names the effort in kebab-case (`auth-refactor`) and shows the session under that sidebar group. Pass it on every dispatch that belongs to the effort; a dispatch without it goes to its project.
19
+ - `--spec-file` keeps a long spec out of shell quoting.
20
+ - Everything after `--` goes to `claude` as it is: any flag in `claude --help`, e.g. `-- --permission-mode auto --add-dir ../shared`. Keep each value one shell word of plain characters (no quotes, `%` or control characters); long text belongs in the spec. cck owns the session id, name, model and worktree, so pass those with its own flags.
21
+ - After a cck restart the terminal comes back with `claude --resume <id>` alone, so the args after `--` apply to the first run only.
22
+ - The result holds the `session` id.
34
23
 
35
- The started session gets the task alone and does not know your session exists. Tell the user the session name, its group, and the dispatch id. Your part ends with that message: the user follows the dispatch in the sidebar, and asks you when they want it checked.
24
+ `claude-code-kanban help dispatch start` lists cck's flags (`--model`, `--worktree` and more); `claude --help` lists the ones you can pass after `--`.
36
25
 
37
- ## With `--report`
26
+ ## Messages and status
38
27
 
39
- The started session settles with one report, `succeeded` or `failed`, or as `exited` when its terminal ends first. Start every independent dispatch first, then collect. Two channels, use either or both:
40
-
41
- - **Inbox:** this skill armed it. Lines `[kanban board] Dispatch <id> (session <uuid>) ...` arrive on their own while you keep working.
42
- - **Wait:** block until one settles.
43
-
44
- ```bash
45
- claude-code-kanban dispatch wait [<id>...] --timeout 15m --json
46
- ```
28
+ A message from the session arrives here as a new turn. Reply with `SendMessage` to its name.
47
29
 
48
- Call it again with the ids still running (`help dispatch wait` has the output fields). A timeout is a checkpoint: the session may still be working. Look before you act:
30
+ A crashed session sends nothing. To learn when one ends, `SendMessage` it with `notify_when_idle: true`, or look:
49
31
 
50
32
  ```bash
51
- claude-code-kanban dispatch list --json
33
+ claude-code-kanban dispatch list --json # still running in cck's terminal
52
34
  claude-code-kanban session peek <session-id> --limit 20
53
35
  ```
54
-
55
- A dispatch still `running` is still working; retry only after a `failed` report or an `exited` one.
56
-
57
- The summary is the started session's own claim. Verify it (run the tests, read the diff), then give the user each dispatch's outcome, the summary, and what you checked. Done when every `--report` dispatch has settled and each summary is verified.
58
-
59
- ## Peer
60
-
61
- A dispatch is a Claude Code peer under its `--name`, so `SendMessage` reaches it and it reaches you. The peer channel carries the conversation. The report carries the record: only `dispatch done` settles a dispatch, ends `dispatch wait`, and shows in the sidebar.
62
-
63
- - **Answer questions.** A question or a finding from the dispatch arrives as a new turn. Answer it yourself, or ask the user when the decision is theirs, then send the answer back.
64
- - **Steer.** Send a short, self-contained message to the dispatch's name. It arrives between the receiver's steps, never inside a subagent or a running workflow.
65
- - **Limits.** A session in another permission mode can hold a message until its user approves it, so anything the result depends on goes in the report. A dispatch that restarts ends as `exited` and cannot report, so its result comes back as a message.
66
-
67
- ## If you are the started session
68
-
69
- Your prompt begins with `[cck dispatch <id>]` and holds your instructions: the peer to ask, and with a report the exact `dispatch done` command. Follow them. Without that line, the prompt is the task alone.
70
-
71
- - Ask the peer with `SendMessage` when you need a decision or find something that changes the task, and keep working on what does not depend on the answer.
72
- - The summary is three sentences: what changed, what you found, what remains. Use `--summary-file` if it needs quotes.
73
- - After you report, a message from the peer is a new request: answer it.