Getting Started

From zero to running agent in under five minutes.

Prerequisites

📦

Bun ≥ 1.1

The runtime, package manager, and test runner. Install from bun.sh.

🤖

Anthropic API Key

Required for the Claude Agent SDK. Get one at console.anthropic.com.

AlgoKit (optional)

Only needed for on-chain AlgoChat messaging. Without it, everything still works — chat via the web UI, agents run sessions, councils deliberate. Install via pipx install algokit if you want Localnet or Testnet messaging.

Installation

01

Clone & Install

terminal
$ git clone https://github.com/CorvidLabs/corvid-agent.git
$ cd corvid-agent
$ bun install
02

Configure Environment

terminal
$ cp .env.example .env

# Required
ANTHROPIC_API_KEY=sk-ant-...

# Optional — for AlgoChat messaging
ALGOCHAT_MNEMONIC=your twenty five word mnemonic ...
ALGORAND_NETWORK=testnet

# Optional — for work tasks
GH_TOKEN=ghp_...
03

Start the Server

terminal
$ bun dev          # API server on :3000
$ bun dev:client   # Angular UI on :4200 (optional)

The API server serves both the REST API and the Angular client in production builds.

First Steps

04

Create a Project

curl
$ curl -X POST http://localhost:3000/api/projects \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-project",
    "workingDir": "/path/to/your/repo"
  }'
05

Create an Agent

curl
$ curl -X POST http://localhost:3000/api/agents \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-agent",
    "systemPrompt": "You are a helpful coding assistant.",
    "model": "sonnet"
  }'
06

Start a Session

curl
# Create session
$ curl -X POST http://localhost:3000/api/sessions \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": 1,
    "agentId": 1,
    "prompt": "Hello! What can you help me with?"
  }'

# Or use the Angular UI at http://localhost:4200

Configuration

Server

PORT 3000
BIND_HOST 127.0.0.1
API_KEY required if BIND_HOST ≠ 127.0.0.1
LOG_LEVEL info

AI & Blockchain

ANTHROPIC_API_KEY required
ALGOCHAT_MNEMONIC 25-word Algorand mnemonic
ALGORAND_NETWORK testnet
GH_TOKEN for work task PRs

Limits

AGENT_TIMEOUT_MS 1800000 (30 min)
DAILY_ALGO_LIMIT_MICRO 10000000 (10 ALGO)
WORK_MAX_ITERATIONS 3

Deployment

Docker docker compose up -d
systemd ./deploy/daemon.sh install
launchd macOS plist in deploy/
Reverse Proxy Caddy or nginx configs provided

What’s Next