Welcome to UIGraph Documentation
UIGraph helps engineering, product, and platform teams describe how a system works through maps, frames, implementation points, database models, and synced engineering metadata.
Get started
Self-Hosting Quick Start
Deploy UIGraph in your own environment.
Onboard your codebase
Let a coding agent document your system in UIGraph.
UIGraph CLI
Sync repository metadata into UIGraph from a repository-level config.
Document your system
Maps
Group frames around a feature, flow, or domain.
Frames
Represent screens, diagrams, and other visual artifacts inside a map.
Points
Link frame regions to implementation details and nested variants.
Diagrams
C4 diagrams
Model your system architecture with C4 diagrams.
Mermaid diagrams
Publish Mermaid diagrams from your repository.
Data modeling
SQL Import
Turn SQL schema files into visual structures your team can inspect.
NoSQL
Model document and key-value data stores.
DynamoDB
Visualize DynamoDB table designs.
Database sync
Keep database schema documentation current from your repository.
Automate from your repository
API specs
Sync API specs and metadata from your repository.
Test packs
Attach test evidence to your documentation.
CI/CD setup
Run the CLI as part of your delivery pipeline.
Troubleshooting
Diagnose and fix common CLI issues.
Agents and integrations
UIGraph Agents
Automate documentation work with AI agents.
Artifacts agent
Generate and maintain documentation artifacts from your code.
Impact agent
Assess the impact of changes on pull requests.
Slack Bot
Bring UIGraph answers into Slack.
UIGraph MCP
Connect AI tools to UIGraph through MCP.
Self-hosting and administration
Self-Hosting overview
Understand the architecture and deployment options.
Environment variables
Configure every UIGraph service.
Identity and SSO
Set up authentication, SAML, and SSO provisioning.
Operations
Handle backups, upgrades, and monitoring.
AI providers
Connect your AI model provider.
Support
- Email support: support@uigraph.app
- Product site: uigraph.app