Agents Documentation

✓Fastest path

If you only want a working local setup, start with the install script from the dashboard, then verify the loop by running agents work locally.

The fastest way to start using agents is the install flow exposed by the dashboard.

Install

curl -fsSL https://agents.sh/api/install | bash

What the installer prepares

Tooling

Checks for Node.js >= 20 and pnpm before continuing.

Repo + CLI

Clones the repo to ~/.agents-app, installs dependencies, and links the CLI globally.

Local agent OS

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

First sync

Pushes enough local state to Convex for the dashboard to render real projects, skills, and sessions.

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

ℹ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