Quick Start Guide

#Repo is not public for now

Prerequisites

  • Docker: Ensure Docker is installed and running.

  • Python 3.12 or higher: For local development tasks.

  • Poetry: To manage Python dependencies.

  1. Create Project Directory

    bashmkdir sylvi && cd sylvi
  2. Download Docker Compose Config You can adapt existing files from the original reference (1) to rename them for Sylvi:

    bashcurl -O https://raw.githubusercontent.com/username/sylvi/main/docker-compose.yml
    curl -O https://raw.githubusercontent.com/username/sylvi/main/example.env
  3. Set Up Environment

    bashmv example.env .env
    # Edit the .env file as necessary, ensuring keys are set:
    # OPENAI_API_KEY, SYLVI_DB_HOST, etc.
  4. Start Services

    bashdocker compose up

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

  5. Create Your First Agent

    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

    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.

Last updated