Command line¶
Run the CLI from the project root. RUP below stands for
node <skill-dir>/scripts/rup.mjs, where <skill-dir> is the folder that contains
SKILL.md.
Commands and flags marked Pro exist only in the Pro
edition. In the free edition they stop with a message that names Pro and exit with
code 1.
Commands¶
| Command | Edition | Effect |
|---|---|---|
init |
Free | Create rup.config.json and the documentation skeleton. Never overwrites a file. |
new use-case <camelName> |
Free | Scaffold the cards of a use case, then refresh the index. Free: requirements card and specification. Pro: also analysis, design and implementation cards, wireframes, collaboration and sequence. |
index |
Free | Regenerate the use-case index from the cards. Pro: also the use-case diagrams. |
render |
Free | Draw every .puml source into a .svg through the PlantUML server. Pro: themed, plus Mermaid and PNG. |
check |
Free | Verify structure, links and diagrams. Pro: also traceability and realization checks. |
editions |
Free | Print the catalogue and what the installation includes. |
version |
Free | Print the edition and version, --json for machines. |
instructions --target <t> |
Free | Add or refresh the rup-flow block in an agent instruction file. |
server up / server down |
Free | Start or stop the PlantUML container. |
health |
Free | Verify that the PlantUML server renders. |
config |
Free | Print the resolved configuration. |
explore |
Pro | Build explorer.html, the interactive viewer of every diagram. |
themes |
Pro | List the palettes, --json for machines. |
scan |
Pro | Inventory of the code base, the input of code to RUP. |
Without a command the CLI prints its usage.
Common flags¶
| Flag | Meaning |
|---|---|
--root <dir> |
Project root. Defaults to the current directory. |
--out <dir> |
Documentation directory, relative to the root (overrides outDir). |
--lang <code> |
Language of the documents (overrides docLanguage). |
--project <name> |
Project name used in titles. |
--code-root <dir> |
Where the code lives (overrides codeRoot). |
--plantuml-url <url> |
Address of the PlantUML server. |
--force |
Redraw diagrams that are up to date. |
Pro flags Pro¶
| Flag | Meaning |
|---|---|
--theme <preset> |
Palette: default, ocean, forest, sunset, grape, mono, dark or high-contrast. |
--color-<name> "#RRGGBB" |
Override one color: background, text, line, border, primary, secondary, accent or note. |
--font <name>, --font-size <n> |
Font family and size of the diagrams. |
--diagram-language plantuml\|mermaid |
Language of the diagram sources. |
--outputs svg,png,html |
What render produces: SVG, PNG previews, the explorer. |
--preview-png |
Add PNG previews to the outputs. |
init¶
Creates the configuration and the skeleton. Files that exist are skipped. The report lists what was created; in the free edition it also says how many artifacts are available in Pro.
new use-case¶
RUP new use-case createOrder --title "Create order" --actor Customer --package Ordering --goal "Place an order"
| Flag | Meaning |
|---|---|
--title <text> |
Title of the card. Defaults to the name. |
--actor <names> |
Actors, comma separated. Defaults to Actor. |
--package <name> |
Package. Defaults to General. |
--goal <text> |
The goal in one sentence. |
--requirement <id> |
Requirement identifier. Defaults to RF-001. |
--includes <names>, --extends <names> |
Names of related use cases. |
--id <UC-xxx> |
Force the identifier instead of the next free one. |
--discipline <list> Pro |
Which cards to create: requirements,analysis,design,implementation. |
The name must be camelCase made of letters and digits. The command fails otherwise. Pro also adds the row of the use case to the traceability table.
render¶
| Flag | Meaning |
|---|---|
--path <dir> |
Render only this directory. |
--force |
Redraw everything. |
A change of palette redraws everything automatically. The exit code is 1 when any
diagram fails.
check¶
--strict makes warnings fail the command. Without it, only errors do. What it
reports is listed in Render and check diagrams.
explore Pro¶
Writes explorer.html in the documentation directory: one file, no server, no
network. Use --outputs svg,html to build it after every render. The features are
in The interactive explorer.
scan Pro¶
Prints, or with --write saves as 04-implementation/code-inventory.json, the
extensions, manifests and the candidate entities, entry points, services,
persistence, tests and contracts of the code. --limit <n> caps each sample (60 by
default). The agent reads it to start code to RUP.
instructions¶
Without --target it lists the targets. --skill-path <dir> sets where the block
says the skill lives. All targets are in Compatible agents.
version and editions¶
version prints rup-flow free 1.0.1, or for Pro rup-flow Pro 1.0.1 (built on
rup-flow free 1.0.1). With --json it prints the edition and versions as JSON.
editions prints the catalogue as a checklist of what the installation includes.
server¶
Needs Docker with Compose. The port comes from plantuml.url.
Exit codes¶
| Code | Meaning |
|---|---|
0 |
Done. |
1 |
A check failed, a render failed, or the command stopped (invalid input, missing server, a capability that is part of Pro). |