Skip to content
Back to search

tld

Software architecture diagramming tool. Includes a modern easy to use Frontend + Backend + CLI to enable managing diagrams from the shell or in CI.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026. Its scripts were only partly scanned.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/Mertcikla/tld with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/Mertcikla/tld'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/mertcikla-tld/badge.svg)](/listings/mertcikla-tld)

HTML

<a href="/listings/mertcikla-tld"><img src="/api/listings/mertcikla-tld/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

These steps run a script from the network that findsafeskills does not scan.

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"

By default, the web UI runs at [http://127.0.0.1:8060](http://127.0.0.1:8060). `tld serve` starts the server in the background; use `tld status` to inspect it and `tld stop` to shut it down. Run `tld serve --open` to start it again.

Desktop App

Native desktop builds for macOS and Windows are available on the [releases page](https://github.com/Mertcikla/tld/releases). Look for assets named `tld-desktop-*`. CLI archives for macOS, Linux, and Windows are available there too.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/plugin.json · Manifest · 10 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. {
  2. "name": "tldiagram",
  3. "description": "Codebase diagram generation for tldiagram.com",
  4. "version": "0.0.1",
  5. "homepage": "https://tldiagram.com",
  6. "author": {
  7. "name": "Mert Çıkla",
  8. "url": "https://github.com/mertcikla"
  9. }
  10. }
README.md · README · 180 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <a href="https://tldiagram.com">
  3. <img src="./frontend/logo/tld.svg" alt="Logo" width="200">
  4. </a>
  5. </p>
  6. <p align="center">
  7. <img width="900" height="900" alt="explore" src="https://github.com/user-attachments/assets/4a85bdda-b51f-4c4f-946f-30ba5dacd26a" />
  8. </p>
  9. `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.
  10. <p align="center">
  11. <a href="https://go.dev/"><img src="https://img.shields.io/github/go-mod/go-version/mertcikla/tld" alt="Go Version"></a>
  12. <a href="./LICENSE"><img src="https://img.shields.io/github/license/mertcikla/tld" alt="License"></a>
  13. <a href="https://github.com/mertcikla/tld/actions"><img src="https://img.shields.io/github/actions/workflow/status/mertcikla/tld/test.yml?branch=main" alt="Build Status"></a>
  14. <a href="https://deepwiki.com/Mertcikla/tld"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
  15. </p>
  16. ## Highlights
  17. - **Markdown Notes Support**: Add notes and documentation for your diagram or link an existing one, preview and edit diagrams and markdown side-by-side.
  18. - **Mermaid Integration**: Easily sync your diagrams with mermaid blocks in a markdown file for portable viewing in any markdown viewer [docs](https://tldiagram.com/docs/ui/mermaid/).
  19. <p align="center">
  20. <img width="900" height="506" alt="export-1792291239238" src="https://github.com/user-attachments/assets/bce6a3b5-fec5-44d7-a685-0710edf704dc" />
  21. </p>
  22. - **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).
  23. - **Flows**: Create flows to visualize processes, user journeys, and data pipelines. Flows are portable and can be viewed with any tld or on tldiagram.com
  24. - Here is a [flow](https://tldiagram.com/app/explore/shared/flow-snapshot#flow=v1.QlpoOTFBWSZTWRr6djEABP_f4VVVXg__-j_vfwq____wQAAEABAAYA2-2m8wHTnZ2zcz7ymUbLqVedoerAdF3uze7QO7dHQa8JFNTUynoao_SnqfqntSeU2k2k0PKepo0bUDQAABoJQCECNTVPaU9BNNNAeRMQAAAZAAcAwjCaYhgEAyAGEaZMmEYCGgk0oiAhTyMKMmjQ00aMgaaAAANAAiU1DUKmekm1NobagmTQNAJ-qaMAQZMQaaCJQgCCaZNBDCTKaeSepp5QB6agAD0ahoURdocEfl8JUT1fKWtP6r411hx_yrR-OghG0upFnZr_feLFKKp0oH75OR6FBh3aIkDMY2A4-FcJxlIgsQeH5AyMVeKyyKHEgPtHWdbtI195Pbd9f2PP83VsboHUam0JuvoC0uvGzsyMXuTy5dOOvLuIndjGfUyrwNTTYhUhRmZCbRYmrQKMw8Rtd9NlVmmMF156t7BdMVBF5FBQy0qhQxJUDnEFniYdLKsSMREGMeDLBBFgxFiyZdONwqTLPfwUA5u1YQ15eUHXnNUqz29J1yRJ0cM7xkmRxs60fF131ztl_q6trq6Aq6zXc3jBvZLRBYO8JEiW5t6XY5EgwX0cZU5KObQc1jKGmybVC4_Vs3q0Q6Bvu2OI-zN376daAMNpps8PmA-NZeCDbkvyRmBTc9r40p5bhOyImtn4UrYfIF3zxC4as2yul7kYRq6oAqejJyDoUUZjRVRDe3FECd4o6IpYF4uXSlRiAfPZb-DdGWpw22TEbNZm5S774nbW2-XBYTDGrHpzk0RoGnZjvntyfzES0oQXpINL4tQPnbW43Q4hSNxNuSHjXsJRUZkeq7WdHsrPaC9PVVapWpL2UkFlybtVXaltUo5fspZItdxSpva1rE2hcDxZZaxaGLxMQzcHVSU9x-rTZWPKxwcnuvpc3wjxPdd91vG8rm9B1PRbPY4i-XZNfJXUfHtkkYRgILFPh8vfLaMolPigaK6CW0RV7ve28_eTxIquT4fY5nAZl8V_ALYlr54dfFXEvYxq3jh9b6LCowq7JCsiTY0eNGLpkaSOklSaxs-GqPMmmidQoxF3Y0d--qG12a4zxn4pVOl6ajBfRWYZnBGOuxZX1xy6V7Dqr13PSZ0MsMXZM2kzDXHo2W0zYa-lpgFVEMKPc9-411ymnMMxOBVHrFNAzZNhVKAZ4cenYeHUmiHdJVMCMhaI5bnR5Lo_e7Tu9H8Smtt9948zpYdoGejRntVuWm7I3fLMzI-Zk2o5FJUUWxYlthwYaq4KM4yyWUuxVMoKEIptIJnByiEiF-G5UJIhEiFzRuaQHcSxLKgeAtwzxGJ0QfYVB0GUbmMyPs6OK27Oiig7Ks7Jk-VtjbBkKUt2MxXRWzsPiF0DQIRkxKU2g4pZohVtFKONyppXO4S1vzSpwrYB0RAJxYEmEk2a0gYNXktRwBLSk5EmnCzZob27OdsOi54Dz45jXaY0bDQn2OghhYwGawa5xGb2i5N_QnodMLU2zFn58sqkYozmpROfaXAsHZeTH34O0mTPU82beiSByznhwDq6cKObz4lB2cGA6F3krv2UZ2n2mjWzlLAqKKq3yGOFtILTe2hTMzT09MogmoYEL4dbvRcSEq6m70nQFG0KombzgceehVgsE4jYb9u1XTYYDE1tdNxroa3cMXIVsMOKKt2EwqBJRSQ0kCRnoRGZBQ8DQ6WLoJApYmEdBVCZy0uORqPpldpN5ea5ppeMNQqCast9DOrsM2TmDfDGQnBDFDmu9HGmu8uo0YySTMw2OzZfm8QA9CGYHchBPjvhoYDyZYYBO9hYnhVrRRVLarFiiixVqZGiLhXCYUXQGxFxAPAoSCWaLElzcJLAVSpEoBYbQhlVGGGXGN-lk1odhvMTif3WmbuAlMj-sEKAlKA8moMHkx3mywtCKElUIh_BvXmzFwj-XNc-AG5ZCQOZ7nTWg5NZZQPmAdICsRkIs0eADYAXA5-v4i7KslKGBO3l9f_ALu9iW8lT8M33GiFNlj6HzkLzAtrJmFS59ILbdwxlMUOfaId4XtfhfIu7gUl-B8dBumZ2IZcQXd8M2vINeaZY1PaHxClMzHWlaGzFGIY7UFtZNl-lsYwYqJgrgNaMA0gaDHfJbjgjPy8y2SerWWxNG1UEmPDVXIVrCLBiuclt6Ak7fVjFzofdHZtmTs3AGS6TcxMtK0sp74vjDkfJPvAvDbcZARNUAoDmRkQWQOvIaEMOre6cq4Elx3EwiZQLkZ25pnAXWYIqQWbAYbvsWJ2zfkdD6YHMehUtpS2yw4ZNMQLg5PEQs4kDPtMNOGePGadPX6-87eOW0t0Lgy4TOfG4HDY58Gy9_ju018FkGUxFeW8-FqpcpQUyXDpL55YxBf1S5hV1vS4ZXmuVwIixQUFKVGjZE6CyE0DjYpA4YrKRMwCBk8qqp_dUiKMrqqA4gPWT8YXVJrQvw9mgXr8zjQuQ2O3bYyFuJeoVQ9m8M3zj510cgC1Npf16DEzC284gFF5kDdBN944Ic9DjrpDF2WPdh-69XSYG3V7SupfqgFwU8g7lDJiFsou4-2HTHo160M6NX0sPCD6mBznZBKSL4IQiEidYahB2sGneX8bwvBdhuQD1up5AXm9rQDSwBYOPVSQnVWq09Yh4XNhGZfbTqY2YdXBCmSGalACb5SqUE2V0ySpEjyL7xpLi40HFviWWXbdLMoTYgRIcGg-KGK-PziGoFz3sA5fofreFtXzniBX07NNeWWmBn5rd0JJCQJIQGQBcEMUA8skJh4aDbE-PbU1y-7m-iuIBftRiOplVuf6wYShasyDqtNmc2gdyCx0iW-zeXr59UuQ6MlR_d2yebzHyfLvum_mJDbAYkOE9jo_F84rWraVens3Qs86yZvfIj6UOMQ37pydhdUzMAD7sg7Rg_iUvC1j0MNkDpbugCwB_P8chIwQONCjMbAyFr47eQ3zybwx2F01DVhNABzk93TPiJyGhNjIZWt0TbSgsUhJtnnZPK2Zi3LqlwIIWu120GYK0OVJUaQW5AEy53-KUDp_jIGEAVTDMAQDqD9p3kPbPsBmXWbaAMevcAb752lCDsAzg9EAAjvjtXEUwQjqLg5GwjpwxWpiuPgceGjG4QtnZCq8CoB4k2nm_ChsrDei5nAD4RQKSRb5dMHPrWQNWe-a9KHSgeQTkx7ya9xQhHH4U4TSnaOuQB5ZX4ZCbZtQC5Ms7DuYhAJCQJaklP4eoisSx6Dt7HR4btyLnpkhFdtLFZmdPcHQueKGU0W2kOCF4UHN2-nXzXSDtdwLsKgV2oB5ymaDCXO3TXq8xTZrlkG7GCAyg2u6ySgG0x3EMp61pezr4aTsxkDphNccF5qWWMWHO-kZ9idnnzvfgrrtknqat5Dy-bS_GDDU3nALLZKWovMCVzewJE-Xr-_wyQDgmwzNCSHNEfPs1ujPWhlbCJHSAVw-2yhyoY4aUdkay6hagkgfkD6s2q2g4oQ4B6n2j0vX3nbE4zbHiskJJZaFZWS1G0SceHutdvu54VuMrZHrMShdg54VtyULRwWIUA4AUnvnvhaVVrVYHz8NeVDgqaAGNx3nU4MIdyYPPe2ah0SaUfqb1GxvwLyxelKTTS0JCNKQFiEaoFUO35SQISGwrf_vHrxRvqmvXiV6bxN65iEGt4XCY25mESVjh3Fq2VrnYNxfG8mCHliFL-X6w92ZQ7-eFkXcPYgeQH03hx6dcT7mxvuIHSVZJAd9ezaAVFvO6exwquoZGRWQBhLQ53rODTdC5djUY5PK5VegDH6OLTI08CUeTSsr24gRbVoBsuAvQ2bD05VhQS6UdKN5H_F3JFOFCQGvp2MQA) that explains how the flow feature works.
  25. - **CLI that speaks agent**: Use the [agent skill](./skills/create-diagram/SKILL.md) 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.
  26. Here are some examples that were generated using the agent skill.
  27. - [Kubernetes](https://tldiagram.com/app/explore/shared/827bc17d-7d9b-411f-9d03-179fab99bcbd)
  28. - [pytorch](https://tldiagram.com/app/explore/shared/abc56a26-3e20-4235-90fa-e045b2b2ac74)
  29. - [kafka](https://tldiagram.com/app/explore/shared/9d415d7f-b91f-47c0-9dc7-756de2860695)
  30. - [.NET eShop reference](https://tldiagram.com/app/explore/shared/ba6cbf2a-e0ff-468a-87e5-f720d35f448d)
  31. - **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](https://marketplace.visualstudio.com/items?itemName=tlDiagram-com.tldiagram).
  32. - **Bi-directional Sync**: Seamlessly sync changes between your local YAML files, the self-hosted web UI, and the cloud version at tlDiagram.com.
  33. - **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.
  34. - **Codebase Mapping**: Generate source grounded elements to jump-start your diagramming process.
  35. - **Visualize Code Changes**: Visualize the changes between commits or a PR [docs](./docs/git-compare.md).
  36. - **PR Diagram Bot**: Automatically generate a diagram for your PR and visualize the changes in your codebase [docs](https://github.com/Mertcikla/tld-pr-bot).
  37. - **Diagrams as Code**: Manage architectural evolution alongside your source code.
  38. - **UI**: A frontend optimized to handle complex architectures, with intuitive design and polished with tools to manage contextual views.
  39. <p align="center">
  40. <img width="1280" height="882" alt="editor" src="https://github.com/user-attachments/assets/4ee283b0-ee45-4a04-86e4-f477c26e9977" />
  41. </p>
  42. ## Quick Start
  43. macOS and Linux
  44. ```bash
  45. curl -LsSf https://tldiagram.com/install.sh | sh -s serve --open
  46. ```
  47. Windows
  48. ```powershell
  49. powershell -ExecutionPolicy ByPass -c "irm https://tldiagram.com/install.ps1 | iex; tld serve --open"
  50. ```
  51. By default, the web UI runs at [http://127.0.0.1:8060](http://127.0.0.1:8060). `tld serve` starts the server in the background; use `tld status` to inspect it and `tld stop` to shut it down. Run `tld serve --open` to start it again.
  52. ### Desktop App
  53. Native desktop builds for macOS and Windows are available on the [releases page](https://github.com/Mertcikla/tld/releases). Look for assets named `tld-desktop-*`. CLI archives for macOS, Linux, and Windows are available there too.
  54. ## Deployment & Self-Hosting
  55. Run `tld serve` for a local SQLite-backed instance. Configuration lives in `~/.config/tldiagram/tld.global.yaml` by default; `TLD_CONFIG_DIR` overrides the configuration directory, and `TLD_DATA_DIR` overrides the directory for local data and logs.
  56. To use PostgreSQL, configure `database.driver` and `database.url` in the global config, or set environment variables.
  57. ```bash
  58. export TLD_DB_DRIVER=postgres
  59. export TLD_DATABASE_URL='postgres://user:pass@postgres:5432/tld?sslmode=require'
  60. export TLD_PUBLIC_URL='https://example.com'
  61. export TLD_HOST=127.0.0.1
  62. export PORT=8060
  63. tld serve
  64. ```
  65. `TLD_HOST` controls the bind address, and `TLD_PUBLIC_URL` sets the public URL used behind a reverse proxy. The example binds to loopback for a proxy on the same host. Use `tld serve --foreground` when a service manager needs to supervise the process.
  66. ### Docker
  67. From a checkout of this repository, start one of the supplied Compose stacks:
  68. ```bash
  69. # SQLite
  70. docker compose up -d
  71. # Or PostgreSQL
  72. docker compose -f docker-compose.postgres.yml up -d
  73. ```
  74. Both stacks expose the web UI at [http://127.0.0.1:8060](http://127.0.0.1:8060) by default and persist data in named volumes. The PostgreSQL stack uses the standard `postgres:16` image, with no extensions required. See [the SQLite Compose file](./docker-compose.yml) or [the PostgreSQL Compose file](./docker-compose.postgres.yml) for image, port, and storage settings.
  75. ## Mobile
  76. There are Mobile apps available in both [App Store](https://apps.apple.com/us/app/tldiagram/id6760236883) and [Play Store](https://play.google.com/store/apps/details?id=com.mertcikla.tldiagram) they are mostly cloud-oriented and free but require [tldiagram.com](https://tldiagram.com) account. They are good for quickly checking stuff on-the-go, small screens are hard for full featured diagram authoring but they still received some development effort and attention to make authoring possible on mobile.
  77. ## CLI Reference
  78. The CLI is built to enable LLM integration and use in CI/CD pipelines. It is a secondary interface to the web UI, and can be used to create, update, and inspect diagrams.
  79. Run `tld --help` for the authoring commands and `tld --help-all` for the full command catalog. Use `tld <command> --help` for fields, flags, and examples.
  80. ```bash
  81. tld context # Show the selected workspace and target
  82. tld list elements # Element refs, names, and database IDs
  83. tld list connectors # Keys for inspecting and updating connectors
  84. tld list views --tree # View owners and drill-down hierarchy
  85. tld update element --help # Editable fields, name changes, and YAML ref changes
  86. tld update connector --help # Editable fields, connector keys, and direction values
  87. tld view --help # Create and manage an element's owned view
  88. tld flow --help # Author flows, steps, branches, and portable YAML
  89. tld render root # Export the root view as Mermaid
  90. tld doctor # Check source-indexing prerequisites
  91. tld index --help # Index a repository, generate a map of your codebase, or watch changes live
  92. tld git compare --help # Compare Git revisions in a repository and visualize the changes on your diagrams
  93. tld mcp --help # Expose diagram tools to MCP clients over stdio
  94. ```
  95. [User guide and CLI reference](https://tldiagram.com/docs/tld/workspace/) for more information.
  96. ## Building & Development
  97. Requires Go 1.26.2 or newer, Node.js 24, npm, and Make.
  98. ```bash
  99. git clone https://github.com/Mertcikla/tld.git
  100. cd tld
  101. make build
  102. "$(go env GOPATH)/bin/tld" serve --open
  103. ```
  104. `make build` installs frontend dependencies, builds the web UI, and embeds it in
  105. the binary at `$(go env GOPATH)/bin/tld`. Build the frontend before compiling Go
  106. directly: the embedded assets come from `frontend/dist`.
  107. For live development, install [Air](https://github.com/air-verse/air)
  108. ```bash
  109. go install github.com/air-verse/air@latest
  110. make frontend-build
  111. make dev
  112. ```
  113. Development data is stored in
  114. `data/dev`, with configuration in `data/dev/config`.
  115. Run checks from the repository root:
  116. ```bash
  117. make lint-be # Go lint
  118. make lint-fe # TypeScript lint
  119. make test # Go and frontend unit tests
  120. make test-e2e # Playwright end-to-end tests; requires installed browser binaries
  121. ```
  122. The Go module is `github.com/mertcikla/tld/v2`, and the reusable frontend is
  123. published as `@tldiagram/core-ui`.
  124. ## License
  125. [Apache License 2.0](./LICENSE).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.