Getting started

Requirements

• Node.js 24 LTS
• A reachable PostgreSQL database

Create a project

Run the scaffolder with a project name. Add --type to skip the interactive prompt:

npm create weavekit-app my-app -- --type=agent

The command creates ./my-app and, unless --no-git is passed, initializes a Git repository when the directory is not already inside one.

Configure the database

cd my-app
cp .env.example .env

Set DATABASE_URL in .env to your PostgreSQL connection string:

DATABASE_URL=postgres://postgres:postgres@localhost:5432/weavekit

Migrate and run

weave migrate   # compile objects/*/schema.json into PostgreSQL tables
weave dev       # start the engine with hot reload on http://localhost:3000

weave migrate also generates TypeScript types for your objects, and weave dev serves the REST API under /api and the MCP endpoint under /mcp.

Next steps

• CLI and options — every flag the scaffolder accepts
• Generated project — the files that were written
• Engine integration — how the project talks to the engine