Command reference
plotwork board open
Show a board: its tabs and their versions, who is on it now, and each tab's revisions. It is a command of the Plotwork command line, the npm package @buun_group/plotwork.
TL;DR
| Question | Answer |
|---|---|
| What does it do? | Show a board: its tabs and their versions, who is on it now, and each tab's revisions. |
| How do I run it? | npx -y @buun_group/plotwork@0.2.0 board open, or plotwork board open 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 open --help |
Synopsis
sh
plotwork board open <board> [--json]What it does
Reads the board and the revisions of each of its tabs. Everyone on the board sees the key reading it.
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 |
|---|---|---|
--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
Show a board by its id, 22 letters and digits.
sh
plotwork board open 6vQm2K8pXr4TbN1sLw9eZaShow a board by its name, as JSON.
sh
plotwork board open Checkout --jsonExit codes
| Code | When |
|---|---|
0 | The board was shown. |
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. |
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 |