Quick Start Guide

#REPO is closed source for now

Prerequisites

• Docker: Ensure Docker is installed and running.

• Python 3.12 or higher: For local development tasks.

• Poetry: To manage Python dependencies.

Docker Setup (Recommended)

1. Create Project Directory

   Copy

   bashmkdir zyro && cd zyro

2. Download Docker Compose Config You can adapt existing files from the original reference (1) to rename them for Zyro:

   Copy

   bashcurl -O https://raw.githubusercontent.com/username/zyro/main/docker-compose.yml
   curl -O https://raw.githubusercontent.com/username/zyro/main/example.env

3. Set Up Environment

   Copy

   bashmv example.env .env
   # Edit the .env file as necessary, ensuring keys are set:
   # OPENAI_API_KEY, ZYRO_DB_HOST, etc.

4. Start Services

   Copy

   bashdocker compose up

   This command starts multiple containers (database, API server, scheduler, etc.).

5. Create Your First Agent

   Copy

   bashcurl -X POST http://127.0.0.1:8000/agents \
     -H "Content-Type: application/json" \
     -d '{
       "id": "admin",
       "name": "Admin",
       "prompt": "You are an autonomous agent. Respond to user queries."
     }'

6. Test Agent Interactions

   Copy

   bashcurl "http://127.0.0.1:8000/agents/admin/chat?q=Hello"

   Or open your browser at http://127.0.0.1:8000/agents/admin/chat?q=Hello.