Installation
This guide covers the two main ways to run Sibyl:
- install the published CLI and run a local instance with
sibyl local ... - work on the monorepo in development mode with
moon run ...
Prerequisites
Sibyl requires the following:
- Python 3.13+ - Core backend language
- Node.js 22+ - For the web frontend
- FalkorDB - Graph database (runs on port 6380)
- PostgreSQL - Relational storage for users and documents
- OpenAI API Key - For generating embeddings
Version Management
We recommend using proto for managing tool versions:
# Install proto
curl -fsSL https://moonrepo.dev/install/proto.sh | bash
# Proto will automatically use correct versions from .prototoolsQuick Install
Published CLI
The fastest way to run Sibyl locally:
# Install the published CLI
uv tool install sibyl-dev
# Start local services
sibyl local start
# Install Claude/Codex skills and hooks
sibyl local setupMonorepo Development
# Clone the repository
git clone https://github.com/hyperb1iss/sibyl.git
cd sibyl
# Bootstrap toolchain and dependencies
./setup-dev.shOr manually:
curl -fsSL https://moonrepo.dev/install/proto.sh | bash
proto use
proto install moon
uv sync --all-groups
pnpm install
# Optional: install repo-local CLI entrypoints into your user tool path
moon run cli:install-dev
moon run api:install-devInfrastructure Setup
Start FalkorDB
# Start repo development infrastructure
moon run docker-upPort 6380 FalkorDB runs on port 6380 (not 6379) to avoid conflicts with a standard
Redis installation. :::
PostgreSQL Setup
# Migrations run automatically during moon run dev,
# but you can also run them directly when needed
moon run api:db-migrateConfiguration
Environment Variables
Create a .env file from the repo root example:
cp .env.example .envEdit the file with your configuration:
# Required
SIBYL_OPENAI_API_KEY=sk-... # For embeddings
SIBYL_JWT_SECRET=your-secret-key # For authentication
# FalkorDB
SIBYL_FALKORDB_HOST=localhost
SIBYL_FALKORDB_PORT=6380
SIBYL_FALKORDB_PASSWORD=conventions
# PostgreSQL
SIBYL_DATABASE_URL=postgresql+asyncpg://sibyl:sibyl@localhost:5432/sibyl
# Optional
SIBYL_LOG_LEVEL=INFO
SIBYL_EMBEDDING_MODEL=text-embedding-3-small
SIBYL_ANTHROPIC_API_KEY=... # For LLM operationsRequired Environment Variables
| Variable | Description |
|---|---|
SIBYL_OPENAI_API_KEY | OpenAI API key for generating embeddings |
SIBYL_JWT_SECRET | Secret key for JWT token signing |
Optional Environment Variables
| Variable | Default | Description |
|---|---|---|
SIBYL_FALKORDB_HOST | localhost | FalkorDB hostname |
SIBYL_FALKORDB_PORT | 6380 | FalkorDB port |
SIBYL_DATABASE_URL | - | PostgreSQL connection string |
SIBYL_LOG_LEVEL | INFO | Logging level |
SIBYL_EMBEDDING_MODEL | text-embedding-3-small | OpenAI embedding model |
SIBYL_SERVER_URL | - | Public server URL (for OAuth callbacks) |
SIBYL_FRONTEND_URL | - | Frontend URL (for redirects) |
Running Sibyl
Local CLI Mode
Run the published CLI's local stack:
sibyl local start
sibyl local status
sibyl local logsDevelopment Mode
Start all repo services with a single command:
moon run devThis starts:
- API server on port 3334
- Background worker for async jobs
- Web frontend on port 3337
Individual Services
# API server only
moon run dev-api
# Web frontend only
moon run dev-web
# Background worker
moon run api:workerDirect Commands
# Start the API server
moon run api:serve
# Start in stdio mode (for MCP subprocess)
cd apps/api
uv run sibyld serve -t stdioVerify Installation
Check Server Health
# If you installed the published CLI
sibyl local status
sibyl local setup --status
# Basic health check
curl http://localhost:3334/api/health
sibyl health
sibyl versionAccess Web UI
Open http://localhost:3337 in your browser.
Ports Reference
| Service | Port |
|---|---|
| API + MCP | 3334 |
| Web Frontend | 3337 |
| FalkorDB | 6380 |
| PostgreSQL | 5432 |
Troubleshooting
FalkorDB Connection Failed
# Check if FalkorDB is running
docker ps | grep falkordb
# Check the port
redis-cli -p 6380 pingGraph Corruption
If you encounter graph corruption errors:
# Nuclear option: delete the graph
redis-cli -p 6380
> GRAPH.DELETE <org-uuid>Database Migration Errors
# Reset and re-run migrations
cd apps/api
uv run alembic downgrade base
uv run alembic upgrade headOpenAI API Errors
Ensure your API key is set and has credits:
echo $SIBYL_OPENAI_API_KEYDocker Deployment
A production Docker Compose configuration is planned. For now, use the individual Docker commands above.
Legacy Runtime Notes
Sibyl's current product surface centers on the knowledge graph, tasks, search, and source ingestion. If you are evaluating Sibyl today, you can ignore older experimental internal-runtime material.
Next Steps
- Quick Start - 5-minute tutorial
- MCP Configuration - Configure Claude Code integration
