uigraph-cli syncs service metadata and API specifications from your repository to UiGraph.

It is designed for CI/CD workflows and works with a repository-level .uigraph.yaml file.

Full setup, configuration, and usage guides live in the official UiGraph docs:

• UIGraph Documentation
• UIGraph CLI Docs

This README stays intentionally brief. The hosted docs are the source of truth for configuration, supported inputs, and end-to-end workflows.

go install github.com/uigraph-oss/uigraph-cli@latest

No Go install required. Pull the published image from Docker Hub and sync from your repository:

docker pull uigraph-oss/uigraph-cli:latest

docker run --rm \
  -e UIGRAPH_TOKEN \
  -v "$(pwd):/workspace" \
  -w /workspace \
  uigraph/uigraph-cli:latest sync

Mount your repo at /workspace so the CLI can read .uigraph.yaml and API specs. Pass any sync flags after the image name (for example sync --dry-run).

git clone https://github.com/uigraph-oss/uigraph-cli.git
cd uigraph-cli
make build

1. Add a .uigraph.yaml file to your repository.
2. Set UIGRAPH_TOKEN in your CI environment.
3. Run:

uigraph-cli sync --enterprise

--enterprise points the CLI at the UiGraph gateway (--enterprise=DEV for the dev environment), so there is no need to set UIGRAPH_GATEWAY_URL. Self-hosted instances keep using --api-url or UIGRAPH_GATEWAY_URL.

Example:

version: 1

service:
  name: Booking Service
  category: Backend
  description: Handles booking lifecycle and availability
  repository:
    provider: github
    url: https://github.com/company/booking-service

apis:
  - name: booking-service-openapi
    type: openapi
    path: ./openapi.yaml

uigraph-cli sync
uigraph-cli sync --config ./config/.uigraph.yaml
uigraph-cli sync --dry-run
uigraph-cli sync --enterprise
uigraph-cli sync --enterprise=DEV --dry-run

Record a release from a tag-triggered pipeline job. The version, notes and commit range are resolved from git at the moment the tag is cut:

uigraph-cli release
uigraph-cli release --version v1.2.3 --notes-file ./RELEASE_NOTES.md
uigraph-cli release --dry-run

• Syncing service metadata to UIGraph
• Syncing API specs such as OpenAPI, GraphQL, and gRPC
• Syncing cost category tags that decide which cloud resources roll up into a service's costs
• Syncing test packs and test cases, including reference screenshots
• Scanning the repo for timeline events — ADRs, postmortems, and CHANGELOG releases
• Recording a release on the timeline from a CI/CD tag job via uigraph-cli release
• Running cleanly in CI/CD pipelines
• Capturing git metadata during sync

make build
make test

MIT. See LICENSE.