Quickstart

Deploy a function to Cluster in 5 minutes.

1. Install

curl -fsSL https://assets.cluster.app/serve/cstatic-assets/releases/ccp/install.sh | sh

See Installation for other install methods and shell completions.

2. Log In

ccp auth login

Enter your email and the OTP code sent to your inbox.

3. Create a Project

ccp init my-app
cd my-app

This scaffolds a TypeScript project with a handler template. When prompted, select an organization and create a function to link your project.

4. Start Dev Server

ccp dev
# ◼ Dev Server started!
# › http://127.0.0.1:1234

Open http://127.0.0.1:1234 — you'll see "Hello from Cluster!". Edit index.ts and the server hot-reloads automatically.

5. Deploy

ccp deploy --prod

Your function is live at https://my-app.clusterbase.dev.

What Just Happened?

1. ccp deploy bundled your TypeScript with esbuild
2. Uploaded the bundle to Cluster's storage
3. Activated a deployment on the serverless runtime
4. The runtime created a V8 isolate for your function
5. Traefik routes my-app.clusterbase.dev to your isolate

Next Steps

• Edit your handler — learn about the Request/Response model
• Add a custom domain — serve from your own domain
• Serve static files — deploy an SPA with --public-dir
• Explore the runtime — see all available Web APIs