Repository sync

Generate an architecture diagramstraight from your repository.

Connect a GitHub, GitLab, or Azure DevOps repo and get an architecture diagram plus an architecture.md that stay current as the code moves.

Part of Pro and Team · 7-day free trial · No credit card

Works withGitHubGitLabAzure DevOps

How it works

Three steps, then it maintains itself

A diagram per branch or tag, generated from the files that define the system.

01

Connect read-only

Point Datadef at a GitHub, GitLab, or Azure DevOps repo. Public repos need no token, private repos take a read-only token. Datadef never writes to your repository.

02

Pick a branch or tag

Each diagram tracks one ref: main, a release tag, a feature branch. Datadef reads the repo first, then asks what you want drawn.

03

Embed it and forget it

You get the diagram and an architecture.md. A daily sync regenerates both when the code moves. Refresh any time, from the app or your agent.

No blank prompt.

The options it proposes, the deployment topology, the data flow, one service in detail, come from your code, not a template.

The living embed

A README that stops rotting

Public projects get an architecture.md with the embed line already in it. Paste it anywhere markdown renders; every copy updates when the diagram does.

What the sync writes

architecture.md

## Architecture

Events land in Kafka, Flink jobs sessionise them, and ClickHouse serves the dashboards.

![Architecture diagram](https://datadef.io/api/embed/streaming-analytics-platform)

_Embedded from Datadef. The daily sync keeps it matching main._

The highlighted line is the live embed. The rest covers the components, the data flow, and how the system deploys.

What readers see

Architecture

Events land in Kafka, Flink jobs sessionise them, and ClickHouse serves the dashboards.

A streaming analytics architecture diagram with Kafka, Flink and ClickHouse, as the embed renders it

Embedded from Datadef. The daily sync keeps it matching main.

Static example. On your project the image is live and picks up canvas changes within minutes.

For agents

Your agent can check it and refresh it

Repo diagrams are reachable from Claude Code, Cursor, or any MCP client. Ask whether the diagram still matches the code, and trigger a re-sync when it should not wait for the daily run.

repo_status reports the link, the connection, and how fresh the diagram is

repo_refresh triggers a sync on demand, straight from the conversation

Unchanged code means an untouched diagram: syncs skip when the ref has not moved

MCP setup in the docs
claude code

> Is the platform diagram still in sync with main?

repo_status

synced 2 hours ago · ref main · diagram matches the last commit

> We just merged the ingestion service. Refresh it.

repo_refresh

sync started · the diagram and architecture.md regenerate from the new commit

Honest answers

Do private repositories need write access?

No. Public repositories need no token at all. Private repositories use a read-only personal access token: Contents Read-only on GitHub, read_api on GitLab, Code Read on Azure DevOps. The token is stored encrypted, only its last 4 characters are ever shown again, and Datadef never writes to your repository.

What does Datadef actually read?

Not the whole repo. It selects a bounded set of the most architecture-dense files: infrastructure as code, containers and orchestration, database schemas and dbt models, API specs, CI pipelines, and manifests, plus a compact summary of the directory tree. The diagram is grounded in those files, so architecture that appears nowhere in them will not be drawn.

What happens to manual edits I make on the canvas?

Every sync regenerates the diagram from the code, so manual canvas edits can be replaced on the next refresh. If you want to hand-tune a repo diagram, turn off its daily sync or unlink it first. A published version also preserves the state you want to keep.

Which providers are supported?

GitHub, GitLab, and Azure DevOps, on their cloud hosts: github.com, gitlab.com, and dev.azure.com. Self-hosted instances such as GitHub Enterprise Server or self-managed GitLab are not supported yet.

Is repository sync included in the free trial?

Repository sync is part of the Pro and Team plans, and every new account starts with a 7-day trial of the full product, no card required. So yes: sign up and connect a repository right away.

What happens if my plan lapses?

Nothing is deleted. Every diagram and doc stays viewable, and existing embeds keep rendering the last synced version. Background syncs and manual refreshes pause until the plan is active again.

Point Datadef at a repository

Connect a repo, pick a branch, and get an architecture diagram plus an architecture.md that keep themselves current. Every new account starts with a 7-day trial of everything, no card needed.

Read-only access·GitHub, GitLab, Azure DevOps·No credit card