Command reference
plotwork board save
Save a tab to the organisation's library, as a new diagram or a new version of the one it came from. It is a command of the Plotwork command line, the npm package @buun_group/plotwork.
TL;DR
| Question | Answer |
|---|---|
| What does it do? | Save a tab to the organisation's library, as a new diagram or a new version of the one it came from. |
| How do I run it? | npx -y @buun_group/plotwork@0.2.0 board save, or plotwork board save 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 save --help |
Synopsis
sh
plotwork board save <board> <tab> --to new|linked [--name <name>] [--folder <path>] [--library-version <n>] [--json]What it does
Every library rule applies: folder rules, the board's label, secret scanning, the size, and approval, which holds the save for a person to approve.
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 |
|---|---|---|
--to new|linked | Required | new makes a library diagram; linked saves a new version of the one the tab is linked to. |
--name <name> | the tab's name | The name in the library, for --to new. |
--folder <path> | the top level | The folder, for --to new. |
--library-version <n> | the tab's own link | For --to linked: the library diagram's version the tab last saw. |
--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
Save the tab to the library as a new diagram.
sh
plotwork board save Checkout Payments --to new --folder PlatformExit codes
| Code | When |
|---|---|
0 | Saved, held for approval, or unchanged. |
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 --to 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 |