Documentation

Quick Start

Get up and running with TDK in under 5 minutes.

Prerequisites

Installation

Option 1: npm (recommended)

npm install -g tdk-cli

Option 2: Homebrew (macOS/Linux)

brew install tdk-cli

Option 3: GitHub Releases

Download the latest binary from GitHub Releases.

Verify Installation

tdk --version
# tdk-cli v1.0.0

Create Your First Service

Step 1: Create a new project

mkdir my-service
cd my-service
tdk init

Step 2: Edit service.json

{
  "appName": "my-backend",
  "appType": "backend",
  "port": 3000,
  "features": ["typescript", "bun"],
  "stack": "api"
}

Step 3: Generate configs

tdk generate

This creates 10+ configuration files in the .autogenerated/ folder.

Step 4: Run with Tilt

tilt up

🎉 Success!

Your service is now running locally. Visit http://localhost:3000 to see it in action.

Next Steps