Getting Started

TDL is a simple way to create architecture diagrams using text. It's designed to be easy to write for both humans and AI models.

Your First Diagram

A minimal TDL file looks like this:

@arch My First Diagram

[nodes]
  user:User
  web:Web App

[edges]
  user->web:visits

This creates an architecture diagram with two nodes ("User" and "Web App") connected by an arrow labeled "visits".

Adding Tech Icons

TDL supports technology icons. Add them using the |icon: property.

@arch Cloud App

[nodes]
  client:Browser|icon:chrome
  api:API Server|icon:nodejs
  db:Database|cyl|icon:postgresql

[edges]
  client->api:requests
  api->db:queries

Grouping Nodes

Group related nodes together to show boundaries (like VPCs, subnets, or logical services).

Or use the compact syntax:

Diagram Types

While @arch (Architecture) is the primary diagram type, TDL supports:

Type
Description

@arch

System Architecture

@seq

Sequence Diagram

@flow

Flowchart

@state

State Diagram

@er

Entity-Relationship

Next Steps

Last updated