One config file. Thirteen kinds of artifact. Every push.
Keep the system definition beside the code. The CLI reconciles that definition against the graph from the same commit.
$ uigraph-cli sync
Syncing payments-service...
✓ apis openapi · 12 operations synced
✓ databases postgres · 18 tables synced
✓ testPacks regression · 6 cases synced
✓ docs 4 files synced
Sync Summary
Service payments-service
Commit a13f92e
Artifact types 4 synced
Duration 1.8s
✓ Sync complete · 4 artifact types synced · 1.8s
The wiki drifts because the code moves without it.
The answer is not another documentation ritual. It is one repository truth.
01 file
The whole system, declared once.
Review .uigraph.yaml like any other change to the repository.
version: 1
organization: acme
services:
- name: payments-service
owner: payments-team
apiSpecs:
- ./openapi.yaml
databases:
- ./db/schema.sql
testPacks:
- ./tests/checkout.yaml
docs:
- ./docssync reconciles
13 kinds- 01Service metadata
- 02API specs
- 03Dependencies
- 04Mermaid diagrams
- 05Test packs
- 06Test cases
- 07Database schemas
- 08Saved queries
- 09Documentation
- 10Maps, frames & focal points
- 11Cost rules
- 12Timeline events
- 13ML models & experiments
Every push
The graph moves in the same commit as the code.
Put sync in CI. A merge changes the code and its system description together, leaving no drift window to clean up later.
Commit
Code + .uigraph.yaml
CI
sync
Graph
Current
--dry-run
Preview the graph change first.
See what sync would change without applying anything. Use it while wiring up the repo, then keep it in pull-request checks.
Setup
Three decisions, then sync.
Install
go install github.com/uigraph/cli@latest
or use the Docker image
Authenticate
Set UIGRAPH_TOKEN in the environment or CI secret store.
Target
Pass --enterprise when syncing to a self-hosted instance.
This is the spine
One sync feeds every product.
Built for platform teams, backend engineers, and engineering leads
Frequently asked questions
Still have a question about the CLI? The docs cover installation, authentication, configuration, and sync behavior in detail.
Read the docs$ uigraph-cli sync
Commit one definition, run one command in CI, and stop maintaining the graph by hand.