Getting Started

Prerequisites

• Go 1.25+ (for building from source)
• An LLM API key (OpenAI, Anthropic, DeepSeek, etc.)

Quick Start

Option 1: Download Binary

Download the latest release for your platform from GitHub Releases.

# Linux/macOS
chmod +x yunque-agent-linux-amd64
./yunque-agent-linux-amd64

# Windows
yunque-agent-windows-amd64.exe

Option 2: Docker

# Lite mode (SQLite, no external deps)
docker compose --profile lite up -d

# Full stack (PostgreSQL + pgvector + web UI)
docker compose --profile full up -d

Option 3: Build from Source

git clone https://github.com/LittleXiaYuan/Tori.git
cd yunque-agent
cp .env.example .env  # edit with your LLM_API_KEY
make build
./dist/yunque-agent

Configuration

Create a .env file with at minimum:

LLM_API_KEY=your-api-key-here

The agent will start on port 9090 by default. Visit the dashboard at http://localhost:9090.

What's Next?

• Architecture Overview — Understand the system design
• Configuration Guide — All environment variables
• API Reference — REST API documentation
• Plugin Development — Build custom skills