releases/ClaudeMailbox
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 17 Wiki Activity

docs: document watch --block push delivery and bootstrap behavior

Browse Source 
Adds a Push delivery (watch) section to the root README with exit-code
table, cross-process semantics, and the active-vs-idle latency caveat
that came out of the empirical Claude Code BashOutput test. Adds a brief
reference + cross-link in node/README.md, and notes the SessionStart
bootstrap behavior in plugin/README.md alongside the existing hook
table. Adds /v1/watch to the REST surface table and the watch verb to
the CLI listing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Mika Kuns
2026-05-20 16:42:52 +02:00
parent 307e15b05b
commit 8c8be67a98
3 changed files with 43 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
node/README.md
View File

@@ -39,6 +39,16 @@ Under the hood the hook runs `claude-mailbox check --name <mailbox> --hook`, whi
Cost: one local HTTP round-trip plus Node coldstart per prompt (~100ms on Windows).
## Push delivery (watch)
For long-running autonomous sessions, run the watcher as a background bash task so peer messages surface immediately via `BashOutput`:
```sh
claude-mailbox watch --block --name <mailbox>
```
Exit codes: `0` delivered or renamed, `1` error, `2` daemon unreachable, `3` timeout. See the [repository README](https://git.kuns.dev/releases/ClaudeMailbox/src/branch/main/README.md#push-delivery-watch) for the full contract.
## Troubleshooting
`npm install` returns `401 Unauthorized`