UIGraph Local

Use the UIGraph skill

The UIGraph skill lets your coding agent read your code and write UIGraph artifacts for it. Install it once with:

npx skills add uigraph-oss/skills

Generate everything

/uigraph Generate the UIGraph artifacts for this project

The agent proposes diagrams and existing documents, and you pick the ones you want.

Ask for one artifact

You can also ask for one artifact at a time:

/uigraph Create a sequence diagram of the checkout flow
/uigraph Create a system context diagram for this service
/uigraph Create a state diagram for the order status
/uigraph Create the database schema from the migrations

The agent writes .uigraph.yaml and files under .uigraph/, for example:

.uigraph.yaml
.uigraph/diagrams/checkout-flow/checkout-flow.mmd
.uigraph/diagrams/checkout-flow/context.json

See them in the viewer

Run uigraph in the project once. It adds the project to the viewer and opens it. After that, the viewer reads the files on every page load. Refresh the browser to see anything the agent writes later. You don't need to run uigraph again.

Edits you make in the viewer are saved back to the same files, so the agent sees them the next time it runs.

Next guides

On this page