UIGraph Local

Commands

Run uigraph <command> --help for details on any command.

uigraph

Starts the viewer, adds the project's artifacts to it, and opens the browser. If the project has no artifacts, the viewer still runs and shows your other projects.

uigraph
uigraph path/to/project
OptionEffect
--port <number>Viewer port. Default 8447, or UIGRAPH_PORT
--no-openDo not open a browser

uigraph sync

Adds the project's existing artifacts to the viewer and exits. It does not start the viewer or generate anything.

Use it to show a project again after you delete its service in the viewer, or to show a repository that already has artifacts.

uigraph sync
uigraph sync path/to/project

start, status, stop, restart

CommandDoes
uigraph startStart the viewer in this terminal
uigraph statusShow whether the viewer is running and which projects it shows
uigraph stopStop the viewer
uigraph restartStop the viewer, wherever it runs, and start it again in this terminal

Each accepts --port <number>.

uigraph starts the viewer in the background. uigraph start and uigraph restart run it in the current terminal instead, and closing that terminal stops it.

uigraph lens

Reviews a GitHub pull request, or the difference between two branches. See Lens.

OptionEffect
--base <branch>Branch or commit to compare against
--target <branch>Branch or commit to review
--regenerateRun a new review instead of reusing a completed one
--agent <name>Agent to use: claude, codex, opencode, pi, or cursor. Without it, UIGraph asks
--model <name>Model to use, in the agent's own format
--port <number>Viewer port
--no-openDo not open a browser

Other options

OptionEffect
--debugPrint more detail when something goes wrong. You can also set UIGRAPH_DEBUG=1
-v, --versionPrint the version

On this page