UIGraph Local

Quick start

Requires: Node.js 20 or later

Output: Your project's artifacts open in the UIGraph viewer at http://127.0.0.1:8447/.

Step 1: Install UIGraph

npm install -g uigraph

Or run it without installing:

npx uigraph

Step 2: Install the UIGraph skill

Install the skill in your coding agent once:

npx skills add uigraph-oss/skills

Step 3: Generate the artifacts

In your project, start your agent and ask it to generate the artifacts:

/uigraph Generate the UIGraph artifacts for this project
  1. The agent explores the project.
  2. It proposes diagrams and existing documents, and you pick the ones you want.
  3. It writes the artifacts and adds them to the viewer.

The first time, it also adds instructions for coding agents. See What UIGraph changes in your project.

Step 4: Open the viewer

cd your-project
uigraph

UIGraph starts the viewer at http://127.0.0.1:8447/ and opens your browser. The viewer keeps running in the background after the command finishes. Run uigraph stop to stop it.

Working on more than one project

Run uigraph in each project. If the viewer is already running, UIGraph adds the project to it instead of starting a second viewer.

Next guides

On this page