Skip to content

tld list, inspect & render

View Markdown

Once your workspace is built, these commands let you look around without opening the editor. All of them are read-only.

tld list mirrors the frontend inventory from the local YAML cache.

Terminal window
tld list elements
tld list connectors
tld list views
REF NAME KIND TECHNOLOGY OWNER TAGS VIEW ID
api-gateway API Gateway service Go - backend yes 12

Filter with --search (matches ref, name, kind, technology, owner, tags) or --kind:

Terminal window
tld list elements --kind database
tld list elements --search auth

Filter with --search (view, source, target, label, relationship) or --view:

Terminal window
tld list connectors --view api-gateway

Views are the drill-down diagrams owned by elements. tld list views shows the derived hierarchy, including the synthetic root:

Terminal window
tld list views
tld list views --parent api-gateway
tld list views --tree

Each row reports the element count, child views, connector count, depth, and full path from root. --tree renders the hierarchy as a tree instead of a table.

tld inspect shows a single resource across every state source: your YAML, the local database, and optionally the cloud.

Terminal window
tld inspect api-gateway

If a ref is ambiguous across resource types, narrow it with --type element|view|connector. Include the local database with --all, or add the cloud with --cloud:

Terminal window
tld inspect root:api-gateway:auth-svc --type connector
tld inspect api-gateway --all

The output lists the resource’s fields, YAML metadata, placements, related connectors, and whether it’s present or missing in each state source.

tld render prints a view as Mermaid, so you can drop it into a Markdown file.

Terminal window
tld render root
tld render api-gateway

It emits a Mermaid flowchart LR with the view’s elements and the connectors scoped to it. Write it to a file with -o:

Terminal window
tld render api-gateway -o api-gateway.mmd

--view is an alternative to the positional argument, and --format mermaid is the only supported format today.

tld tech inspects the built-in technology catalog that powers tld add --technology suggestions.

Terminal window
tld tech
tld tech --limit 20 --offset 40
tld tech suggest kubernetees
  • --limit caps the number of entries returned (1–500, default 50).
  • --offset pages through the catalog.
  • tld tech suggest <name> returns close matches for a misspelled or partial technology name.

Every command honors the global --format json and --compact flags:

Terminal window
tld list elements --format json
tld inspect api-gateway --format json --compact
tld render root --format json