tld

tld is a powerful and opinionated software architecture diagramming tool designed to simplify the process of visualizing, understanding, and maintaining software architecture. Drawing inspiration from the C4 model, tld offers a rich feature set that adapts to the evolving needs of software development teams.

Key Features

• User-Friendly Interface: The frontend is optimized for handling complex architectures, featuring an intuitive design that allows for seamless management of contextual views.

• Standalone Distribution: The tool is packaged as a single, dependency-free binary that includes both the server and web application. It is available as a CLI, WebUI, or native application for both Windows and macOS.

• Intelligent CLI: Utilize the built-in agent skill to generate detailed diagrams of your codebase. Adjust the level of detail by prompting the agent to add or remove elements as needed:

  • Kubernetes Diagram Example
  • PyTorch Diagram Example
  • Kafka Diagram Example
  • .NET eShop Reference Diagram

• Editor and GitHub Integration: Transition effortlessly between code and diagrams with integrated features for navigating to the code within the editor or on GitHub. The VSCode extension facilitates visualizing code from diagrams directly in your development environment.

• Mermaid Diagram Integration: Import existing Mermaid diagrams or export your created diagrams as Mermaid for easy sharing and collaboration.

• Markdown Notes Support: Enhance diagrams with annotations or documentation, enabling side-by-side preview and editing for better context and clarity.

• Bi-directional Sync (Experimental): Synchronize local YAML files with the web UI or cloud version, making it easier to manage changes across platforms.

• Git Diff Visualization (Experimental): This feature allows real-time synchronization and visualization of changes, helping users monitor modifications and their impacts on the architecture.

• Diagrams as Code (Experimental): A git-like workflow (plan/apply) empowers users to manage architectural evolution in tandem with source code.

• Automated Codebase Analysis (Experimental): Built-in integration with tree-sitter automates the discovery of architectural components in popular programming languages like Go, Java, Python, C++, and TypeScript.

Quick Start

To get started with tld, users can refer to the installation scripts for macOS, Linux, and Windows, providing quick access to the functionality of the tool.

Documentation

Comprehensive documentation can be accessed at docs, offering detailed information to navigate through the various features of tld.

Mobile Support

Mobile applications are available on both the App Store and Play Store. These apps facilitate quick access to diagrams while on-the-go, although full-fledged diagram authoring is best suited for larger screens.

Commands Reference

For help and command references, utilize the tld --help command to explore the capabilities and utilities provided by the tool.