DEV Community

tdk-cli
tdk-cli

Posted on

Everything You Need to Know About TDK CLI Core

TDK CLI Core is the command-line tool at the centre of TDK. It describes each service of an application in a small service.json file, generates the local runtime files from those descriptions, and starts the whole stack with Docker and Tilt. You write the application code. The tool writes the plumbing.

What it does

  • Describes services. Each service has a service.json with its runtime, port, and dependencies.
  • Generates runtime files. Dockerfiles, routing configuration, and Tilt wiring are written under .autogenerated/.
  • Starts the stack. tdk up runs the containers, routes traffic through Traefik, and keeps them updated with Tilt.
  • Checks itself. Generated files are compared with saved snapshots before startup, so a hand edit is reported before anything runs.

A project in five steps

  1. Create a project with tdk project --yes.
  2. Add a service with tdk resource <name> --type <type>. Types include frontend, backend, worker, mcp, and bring-your-own.
  3. Check the plan with tdk up main --dry-run.
  4. Start the stack with tdk up.
  5. Watch it with tdk ui, or check readiness with tdk status --json.

Commands you will use daily

  • tdk doctor --json checks whether the machine can run the stack.
  • tdk logs --json --service <name> --tail <n> prints recent lines for one service.
  • tdk down stops the stack.

What it is not

TDK CLI Core is for local development. It is not a deployment tool, and production deployment stays with Helm, Argo CD, or Kustomize. It also needs a container runtime. Without one, tdk doctor says so and the stack does not start.

Where to go next

The repository has the full command reference. The generated files reference explains what appears under .autogenerated/. The example repos show complete projects.

Top comments (0)