Get Running in 5 Minutes

Goal: get your first successful run quickly and verify the MVP runtime path.

1. Prerequisites

• Node.js >=18.18.0
• pnpm >=10.33.0

node -v
pnpm -v

2. Install

pnpm install

3. Run the minimal example

This example uses a mock provider and does not require external API keys.

pnpm --filter @colony-harness/example-basic-agent dev

Expected output includes:

• loop iterations and tool invocation logs
• Final output:
• a computed result (1+2+3 in the sample)

4. Verify memory flow

pnpm --filter @colony-harness/example-memory-agent dev

To run the same demo with SQLite persistence:

MEMORY_BACKEND=sqlite pnpm --filter @colony-harness/example-memory-agent dev

5. Next

• Full example run guide: Running the Examples
• Provider/env setup: Environment Variables
• Runtime internals: Runtime Lifecycle
• Security model: Guardrails & Tool Security
• Error handling: Troubleshooting