Your engineering context.Synced from your repo.
Reference your existing files in a UIGraph YAML file, then sync them using the CLI. Run it locally or automate updates through your CI/CD pipeline.
$ 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
Start with a UIGraph YAML file.
Define your services and reference the files you want to sync, such as API specs, schemas, diagrams, and documentation. Keep the configuration in your repo so your team can review and update it alongside the code.
version: 1
organization: acme
services:
- name: payments-service
owner: payments-team
apiSpecs:
- ./openapi.yaml
databases:
- ./db/schema.sql
testPacks:
- ./tests/checkout.yaml
docs:
- ./docsWhat you can sync
- 01Service metadata
- 02API specs
- 03Dependencies
- 04Mermaid diagrams
- 05Test packs
- 06Test cases
- 07Database schemas
- 08Saved queries
- 09Documentation
- 10Maps, frames & focal points
- 11Cost rules
- 12Timeline events
Make sync part
of your workflow.
Add uigraph-cli sync to your CI/CD pipeline to sync the files referenced in your UIGraph YAML configuration whenever the workflow runs.
Use uigraph-cli sync --dry-run in pull request checks to validate your configuration without writing changes to UIGraph.
Repository
Code + .uigraph.yaml
CI/CD
uigraph-cli sync
UIGraph
Current
Frequently asked questions
Still have a question about the CLI? The docs cover installation, authentication, configuration, and sync behavior in detail.
Read the docsReady for your first sync?
Start with the files you already have. Follow the CLI guide to sync them into UIGraph.