UIGraph CLI
A CLI and skill that map services from code: diagrams, APIs and DB schemas live as repo files with a local viewer.
- 83 ★ on the repository
- Last commit
- Apache-2.0
Extended access
Why this level
- The skill writes files into the project repo, and the CLI keeps a local viewer on `127.0.0.1`.
- For pull requests Lens reads a GitHub token from the environment or from `gh`.
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add cli/uigraphDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The skill writes files into the project repo, and the CLI keeps a local viewer on `127.0.0.1`.
- For pull requests Lens reads a GitHub token from the environment or from `gh`.
This is third-party code. Review the repository files before installing.
What it does
UIGraph keeps an engineering map of a project in plain repo files: `.uigraph.yaml`, Mermaid, OpenAPI and SQL. Your agent (Claude Code, Codex, OpenCode, Pi or Cursor) writes them through the `uigraph` skill, and the `uigraph` CLI opens them in a local viewer on `127.0.0.1`. The skill produces diagrams (system context, request flows, state machines, background jobs, C4), API specs, database schemas, saved queries, dependencies and docs. The agent writes only what it finds in your code, and you choose which artifacts to create. Diagram edits in the viewer are saved back to the files. The `uigraph lens` command reviews a pull request or the difference between two branches: which flows are touched, how the change matches its description, which new behavior has a test.
Who it is for. Teams without an up-to-date map of their services and reviewers who need to grasp someone else's pull request fast.
Good fit when
- A project has no architecture diagram and the agent has to draw one from code.
- Migrations sit in the repo, but the database schema is documented nowhere.
- A reviewer opens a pull request of hundreds of lines and wants to see the touched flows before reading the diff.
- After a code change an agent is asked to update diagrams and specs.
Not a fit when
- You need a company-wide cloud catalog with roles and SSO: the local viewer serves a single machine.
- Project code is closed to external model providers: Lens will hand the reviewed changes to the chosen agent.
- The project is small and the picture fits in one README.
Example request
/uigraph Create a system context diagram and a checkout flow sequence diagram for this service, then open the viewer.Limitations
Node.js 20 or newer is required. The skill installs separately (`npx skills add uigraph-oss/skills`), and without it the CLI only shows files that already exist. Lens needs a login for the chosen agent (Claude Code, Codex, OpenCode, Pi or Cursor), and pull requests also need a GitHub token (`GITHUB_TOKEN`, `GH_TOKEN` or `gh auth token`); the reviewed code goes to the model provider. Shared catalogs, roles, SSO and AI features belong to UIGraph Cloud or self-hosting.
How to disable. Stop the viewer with `uigraph stop` and remove the package (`npm uninstall -g uigraph`). Delete `.uigraph.yaml` and `.uigraph/` in your projects and `~/.uigraph/` on the machine by hand.
FAQ
How do I start UIGraph?
Install the CLI with `npm install -g uigraph@latest` or run it without installing through `npx uigraph@latest`. `uigraph` in a project folder opens the viewer at `http://127.0.0.1:8447/`.
Which agents are supported?
Claude Code, Codex, OpenCode, Pi and Cursor. For Lens pick the agent with `--agent`, otherwise UIGraph asks.
What gets written into the project?
The skill writes `.uigraph.yaml` and files under `.uigraph/`. If no artifacts exist yet, it also adds `.uigraph/AGENTS.md` and a short section in `CLAUDE.md` and `AGENTS.md`.
How do I review a pull request?
Run `uigraph lens owner/repo#123`, or `uigraph lens --base main --target feature/login` for two branches. Each run is saved in `~/.uigraph/lens/runs`.
Is the viewer reachable from the network?
No, it listens on `127.0.0.1` only. Shared access, roles and SSO belong to UIGraph Cloud or self-hosting.
Discussion
No questions or reviews yet.
Related
CLI toolsThe /graphify skill builds a knowledge graph of a project's code, docs and PDFs so the agent queries the graph instead of grepping
Code graph and project memory in one Rust program: the agent gets excerpts with file and line citations
An MCP server builds a graph of code entities, relations and flows so the agent finds the right files without reading everything
CodeGraph (Rust)
codegraph-rust
A Rust code graph for agents: four MCP tools show what an edit will touch, how the architecture fits together and where the fragile spots are
A skill and CLI that draw architecture diagrams from Prisma, OpenAPI, GraphQL and code, and check the docs in CI for drift from the code
DreamGraph builds a project knowledge graph and serves it to agents through MCP, the dg CLI and VS Code, with ADRs.
Comparison with similar tools
Cards that share the main search query, and how they differ.
| Tool | Official | Repository stars | Main difference |
|---|---|---|---|
| UIGraph (this card) | no | 83 | |
| Architecture Diagram Generator | no | 7,583 | a skill that draws a single diagram as HTML; UIGraph keeps a set of artifacts as repo files and shows them in a local viewer |
| Diagram Design | no | 66,822 | a skill that draws editorial diagrams as standalone files; UIGraph adds API specs, database schemas and pull request review |
README in short
The description runs from install and quick start through the skill, diagrams, CLI commands and Lens. It separately lists what UIGraph changes in a project and on the machine.