Getting started

Tip

Want the idea before the install? What is Alchemy? explains the model in a few minutes. Otherwise, read on and it’s the next page.

Prerequisites

• Bun (recommended) or Node.js 22+
• A Cloudflare account

Create a project

bun

mkdir my-app && cd my-app && bun init -y

npm

mkdir my-app && cd my-app && npm init -y

pnpm

mkdir my-app && cd my-app && pnpm init

yarn

mkdir my-app && cd my-app && yarn init -y

Install

bun

bun add "alchemy@latest" "effect@rc" "@effect/platform-bun@rc" "@effect/platform-node@rc"

npm

npm install "alchemy@latest" "effect@rc" "@effect/platform-bun@rc" "@effect/platform-node@rc"

pnpm

pnpm add "alchemy@latest" "effect@rc" "@effect/platform-bun@rc" "@effect/platform-node@rc"

yarn

yarn add "alchemy@latest" "effect@rc" "@effect/platform-bun@rc" "@effect/platform-node@rc"

Create your Stack

Every Alchemy program starts with a Stack — create alchemy.run.ts:

alchemy.run.ts

import * as Alchemy from "alchemy";
import * as Cloudflare from "alchemy/Cloudflare";
import * as Effect from "effect/Effect";

export default Alchemy.Stack(
  "MyApp",
  {
    providers: Cloudflare.providers(),
    state: Cloudflare.state(),
  },
  Effect.gen(function* () {
    const bucket = yield* Cloudflare.R2.Bucket("Bucket");

    return {
      bucketName: bucket.bucketName,
    };
  }),
);

Deploy

Run alchemy deploy to create the Bucket on Cloudflare:

bun

bun alchemy deploy

npm

npx alchemy deploy

pnpm

pnpm alchemy deploy

yarn

yarn alchemy deploy

Connect Cloudflare first with alchemy profile edit --add Cloudflare. Sign in with OAuth in the browser or paste an API token. The credentials are saved to your default profile at ~/.alchemy/profiles.json. No environment variables required. Logging in only ever happens through the profile command; a deploy with nothing configured fails with the exact command to run.

Once you’re authenticated, Alchemy shows a plan, asks for confirmation, and provisions the resource:

Plan: 1 to create
+ Bucket (Cloudflare.R2.Bucket)

Proceed?
◉ Yes ○ No
✓ Bucket (Cloudflare.R2.Bucket) created
{
  bucketName: "myapp-bucket-a1b2c3d4e5",
}

That’s it — you have a live R2 Bucket on Cloudflare.

Full command reference: CLI.

Tip

To re-run the credential prompt later (e.g. to switch from OAuth to an API token), use alchemy profile edit --reconfigure Cloudflare. For a separate profile, run alchemy profile create prod followed by alchemy profile edit --profile prod. See Profiles for the full picture.

Where next

You have a live Stack. What is Alchemy? explains what just happened and the model the rest of the docs build on. The tutorial then builds a full app on Cloudflare, starting from this exact Stack.

What is Alchemy?Infrastructure as Code built in Effect, with Infrastructure as Effects on top.TutorialBuild a full app on Cloudflare starting from this Stack: a Worker, bindings, tests, local dev, CI, and telemetry.Infrastructure as EffectsThe model the rest of the docs build on: Runtimes, Bindings, Layers, and the Construction and Runtime phases.CloudflareWorkers, Durable Objects, R2, KV, D1, Queues, Workflows, and Containers, with a tutorial and a guide for each.AWSLambda, S3, SQS, DynamoDB, EC2, ECS, and EKS, with a tutorial and a guide for each.CLIEvery command and its flags: deploy, plan, destroy, dev, tail, logs, and state.