Command reference
plotwork board reply
Answer a message of the agent's own thread on a board. It is a command of the Plotwork command line, the npm package @buun_group/plotwork.
TL;DR
| Question | Answer |
|---|---|
| What does it do? | Answer a message of the agent's own thread on a board. |
| How do I run it? | npx -y @buun_group/plotwork@0.2.0 board reply, or plotwork board reply once the package is installed. |
| What does it write? | Nothing on this machine. |
| Does it use the network? | Yes: calls to the Plotwork API with the key in PLOTWORK_API_KEY, which is never printed. |
| Does it read the repository settings? | No. |
| How do I read this in a terminal? | plotwork board reply --help |
Synopsis
sh
plotwork board reply <board> <message> --text <text> [--tab <tab>] [--revision <id>] [--json]What it does
Sends the answer to one message, shown at once on the member's screen; the message is marked answered. It is scanned for secrets like every write.
A board is named by its id, its address in the portal (an address with #tab-<id> also names the tab), or its name; a tab by its id or its name. A name costs one more call to look it up.
Options
| Option | Default | What it does |
|---|---|---|
--text <text> | Required | What to say, up to 2,000 characters. |
--tab <tab> | Off | The tab the answer is about. |
--revision <id> | main | A revision of the tab to work on instead of main. |
--json | Off | Print one JSON document: the API's answer when it worked, or { "error": true, "errorCode", "message", "hint", "status" } when it did not. |
Examples
Answer a message.
sh
plotwork board reply Checkout Mq3vT8nB2kLx --text "Added the cache to the Payments tab."Exit codes
| Code | When |
|---|---|
0 | The reply was sent. |
1 | The API refused the call (its code, words and a hint are printed), or could not be reached. |
2 | A mistake in the command line: an unknown option, a missing operand, a file or glob that matches nothing, or a settings file that cannot be read. Also when PLOTWORK_API_KEY is missing or refused, or --text is missing. |
See also
| Doc | Why |
|---|---|
| Command reference | Every command of the command line |
| Live whiteboards | Boards, tabs, revisions and who may change them |
| From the command line | Signing in, pull and push, conflicts, and watch |
| Claude Code plugin | The board and board-sync skills |
| Exit codes and output formats | What every code and format means |