Command reference
plotwork board revision create
Make a revision of a tab to work in; main does not change until a person merges it. It is a command of the Plotwork command line, the npm package @buun_group/plotwork.
TL;DR
| Question | Answer |
|---|---|
| What does it do? | Make a revision of a tab to work in; main does not change until a person merges it. |
| How do I run it? | npx -y @buun_group/plotwork@0.2.0 board revision create, or plotwork board revision create 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 revision create --help |
Synopsis
sh
plotwork board revision create <board> <tab> [--name <name>] [--from-version <n>] [--share private|board] [--json]What it does
Makes a revision named --name, else "--from-version, private unless --share board. Pull it and push to it with --revision.
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 |
|---|---|---|
--name <name> | " | The name of the revision. |
--from-version <n> | main's current version | The main version to fork. |
--share private|board | private | board shows it to everyone the board is open to. |
--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
Make a revision to work in.
sh
plotwork board revision create Checkout Payments --name "Cache proposal"Exit codes
| Code | When |
|---|---|
0 | The revision was made. |
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 |