Get started

rup-flow is a skill: a folder of instructions and a small command line that your AI coding agent loads on demand. You talk to the agent; the agent follows the skill and runs the CLI.

What you need: Node.js 18 or newer, a shell and an AI coding agent. Docker is optional and only draws the diagrams.

Journey

01 · Install

Install rup-flow

Unzip the skill into the skills folder of your agent, or let the installer do it.

Choose your agent

02 · Document

Document your first system

One prompt, a folder of documents and diagrams, and a check.

Run the first prompt

03 · Understand

See how it works

The skill, the CLI, the PlantUML server and what each one is responsible for.

Read how it works

04 · Fit

Check your agent

Which agents read the skill directly and which read an instruction file.

See compatible agents

What the free edition produces

Discipline	Folder	You get
Domain model	00-domain-model	Simplified diagram, entity dictionary, business rules
Requirements	01-requirements	Actors, requirements catalogue, use-case cards with a specification statechart
Analysis	02-analysis	Analysis classes (boundary, control, entity)
Quality	05-quality	Open questions

In Pro

Design, implementation, traceability, audits and code in both directions complete the other folders. See the complete documentation set.