Skip to content
Connect an agent
Command reference

Command reference

Every command of the Plotwork command line, plotwork, with a page for each. The pages say the same as plotwork <command> --help, which prints the options, defaults, examples, and exit codes of one command in a terminal.

TL;DR

QuestionAnswer
How do I run a command?npx -y @buun_group/plotwork@0.1.0-beta.13 <command>, with no install, or plotwork <command> once the package is installed. See Overview.
Which command keeps pictures in step?plotwork sync, and plotwork sync --check in CI.
Which commands read the repository settings?sync, validate, check, render, outline, generate, publish. See Configuration.
What do the exit codes mean?0 all is well, 1 a problem in a diagram, 2 a mistake in the command line.
Where is the help in a terminal?plotwork --help lists every command; plotwork <command> --help prints one.

Commands

CommandWhat it does
plotwork syncDraw the pictures under every diagram fence of Markdown files; --check fails when one is stale
plotwork validateCheck every diagram of a Markdown or .diagram file; --strict also fails on warnings
plotwork checkCheck every diagram against a team's style rules; fails on a broken rule at level error
plotwork renderDraw the first diagram of a file, or a view link, to an SVG that carries its source
plotwork readPrint the source a Plotwork SVG, a view link, or a hosted link carries, to edit it
plotwork outlinePrint a plain-text outline of every diagram, to check what it says
plotwork generateMake the diagrams the settings' sources name from their files; --check fails on drift
plotwork import-sourceTurn SQL, OpenAPI, Terraform, Compose, CSV, a git log, and more into Plotwork source
plotwork importConvert Mermaid to Plotwork: a .mmd file, or every mermaid fence of a Markdown file
plotwork exportPrint paste-ready text of the first diagram for Confluence or Notion
plotwork publishSave every diagram of a .diagram or Markdown file to Plotwork, where your organisations' Publishing settings decide, and print the link
plotwork iconsSearch the bundled icons by name

See also

DocWhy
Quick startThe first diagram, from install to a checked pull request
Exit codes and output formatsWhat every code and format means
Tool referenceThe same operations for an AI agent, over MCP