tld

tld is an opinionated, flexible diagramming tool with rich featureset to help you visualize, understand, and maintain your software architecture. Inspired by C4 model, designed with multiple opt-in features to answer evolving needs of software teams.

Highlights

• UI: A frontend optimized to handle complex architectures, with intuitive design and polished with tools to manage contextual views.

• Standalone Distribution: A single, dependency-free binary containing both the server and the web application. Available as CLI + WebUI or Native app(windows and macOS).

• CLI that speaks agent: Use the agent skill and use your agent to create a diagram of your codebase with the exact detail level you need. Prompt the agent to add/remove details you see fit. Here are some examples that were generated using the agent skill.

  • Kubernetes

  • pytorch

  • kafka

  • .NET eShop reference

• Editor and Github Integration: Jump to the code in your editor or Github from diagrams, or open the code symbol in diagram from your editor to visualize the code using the VSCode extension.

• Markdown Notes Support: Add notes and documentation for your diagram or link an existing one, preview and edit diagrams and markdown side-by-side.

• Mermaid Integration: Easily sync your diagrams with mermaid blocks in a markdown file for portable viewing in any markdown viewer docs.

• Bi-directional Sync: Seamlessly sync changes between your local YAML files, the self-hosted web UI, and the cloud version at tlDiagram.com.

• Git diff visualization: Sync and visualize the changes you or your agent are making live in diagram form. Inspect the dependencies and intervene when necessary.

• Codebase Mapping: Generate source grounded elements to jump-start your diagramming process.

• Visualize Code Changes: Visualize the changes between commits or a PR docs.

• PR Diagram Bot: Automatically generate a diagram for your PR and visualize the changes in your codebase docs.

• Diagrams as Code: Manage architectural evolution alongside your source code.

Quick Start

macOS and Linux

curl -LsSf https://tldiagram.com/install.sh | sh -s serve --open

Windows

powershell -ExecutionPolicy ByPass -c "irm https://tldiagram.com/install.ps1 | iex; tld serve --open"

tld has native-desktop builds for macOS and windows. Look for tld-desktop binaries in releases.

Documentation

Visit docs for more info.

Deployment & Self-Hosting

tld designed to be run fully offline, behind a reverse-proxy or in your infrastructure or as a local development tool.

Run tld serve to start a local SQLite-backed instance, or configure PostgreSQL in ~/.config/tldiagram/tld.global.yaml or via env vars