Quick Start

Get Rhesis running locally in under 5 minutes. This setup is for local testing only.

Local Development Only

This configuration is NOT suitable for production. It uses generated secrets and enables local authentication bypass (QUICK_START=true).

Terminal
git clone https://github.com/rhesis-ai/rhesis.git
cd rhesis

# pulls prebuilt images from GHCR
./rh start

# build backend, worker, and frontend images locally instead:
./rh start --build

Default Access

Once running, access the platform at:

Service	URL	Credentials
Frontend	`http://localhost:3000`	Auto-login (no credentials needed)
Backend API	`http://localhost:8080/docs`	API documentation

Optional Configuration

Managing Services

Use the ./rh CLI to manage services:

Terminal

./rh stop # Stop all services
./rh logs # View logs for all services
./rh restart # Restart all services
./rh delete # Remove all containers, volumes, images, and data (fresh start)
./rh # Display help for all commands

Enable Test Generation

Test generation needs an AI provider. Quick Start can use Rhesis-hosted models, or you can configure your own provider in the platform. ./rh start prompts for a Rhesis API key when one is missing.

Get a key from app.rhesis.ai/tokens .
Run ./rh start in an interactive terminal and paste the key when prompted.
If you skipped the prompt, add it to .env.docker.local:

.env.docker.local
RHESIS_API_KEY=your-actual-rhesis-api-key-here

Changing the ports

The first ./rh start prompts for backend and frontend ports (defaults: 8080, 3000) and writes them to .env.docker.local. To change them later, edit .env.docker.local — the port and the port in its URL must stay in sync (BACKEND_PORT with API_BASE_URL, FRONTEND_PORT with FRONTEND_URL). Then run ./rh restart:

.env.docker.local
BACKEND_PORT=15000
API_BASE_URL=http://localhost:15000
FRONTEND_PORT=16000
FRONTEND_URL=http://localhost:16000

Next Steps

Ready for Production?

For production deployment, see the Docker Compose Guide.

For local development setup without Docker (for contributing to Rhesis), see the Environment Setup Guide.