vk dev

Usage

vk dev [options]

Options

Option	Description	Default
-s, --stage <stage>	Stage name	dev
-p, --port <port>	Server port	3000

Description

Starts a fully local development server. No AWS credentials or cloud resources required.

• Discovers routes from your routesDir and serves them via HTTP
• Starts Docker Compose services for infrastructure (Postgres, Redis, MinIO)
• Converts HTTP requests to Lambda-compatible APIGatewayProxyEventV2 events
• Loads TypeScript handlers at runtime (no build step needed)

Examples

# Start with defaults (port 3000)
vk dev

# Custom port
vk dev --port 8080

# Custom stage
vk dev --stage my-feature

Requirements

• Docker running (for database, cache, and storage services)
• VentureKit project with vk.config.ts
• Dependencies installed (npm install)

No AWS credentials are needed for local development.

How It Works

1. Loads vk.config.ts using runtime TypeScript transpilation (via jiti)
2. Generates a docker-compose.yml in .vk/ based on your infrastructure intents
3. Starts Docker services (Postgres, Redis, MinIO) as needed
4. Discovers routes from your routesDir and maps them to HTTP endpoints
5. Serves requests locally, converting them to Lambda event format
6. Route handlers are loaded on-demand — edit a file and the next request uses the new code

Local Services

Infrastructure Intent	Local Service	Port
databases (postgres)	PostgreSQL (Docker)	5432
caches (redis)	Redis (Docker)	6379
storage	MinIO (Docker)	9000