CLI Usage with AI Agent

The tld CLI allows you to define, plan, and apply your system architecture diagrams using configuration files. Combined with an AI agent, you can automatically generate and refine diagrams directly from your source code.

Installation

To install the tld CLI, run the following command in your terminal:

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

OR with brew

brew install --cask Mertcikla/tap/tld

Getting Started

Follow these steps to generate a diagram for your project:

1. Initialize the Workspace

Go to your project’s root directory and initialize the tld workspace:

tld init

2. Login and Authorize

Authenticate your CLI with tldiagram.com:

tld login

Follow the prompts in your browser to authorize access.

3.a Install the Agent Skill

Add the create-diagram skill to your favorite AI agent:

npx skills add Mertcikla/tld-cli

3.b Gemini Extension

gemini extensions install  https://github.com/Mertcikla/tld-cli

3.c Claude Plugin

SOON

3.d VS Code Extension

Download the official VS Code Extension to view and edit your diagrams directly within your IDE.

Generating Diagrams with AI

Once the skill is installed, you can use your AI agent to map your codebase.

Prompt the Agent

Ask your agent to create a diagram:

“Create a diagram of this codebase”

The agent will analyze your project structure and generate the necessary YAML files in your workspace. You can follow along and provide more specific prompts if you want deeper detail on certain modules:

“Add more detail on the authentication flow in the backend directory”

Preview the Plan

Before publishing, review the changes that will be made:

tld plan

This generates a summary of the diagrams and objects to be created. You can manually inspect the generated YAML files in your repository if needed.

Apply and Publish

When you’re satisfied with the plan, publish your diagram to tldiagram.com:

tld apply

Your architecture is now live and can be viewed, edited, and shared on the tldiagram web interface.