Skip to content
Kalayaan Kalayaan

Quickstart

Kalayaan deploys entirely onto your own Cloudflare account — Workers, D1, R2, and KV, all on the permanent free tier. There’s no separate hosting to sign up for and no server to manage.

1. Sign in

Terminal window
npx kalayaan login

A one-time guided sign-in: it opens a Cloudflare API token page with the right permissions pre-filled, and auto-discovers your account. Credentials are stored at ~/.kalayaan/credentials.json — init, dev, deploy, and down all pick them up automatically, no environment variables needed locally.

2. Scaffold a project

Terminal window
npx kalayaan init my-site

init is a guided wizard. It asks for:

  • your content models (or pick a starter template — blog, portfolio, docs, or blank),
  • which optional services to turn on (AI features, email invites, a custom domain, public submissions),
  • and whether to deploy right at the end of the wizard.

It writes cms.config.ts and a package.json for your project.

3. Run it locally

Terminal window
cd my-site
npm install
npx kalayaan dev

dev runs your whole CMS locally under workerd (Cloudflare’s actual Workers runtime), backed by local D1/R2/KV — no Cloudflare account calls needed for local development. Add --host to make it reachable on your LAN.

4. Deploy

Terminal window
npx kalayaan deploy

deploy is idempotent and safe to re-run — it provisions D1, R2, and KV, applies any pending schema migration, uploads the Worker and the admin SPA, sets up first-run secrets, and prints your live URL (https://my-site.<you>.workers.dev).

To use your own domain instead:

Terminal window
npx kalayaan deploy --domain blog.example.com

See the custom domains guide for the one prerequisite (the domain needs to already be a Cloudflare zone).

On first deploy, create your admin account at <your-url>/admin — or bootstrap it non-interactively with --admin-email/--admin-password for CI.

5. Tear it down

Terminal window
npx kalayaan down

Detaches any custom domain and deletes the deployed Worker and every resource it provisioned (D1, R2, KV, and Hyperdrive/Vectorize if you enabled them). Asks for confirmation unless you pass --yes.

What’s next