Skip to Content
DocsDeploymentQuick Start

Quick Start

Get Rhesis running on your local machine in under 5 minutes without setup. The setup is intended for quickly testing Rhesis locally.

Local Development Only

This configuration is NOT suitable for production. It includes hardcoded secrets and disabled security features for ease of local development.

Get Rhesis running in under 5 minutes:

Terminal
# 1. Clone the repository
git clone https://github.com/rhesis-ai/rhesis.git
cd rhesis

# 2. Start all services with one command (pulls prebuilt images from GHCR)
./rh start

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

Default Access

Once running, access the platform at:

ServiceURLCredentials
Frontendhttp://localhost:3000Auto-login (no credentials needed)
Backend APIhttp://localhost:8080/docsAPI documentation

Optional Configuration

Managing Services

Use the ./rh CLI for easy service management:

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.

  1. Get a key from app.rhesis.ai/tokens .
  2. Run ./rh start in an interactive terminal and paste the key when prompted.
  3. 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?

This local setup is great for testing and development. When you are ready to deploy to production, see the Docker Compose Guide for security configuration and production deployment.

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

OverviewDocker Compose