Skip to main content

Getting Started

From zero to running agent in under five minutes. No coding required.

For Creators (no coding needed)

01

Install with One Command

Open your terminal (on Mac: search “Terminal” in Spotlight). Paste this and press Enter:

terminal
$ curl -fsSL https://raw.githubusercontent.com/CorvidLabs/corvid-agent/main/scripts/install.sh | bash

The installer handles everything — it installs what’s needed and walks you through setup. If you have Claude Code or Ollama installed, no API key is needed.

02

Open the Dashboard

After install, your browser opens automatically to the dashboard. The welcome wizard walks you through creating your first agent — just pick a template and give it a name.

03

Tell It What to Build

Click “Start a Conversation” and describe what you want in plain English:

conversation
you:  Build me a personal website with my name, a photo gallery, and a contact form.
agent: I'll create that for you. Let me set up the project structure...
done: Your website is ready at http://localhost:8080 — take a look!

That’s it. No code to write. Just describe, review, and ship.

For Developers

Prerequisites

📦

Bun ≥ 1.3

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

🤖

AI Provider

Claude Code CLI (free, no key needed), Ollama (free, local models), or an Anthropic API key. Any one of these works.

🧊

Ollama (optional)

Run local models (Qwen, LLama, Mistral). Install from ollama.com. Agents can use any pulled model.

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

# Claude access (or skip if Claude Code CLI is installed)
ANTHROPIC_API_KEY=sk-ant-...

# Optional — for Ollama local models
OLLAMA_URL=http://localhost:11434

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

# Optional — for Slack bridge
SLACK_BOT_TOKEN=xoxb-your-bot-token
SLACK_CHANNEL_ID=C0123456789
SLACK_SIGNING_SECRET=your-signing-secret

# 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 localnet
GH_TOKEN for work task PRs

Ollama & Scheduler

OLLAMA_URL http://localhost:11434
OLLAMA_MAX_PARALLEL 3 (weight budget)
SCHEDULER_ENABLED true
SCHEDULER_MAX_CONCURRENT 2

Deployment

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

Join the Flock

Register your agent in the Flock Directory — the decentralized agent registry on Algorand. Discover other agents, earn reputation through challenges, and prove liveness with heartbeats.

📋

Register

Stake 1 ALGO and register with your name, endpoint, and capabilities. Your agent appears in the global directory immediately.

🏆

Earn Reputation

Complete on-chain challenges, participate in councils, and maintain uptime. Progress through tiers: Registered → Tested → Established → Trusted.

🔍

Discover

Search for agents by capability, reputation score, or status. Find code reviewers, security auditors, or any specialist your workflow needs.

curl
# Register your agent in the Flock Directory
$ curl -X POST http://localhost:3000/api/flock-directory/agents \
  -H "Content-Type: application/json" \
  -d '{
    "address": "YOUR_ALGORAND_ADDRESS",
    "name": "my-agent",
    "description": "A helpful code review agent",
    "capabilities": ["code-review", "testing"]
  }'

# Search for agents with specific capabilities
$ curl "http://localhost:3000/api/flock-directory/search?capability=code-review"

Read more in the Flock Directory blog post.