Getting Started

This page is the fastest path from zero to a working Codemation app.

Fastest path

pnpm create codemation <project-name>
cd <project-name>
pnpm dev

That starts the framework-owned UI and the runtime behind it. To change workflows, credentials, database mode, or other wiring, edit <project-name>/codemation.config.ts with defineCodemationApp(...).

Other scaffolds

You can also use:

npm create codemation@latest my-app
yarn create codemation

First-time setup (when you need it)

Some templates walk you through migrations and a first user interactively. If yours does not, run these inside the project:

pnpm install
pnpm exec codemation db migrate
pnpm exec codemation user create --email you@example.com --password 'your-secure-password'
pnpm dev

What the starter gives you

The generated project already includes:

• codemation.config.ts
• a src/workflows directory with a fluent workflow("...") example
• a sample workflow
• local auth defaults for development
• a local SQLite database for zero-setup development
• a pnpm dev workflow that runs codemation dev
• @codemation/* dependencies use 0.0.x for most packages and 0.1.x for @codemation/host, so pnpm upgrade can pull compatible pre-1.0 releases without editing package.json by hand

The smallest mental model

At the beginning, you only need to understand four things:

1. codemation.config.ts composes your app with defineCodemationApp(...)
2. src/workflows contains workflow definitions built with workflow("...")
3. nodes move data through a workflow graph
4. the runtime gives you persistence, credentials, APIs, and the operator UI

Recommended next pages

1. Concepts
2. Configuration
3. Architecture
4. Deployment
5. Manual Trigger node