Cumulus
Create a Cumulus app.
Run one command. Choose the parts. Get a ready app.
- Auth, data, and Knowledge.
- Hosted or self-hosted Relay.
- Cloud, local, or both Cumulus DB.
What it does
One command builds the app shape you choose.
Cumulus asks for a few choices, then writes the app files, examples, and scripts for that shape.
The generated app starts from your selected template.
The dashboard builds the exact command when you do not want to remember every flag.
Templates
Pick how much app you want.
Start small or generate the full Relay surface. Legacy aliases still work: marketing maps to outer, and inside maps to inner.
| Template | Includes |
|---|---|
| full | Public site, /me, /dev, dashboards, API/MCP, docs, auth, signup, and actions. |
| outer | Public site, docs, discovery, signup, and action start. |
| inner | /me, /dev, settings, API/MCP, auth, and actions. |
| agent-auth | Smallest starter for discovery, attestation login, signup, and actions. |
Agent Auth Modes
Choose who runs Relay auth.
Hosted is the simplest path. Self-hosted gives the generated app its own Relay API and MCP surface.
| Mode | Use when |
|---|---|
| hosted | Relay runs auth, signup, and actions. |
| self-hosted | The generated app runs its own Relay API and MCP surface. |
Cumulus DB
Choose where workspace data lives.
Relay Postgres stores users, sessions, tenants, signup jobs, and API keys. Cumulus DB stores agent workspace records, key-value data, secrets, and search data.
| Mode | Meaning |
|---|---|
| cloud | Use hosted Cumulus DB through Relay and Cumulus Cloud. |
| local | Add the local Cumulus DB service. |
| both | Add the local service and keep the hosted path in examples. |
Defaults
The defaults are made for a fast start.
Full, inner, and agent-auth default to both Cumulus DB paths. Outer defaults to cloud. Missing non-interactive flags default to full, hosted, npm, no install, and no git init.
--with auth,db,knowledge is the default. It prepares user intent, agent signup, app start, Knowledge, and Cumulus DB progress writes.
The project name is optional. When it is omitted, the command asks for it. With --company "Acme Inc", the folder and package name come from the company.
Hosted mode writes the Relay discovery, login, signup, action, and env examples needed to connect to Relay.
Full and inner include local Relay app and server parts because the dashboards need Relay database, session, and server modules.
Flags
Use flags when you know the choices.
The same choices from the dashboard can be passed directly in the terminal.
Local Cumulus DB
Local DB projects include scripts and env examples.
Use local mode for self-hosting, demos, and private development. Use a persistent disk for the data directory in production.
Examples
Copy the exact command you need.
Use the dashboard to build your command, or start from one of these examples.
This shorthand and @cmls/create download the same package and run the same create binary after it has been published.