Skip to content

quickstart.md

Latest commit

 

History

History
176 lines (137 loc) · 3.36 KB

quickstart.md

File metadata and controls

176 lines (137 loc) · 3.36 KB
Raw

Quick Start Tutorial

Build your first Zouroboros-powered project in 10 minutes

What We'll Build

A simple project that demonstrates:

  1. Memory - Store and retrieve facts
  2. Workflow - Use spec-first development
  3. Swarm - Run a simple multi-agent campaign

Step 1: Initialize Your Project

# Create a new project directory
mkdir my-zouroboros-project
cd my-zouroboros-project

# Initialize Zouroboros
zouroboros init

# Verify setup
zouroboros doctor

Expected output:

✅ Core types loaded
✅ Memory system ready
✅ Workflow tools available
✅ Swarm orchestrator ready
✅ All systems healthy

Step 2: Store Your First Memory

Using Zo chat:

Store this in memory: My favorite programming language is TypeScript

Or using CLI:

zouroboros memory store \
  --entity "user" \
  --key "favorite_language" \
  --value "TypeScript" \
  --decay permanent

Verify it was stored:

zouroboros memory search "favorite language"

Output:

🔍 Search Results (1 found)
━━━━━━━━━━━━━━━━━━━━━
📌 [[user]].favorite_language
   TypeScript
   Category: preference | Decay: permanent

Step 3: Run a Spec-First Interview

Before building anything, clarify requirements:

zouroboros workflow interview \
  --topic "Build a todo list API" \
  --output ./interview-notes.md

This creates an interview transcript that you can review.

Generate a seed specification:

zouroboros workflow interview seed \
  --from ./interview-notes.md \
  --output ./seed.yaml

Step 4: Run a Simple Swarm Campaign

Create a tasks file campaign.json:

{
  "tasks": [
    {
      "id": "1",
      "persona": "Backend Developer",
      "task": "Design the database schema for a todo app",
      "priority": "high"
    },
    {
      "id": "2",
      "persona": "API Developer",
      "task": "Create REST endpoints for CRUD operations",
      "priority": "high",
      "dependsOn": ["1"]
    },
    {
      "id": "3",
      "persona": "Frontend Developer",
      "task": "Build a simple UI for the todo app",
      "priority": "medium",
      "dependsOn": ["2"]
    }
  ]
}

Run the campaign:

zouroboros swarm run \
  --tasks ./campaign.json \
  --output ./results

Step 5: Check System Health

Run a health check on your Zouroboros installation:

zouroboros heal introspect --verbose

This generates a scorecard showing:

  • Memory recall quality
  • Graph connectivity
  • Routing accuracy
  • And more...

What's Next?

Quick Reference

Essential Commands

Command Purpose
zouroboros doctor Check system health
zouroboros memory store Save a fact
zouroboros memory search Find facts
zouroboros workflow interview Run spec-first interview
zouroboros swarm run Execute campaign
zouroboros heal introspect Health scorecard
zouroboros tui Launch dashboard

From Zo Chat

You can use natural language with Zo:

Store in memory that I prefer dark mode

What's my favorite programming language?

Run a spec-first interview for building a blog

Check my Zouroboros health