AgentsKitOS

Quickstart

Six commands to your first agent.

1. Scaffold

pnpm agentskit-os init

Creates:

  • agentskit-os.config.ts — Zod-validated config (defineConfig helper)
  • workspace.yaml — workspace declaration
  • .agentskitos/ — runtime directory (sqlite, vault, traces)
  • agentskit-os.lock — see RFC-0002

2. Diagnose

pnpm agentskit-os doctor

Reports environment health: Node version, package resolution, optional providers, sandbox runtimes available, lockfile state.

3. Generate from a template

pnpm agentskit-os new pr-review

Picks a starter from @agentskit/os-templates.

4. Run with cost preview

pnpm agentskit-os run pr-review --mode preview --estimate

--mode preview is read-only. --estimate gives a token + dollar projection before any LLM call. See run modes.

5. Lock for reproducibility

pnpm agentskit-os lock

Writes agentskit-os.lock so re-runs on other machines are byte-identical.

6. Ship

pnpm agentskit-os deploy --target docker

Or --target node for a process binary. M5 will add cloud targets via @agentskit/os-marketplace-sdk.

On this page