About caffeine-app
caffeine-app is a skill that guides agents through building a Caffeine full-stack app from scratch, covering project structure, manifests, and the CLI build loop. It is for projects with a Motoko backend and React/Vite frontend; Motoko language details are handled by the `writing-motoko` skill.
Key features
- 01Set up the Caffeine project structure
- 02Configure workspace and canister manifests
- 03Explain Motoko backend and frontend binding
- 04Guide the caffeine CLI build loop
- 05Cover stable-state checks and migration setup
Use cases
- 01Create a Caffeine app from scratch
- 02Fix `caffeine.toml` or `mops.toml`
- 03Run `caffeine` checks and preview builds
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ dfinity/ icskills --skill caffeine-appAfter installing, type/caffeine-appin Claude Code to confirm it loaded.
Bundled filesreferences/frontend-template.md
Details
From the project READMECaffeine App (build from scratch)
Caffeine (caffeine.ai) builds and hosts full-stack apps on the Internet Computer: a single Motoko backend canister plus a React/Vite frontend served as an assets canister. This skill teaches the exact project shape and the CLI build loop so you can produce a buildable Caffeine app from nothing.
This skill owns the project shape and the build workflow. It does NOT own the Motoko
language. Before you write or edit any backend code, fetch and follow the writing-motoko
skill: https://skills.internetcomputer.org/skills/writing-motoko/SKILL.md. That skill is
authoritative for actor syntax, stable state, mo:core, and compiler errors. This
skill only shows the minimal empty actor and where it lives.
When to use this skill
- Creating/scaffolding a new Caffeine app or caffeine.ai project from scratch.
- Writing or fixing
caffeine.toml(workspace or canister manifest) ormops.toml. - Running the caffeine CLI loop:
auth login,doctor,install,check,preview.
Do not use it for Motoko language details (use writing-motoko) or for raw IC/dfx/icp
deployment (use icp-cli). Caffeine apps are built and deployed through the caffeine
CLI and the caffeine.ai web app, not through dfx.
Critical facts
- There is no
caffeine init/caffeine new. "From scratch" means you create the files in this skill by hand, then run the build loop. (caffeine projects clone <id>only downloads an existing cloud project — it is not a greenfield scaffold.) - Exactly one backend canister, and it must be named
backend.mops.tomldeclares a single[canisters.backend]. - The frontend↔backend binding files are generated, never hand-written.
src/frontend/src/backend.tsandsrc/frontend/src/declarations/are produced bycaffeine-bindgenduring the build. Editing them is pointless — they are overwritten. - Deploying to a live URL is done in the caffeine.ai web app, not the CLI. The CLI
takes you as far as a built draft (
caffeine preview --build, which needs a cloudproject.id— see the build loop). There is nocaffeine deploy/publishcommand.
Prerequisites (run once)
# Install the CLI (public npm package). The binary is `caffeine`.
npm install -g @caffeineai/cli
# Authenticate against caffeine.ai (opens a browser; use --device on headless hosts).
caffeine auth login
caffeine auth status
# Check the environment: Node, pnpm, mops, caffeine-bindgen, that you are logged in,
# and that the Caffeine API is reachable (installs/repairs what it can).
caffeine doctor --fix
If a global install is undesirable or fails, run every caffeine command through an
npx -y @caffeineai/cli@latest prefix instead — e.g. npx -y @caffeineai/cli@latest auth status.
caffeine doctor --fix checks Node.js, pnpm, mops, and caffeine-bindgen, confirms you
are logged in, and verifies the Caffeine API is reachable — installing or repairing what
it can. It does not install the Motoko compiler (moc) or linter (lintoko): mops
fetches those automatically from the [toolchain] pins in mops.toml on the first
mops install / build. dfx is not part of the Caffeine build.
Project shape
A Caffeine app is a pnpm workspace with a root manifest and two canisters. Create this exact tree (file contents below):
my-app/
├── .old/src/backend/dist/
│ └── backend.most # stable-signature baseline — seed with an empty actor (see below)
├── caffeine.toml # root workspace manifest — MUST contain [workspace]
├── mops.toml # Motoko build config — ONE per project, at the root
├── package.json # pnpm workspace root + the `bindgen` script
├── pnpm-workspace.yaml # declares src/**/* as workspace packages
├── tsconfig.json # root TS config
└── src/
├── backend/ # the single Motoko canister, named "backend"
│ ├── caffeine.toml # canister manifest: type = "motoko"
│ ├── main.mo # actor entry point (write with the `writing-motoko` skill)
│ └── migrations/ # enhanced-migration chain (see the `mops.toml` notes)
│ └── 00000000.mo # the no-op first migration
└── frontend/ # the assets canister (React + Vite)
├── caffeine.toml # canister manifest: type = "assets"
├── package.json # frontend deps + scripts (see references/frontend-template.md)
├── vite.config.js # (see references/frontend-template.md)
├── tsconfig.json # (see references/frontend-template.md)
├── biome.json # (see references/frontend-template.md)
├── tailwind.config.js # (see references/frontend-template.md)
├── postcss.config.js # (see references/frontend-template.md)
├── index.html
├── env.json # runtime config — copied into dist/ on build
└── src/
├── main.tsx # React entry (providers)
├── App.tsx
├── index.css
├── backend.ts # GENERATED by caffeine-bindgen — do NOT edit
└── declarations/ # GENERATED by caffeine-bindgen — do NOT edit
Only the root manifest, the two canister manifests, mops.toml, main.mo, and
the small root config files are shown inline below. The full frontend boilerplate
(package.json, vite.config.js, the Tailwind/PostCSS/Biome configs, index.html,
env.json, main.tsx, a starter App.tsx) is in
references/frontend-template.md — read it when you
create the frontend.
Manifests
Root caffeine.toml — the workspace
The root manifest must contain a [workspace] section. That section is what marks
it as the workspace root; without it, the CLI treats this file as an ordinary canister
manifest and discovery fails.
manifest_version = "0.1.0"
[project]
name = "My App"
# id is assigned by the cloud after your first `caffeine preview`/create — omit it for
# a brand-new local project; the CLI fills it in.
[workspace]
include = [ "src/**" ]
# Build the backend before the frontend, because the frontend imports generated
# bindings produced from the backend's Candid interface.
[canisters.frontend]
depends_on = [ "backend" ]
[workspace].include is a list of globs the CLI scans for nested canister manifests.
src/** finds src/backend/caffeine.toml and src/frontend/caffeine.toml.
src/backend/caffeine.toml — the Motoko canister
manifest_version = "0.1.0"
[project]
name = "backend"
type = "motoko"
main = "main.mo"
[build]
commands = ["mops build", "pnpm bindgen"]
out = "dist"
[check]
commands = ["mops check"]
[check.fix]
commands = ["mops check --fix"]
[build].commands run in order: mops build compiles main.mo to Wasm + Candid, then
pnpm bindgen (defined in the root package.json) turns that Candid into the frontend's
TypeScript client. caffeine check --fix runs [check.fix].commands.
src/frontend/caffeine.toml — the assets canister
manifest_version = "0.1.0"
[project]
name = "frontend"
type = "assets"
[build]
commands = ["pnpm build"]
out = "dist"
[check]
commands = ["pnpm typecheck", "pnpm check"]
[check.fix]
commands = ["pnpm typecheck", "pnpm fix"]
mops.toml — the Motoko build (one per project, at the root)
There is exactly one [canisters.backend]. caffeine preview checks only the
structural pieces, which are invariant: the single [canisters.backend],
[canisters.backend.check-stable] with the path shown and no skipIfMissing, and
[build] outputDir = "src/backend/dist". Everything else — the toolchain versions, the
[moc] flags and -E/-W/-A diagnostic codes, and the dependency list — is a current
snapshot that the Caffeine template bumps over time; see "Versions and dependencies
drift" below.
[package]
name = "backend"
version = "0.1.0"
[build]
outputDir = "src/backend/dist"
args = ["--release"]
check-wasm = true
[canisters.backend]
main = "src/backend/main.mo"
[canisters.backend.check-stable]
path = ".old/src/backend/dist/backend.most"
[toolchain]
moc = "2.0.0"
lintoko = "0.12.0"
[lint]
extends = true
[moc]
args = [
"--implicit-package=core",
"-no-check-ir",
"-E=M0254",
"-W=M0235,M0223,M0236,M0237",
"-A=M0241"
]
[dependencies]
core = "2.6.1"
ic = "4.2.0"
caffeineai-lints = "0.1.0"
caffeineai-oql = "0.8.0"
[canisters.backend.migrations]
chain = "src/backend/migrations"
check-limit = 1
Notes:
-
New projects use moc 2. Under moc 2 a bare
actoris persistent, and thepersistentkeyword only triggers warning M0217. Older guides add--default-persistent-actorsor--generate-view-queriesto[moc] args: those are moc 1.x flags that moc 2.0 removed, and passing them fails every compile withunknown option. Projects cloned from before the switch may still pin moc 1.x and keep--default-persistent-actors; leave such a project on its pinned version. -
check-stablepoints at.old/src/backend/dist/backend.most, the stable-signature snapshot of the last deployed backend.caffeine checkcompares your stable state against it, andcaffeine projects clonerestores it from the cloud. Do not delete.old/. A from-scratch project must seed it with an empty actor, as the Caffeine template does, orcaffeine checkfails withDeployed file not found: .old/src/backend/dist/backend.most:// Version: 1.0.0 actor {};Do not set
skipIfMissing = trueinstead: mops deprecated it, andcaffeine previewrejects it because a skipped check only fails later, at deploy. -
[canisters.backend.migrations]turns on enhanced migration: every.mofile insrc/backend/migrations/, in name order, is one step that maps the previous stable state to the next. A new project starts with the no-op00000000.mo, which sorts before theYYYYMMDD_HHMMSS.mofiles thewriting-motokoskill writes:module { public type OldActor = {}; public type NewActor = {}; public func migration(_ : OldActor) : NewActor { {}; }; };Never edit or delete a migration after it is deployed.
-
coreis themo:corestandard library. Usemo:core, never the deprecatedmo:base— see thewriting-motokoskill.caffeineai-oqlprovides theExposemixin the startingmain.moincludes (below). -
icprovides the IC management canister's types and calls (mo:ic/Types,mo:ic/Call). Use it instead ofimport ... "ic:aaaaa-aa", which only resolves with an--actor-idldirectory of.didfiles that Caffeine projects no longer have.
Versions and dependencies drift. The
[toolchain]versions, the[moc]-E/-W/-Acodes, and the frontend dependency set are template-managed and change over time (e.g. the@dfinity/*→@icp-sdk/*migration, moc/core bumps). Treat the exact values here as a snapshot — for current ones,caffeine projects clonea recent project and copy itsmops.toml+src/frontend/package.json. Stable across versions: the file layout, the singlebackendcanister,check-stablewith the seeded baseline,[build] outputDir,mo:core, anduseActor(createActor).
package.json (root) — pnpm workspace + the bindgen script
The bindgen script is the bridge from backend Candid to the frontend TS client. It is
invoked by the backend canister's [build] step (pnpm bindgen).
{
"name": "@caffeine/template-app",
"type": "module",
"engines": {
"node": ">=18.17.0",
"pnpm": ">=7.0.0",
"npm": "please use pnpm"
},
"scripts": {
"build": "pnpm -r --if-present run build",
"typecheck": "pnpm -r --if-present run typecheck",
"check": "pnpm -r --if-present run check",
"fix": "pnpm -r --if-present run fix",
"bindgen": "caffeine-bindgen --did-file ./src/backend/dist/backend.did --out-dir ./src/frontend/src --actor-interface-file --force"
},
"devDependencies": {
"sharp": "^0.34.4"
}
}
pnpm-workspace.yaml
packages:
- src/**/*
onlyBuiltDependencies:
- esbuild
tsconfig.json (root)
{
"compilerOptions": {
"strict": true,
"target": "ES2020",
"experimentalDecorators": true,
"strictPropertyInitialization": false,
"moduleResolution": "node",
"allowJs": true,
"outDir": "HACK_BECAUSE_OF_ALLOW_JS"
}
}
src/backend/main.mo — the starting backend
The canonical template's starting main.mo includes the Expose mixin from
caffeineai-oql, which publishes the backend's query interface. The actor has no stable
state yet, which is why the first migration maps {} to {}. Add your own functions
inside the actor, following the writing-motoko skill.
import Expose "mo:caffeineai-oql/Expose";
actor {
include Expose({ entities = [] });
};
Do not write more Motoko than this without loading
the writing-motoko skill — it covers persistent actors, stable types, mo:core, and the
compiler-error pitfalls that an agent will otherwise hallucinate.
The frontend
Fetch this skill's companion reference file —
references/frontend-template.md, which sits next to
this SKILL.md (i.e. …/skills/caffeine-app/references/frontend-template.md) — and create
the frontend files from it; it holds the verified package.json, the Vite/Tailwind/Biome
configs, main.tsx, and the worked useActor(createActor) backend call. The essentials:
- The entry point
src/frontend/src/main.tsxwraps the app inInternetIdentityProvider(from@caffeineai/core-infrastructure) and a TanStackQueryClientProvider. - The frontend talks to the backend through the generated module
src/frontend/src/backend.ts(andsrc/frontend/src/declarations/), which exports acreateActor(...)factory typed from your backend's Candid. You do not write these — they appear after the first build. Call the backend by passing thatcreateActortouseActor(createActor)from@caffeineai/core-infrastructure(the same package provides the auth provider used inmain.tsx); you do not hand-write the actor/config/storage glue. See the worked example inreferences/frontend-template.md. env.jsonholds runtime config placeholders (backend_host,backend_canister_id,project_id,ii_derivation_origin,storage_gateway_url), all"undefined"locally; the frontendbuildscript copies it intodist/(cp env.json dist/). Caffeine injects real values when it serves the app. Keepenv.jsonand thecopy:envstep.
The build loop
Run from the project root. Order matters.
# 1. Install dependencies. On a brand-new project, generate the pnpm lockfile FIRST
# (first run only — see Common Pitfalls), then install the rest (pnpm + mops).
pnpm install
caffeine install
# 2. Write your backend in src/backend/main.mo using the `writing-motoko` skill, and your
# frontend in src/frontend/src/.
# 3. Build: compiles the backend, then `pnpm bindgen` regenerates the frontend client
# (src/frontend/src/backend.ts + declarations/), then the frontend `pnpm build` runs.
# Run this BEFORE check, so the frontend has the generated ./backend to typecheck
# against. Artifacts land in src/backend/dist + src/frontend/dist (no cloud / no id).
caffeine build
# 4. Lint + typecheck + auto-fix (runs each canister's [check.fix] commands:
# backend `mops check --fix`, frontend `pnpm typecheck` + `pnpm fix`).
caffeine check --fix
# 5. Upload a built draft (needs a cloud project id). For a brand-new app, create the
# cloud project once to obtain an id, then preview:
caffeine projects create # reports a new project id
# put that id in caffeine.toml [project] id = "...", OR pass --project-id:
caffeine preview --build --project-id <id>
Set CAFFEINE_VERBOSE=1 to stream complete subprocess output from caffeine install,
caffeine build, and caffeine check. This is equivalent to passing --verbose to
each command. --json continues to suppress streamed output.
Generation ordering. src/frontend/src/backend.ts does not exist until a build runs
pnpm bindgen. So if your frontend imports from ./backend, you must run caffeine build
at least once before caffeine check can typecheck the frontend. A brand-new app whose
App.tsx does not yet import ./backend typechecks fine before the first build.
Going live. caffeine preview --build (with a project.id) produces a draft and
returns its URL. Promote a draft to a live URL in the caffeine.ai web app (open it with
caffeine chat open or visit caffeine.ai). There is no CLI deploy command. Use
caffeine projects show <id> to see draft and live URLs, including a ready custom domain when one is assigned.
Alternative: let Caffeine's own AI build it
If you cannot run the CLI locally (no shell, no toolchain), drive Caffeine's hosted AI
instead: describe the app in natural language with caffeine chat send "<prompt>" (or
the caffeine.ai web chat). Caffeine's hosted AI then scaffolds, builds, and deploys it
server-side — chat send only submits the prompt, so this does not contradict the CLI
having no deploy command. This skill is for the local, hand-authored path.
Common Pitfalls
- Missing
[workspace]in the rootcaffeine.toml. Without it the root file is parsed as a canister manifest and the CLI cannot find your canisters. The root manifest is defined by the presence of[workspace], not by being at the top. - Renaming the backend canister. It must be
backend—mops.tomldeclares[canisters.backend]and the rootbindgenscript reads./src/backend/dist/backend.did. Renaming breaks the build and the generated client. - Hand-writing or editing
src/frontend/src/backend.tsordeclarations/. These are generated bycaffeine-bindgenand overwritten on every build. Add backend methods inmain.mo, rebuild, and the client regenerates. The generated header says "do NOT make any changes in this file"; it is also excluded from Biome. - Importing
./backendbefore the first build. The binding module is created by the build'spnpm bindgenstep. Runcaffeine preview --build(orcaffeine build) once before relying onimport { createActor } from "./backend". - Trying to
dfx deployor expectingcaffeine deploy. Caffeine apps build via thecaffeineCLI and go live via the web app. There is nodfxin the workflow and no CLI deploy/publish command. - Dropping required
mops.tomlsettings. Keep the single[canisters.backend],[canisters.backend.check-stable],[build] outputDir, and a[toolchain] mocpin (mops cannot compile without one). - Deleting
.old/orenv.json, or skippingcopy:env..old/holds the stable-signature snapshotcheck-stablecompares against;env.jsonmust be copied intodist/so the served frontend can read its runtime config. - Writing Motoko without the
writing-motokoskill. Modern Caffeine Motoko usesmo:core, persistent actors, and specific patterns. Guessing produces compiler errors. Load https://skills.internetcomputer.org/skills/writing-motoko/SKILL.md first. - Using
npm/yarninstead ofpnpm. The workspace is pnpm-based (pnpm-workspace.yaml,pnpm -rscripts).caffeine installuses pnpm + mops. caffeine install/buildfails withERR_PNPM_NO_LOCKFILEon a fresh project. In a non-interactive shell (an agent, CI, or any run without a TTY) these commands runpnpm install --frozen-lockfile, which requires apnpm-lock.yamlthat a brand-new project does not have. Runpnpm installonce first to generate the lockfile, then the loop works. (An interactive terminal creates it for you.)- First
caffeine checkfails withDeployed file not found: …/backend.most. The stable-signature check needs the last deployed snapshot, which a never-deployed project lacks. Seed.old/src/backend/dist/backend.mostwith an empty actor (shown under themops.tomlabove).caffeine builddoes not create it. caffeine preview --buildfails withNo project.id in caffeine.toml. Uploading a draft needs a cloud project. Runcaffeine projects createto get an id, set it in[project] id(or pass--project-id <id>), then preview.caffeine buildalone needs no id and is enough to verify the app compiles.
Related skills
writing-motoko— REQUIRED companion. Authoritative for all backend Motoko code: https://skills.internetcomputer.org/skills/writing-motoko/SKILL.md. Always load it before editingsrc/backend/main.mo.icp-cli— for raw Internet Computer /dfx/icpprojects. Not used by Caffeine; reach for it only when the user is not building a Caffeine app.
Additional references
references/frontend-template.md— the full, verbatim frontend boilerplate (package.json,vite.config.js, Tailwind/PostCSS/Biome configs,tsconfig.json,index.html,env.json,main.tsx, a starterApp.tsx, and the backend-actor wiring pattern). Read it when you createsrc/frontend/.