Skip to content
Connect an agent

Command reference

plotwork board revision list

List a tab's revisions the key may see, with how far each is behind main. It is a command of the Plotwork command line, the npm package @buun_group/plotwork.

TL;DR

QuestionAnswer
What does it do?List a tab's revisions the key may see, with how far each is behind main.
How do I run it?npx -y @buun_group/plotwork@0.2.0 board revision list, or plotwork board revision list 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 list --help

Synopsis

sh
plotwork board revision list <board> <tab> [--json]

What it does

Lists the tab's revisions the key may see: its own, and those shared with the board.

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

OptionDefaultWhat it does
--jsonOffPrint one JSON document: the API's answer when it worked, or { "error": true, "errorCode", "message", "hint", "status" } when it did not.

Examples

List the tab's revisions.

sh
plotwork board revision list Checkout Payments

Exit codes

CodeWhen
0The revisions were listed.
1The API refused the call (its code, words and a hint are printed), or could not be reached.
2A 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

DocWhy
Command referenceEvery command of the command line
Live whiteboardsBoards, tabs, revisions and who may change them
From the command lineSigning in, pull and push, conflicts, and watch
Claude Code pluginThe board and board-sync skills
Exit codes and output formatsWhat every code and format means