Build and check a local Project

Create the Project

Run the scaffold command in a directory where you keep source code.

Shell

npm create anyam demo
cd demo
npm install

The command creates a Git repository, an anyam.json manifest, TypeScript source, a test, and a README. The scaffold does not create provider resources or store credentials.

Run the local checks

Run the doctor, compiler, test, and build commands.

Shell

npx create-anyam doctor
npm run typecheck
npm test
npm run build

You should see a passing Project doctor, a successful TypeScript compilation, a passing Node test, and a dist/index.js output file.

Start a Change

Create a stable Change before editing the next feature.

Shell

npx create-anyam change start "Add a health route"
git status

Edit the files with your preferred editor or coding agent. Use ordinary Git for source edits. Use Anyam for Change, Workspace, review, Evidence, Release, and Target operations.

Choose an agent

Configure the agent you already use.

Shell

anyam agent setup codex
anyam agent start codex

# Restricted source
anyam agent exec codex -- codex

Replace codex with claude, cursor, or cli. The agent receives a task-scoped Workspace credential. It cannot write the canonical repository, read secret values, approve its own Change, or promote a production Target.

NextRead the design philosophy ↗Operate a Realm ↗

Build and check a local Project.

Create the Project

Run the local checks

Start a Change

Choose an agent