Agents Documentation

✓Fastest path

If you only want a working local setup, run the install command below, then verify the loop by running agents work locally.

The fastest way to start using agents is the one-line installer the dashboard serves at https://agents.creative-int.com/api/install. The dashboard's install page shows the same command.

Install

curl -fsSL https://agents.creative-int.com/api/install | bash

What the installer prepares

Tooling

Checks for Node.js >= 22 and installs Bun if it is missing.

CLI

Installs the published @creative-int/agents-cli CLI globally.

Local agent OS

Initializes the ~/.agents skeleton for rules, skills, hooks, and runtime state.

Detection

Probes for available runtimes like Claude, Codex, Copilot, Gemini, and Pi so the dashboard can reflect the connected environment.

Essential commands

Sync

agents sync pushes local projects, skills, sessions, and traces into the backend.

Work

agents work polls queued dashboard work and executes it on the local machine.

Sessions

agents session start --help is the direct entrypoint for manual session spawning.

Previews

agents preview --help exposes sprite VM preview orchestration and review tooling.

Local repo development

pnpm install
pnpm codegen
pnpm dev:app
pnpm dev:docs

Env source of truth

deploy-time Convex credentials and deploy keys live in Doppler project agents
local dashboard runtime should set NEXT_PUBLIC_CONVEX_URL in apps/app/.env.local
CLI sync/work can use AGENTS_CONVEX_URL or fall back to NEXT_PUBLIC_CONVEX_URL
headless Convex attach/deploy helpers live at the repo root:

pnpm convex:dev:once
pnpm convex:deploy:prd

ℹTwo web surfaces

This monorepo ships the dashboard in apps/app and the docs surface in apps/docs. They should stay independently runnable and independently deployable.

First successful loop

Open the dashboard.
Create a thread or dispatch work from the UI.
Run agents work locally.
Watch the session move from queued to running.
Inspect the resulting transcript, project activity, and traces in the dashboard.

Source of truth

Installer page: apps/app/src/app/install/page.tsx
CLI package metadata: packages/cli/package.json
Work poller: packages/cli/src/cli/commands/work.ts

Getting Started