Skip to content

Setup

Everything you need before deploying to Archil: the packages, an Archil account, and an API key stored in a profile.

Prerequisites

Section titled “Prerequisites”
  • Node.js 24.11.1+ or Bun
  • An Archil account
  • Docker, only to build an Image from a Dockerfile. Programs and public images don’t need it.

Install

Section titled “Install”
Terminal window
pnpm add https://pkg.alchemy.run/alchemy/pr:2930:51c662a https://pkg.alchemy.run/@alchemy.run/archil/pr:2930:51c662a effect @effect/platform-bun @effect/platform-node

Add the provider

Section titled “Add the provider”

Add Archil.providers() next to your other providers:

alchemy.run.ts
import * as Alchemy from "alchemy";
import * as Archil from "@alchemy.run/archil";
import * as Effect from "effect/Effect";


export default Alchemy.Stack(
  "MyApp",
  { providers: Archil.providers(), state: Alchemy.localState() },
  Effect.gen(function* () {
    // your resources
  }),
);

With a second cloud, merge them: Layer.mergeAll(Cloudflare.providers(), Archil.providers()).

Create an API key

Section titled “Create an API key”

Sign in at console.archil.com, select the account or organization you deploy to, and create a key under API Keys. It starts with key-. Archil shows it once.

Store it in a profile

Section titled “Store it in a profile”
Terminal window
alchemy profile edit --add Archil

Paste the key, and pick the region your disks live in (aws-us-east-1 by default). Enter your organization id only if you keep disks on your own S3 bucket.

In CI

Section titled “In CI”

Set the key in the environment. It takes precedence over any profile:

Terminal window
ARCHIL_API_KEY=key-... ARCHIL_REGION=aws-us-east-1 alchemy deploy

See Organization and keys for profiles per environment and what each host gets instead of your key.