Skip to content

Quick start

Use the production app

Open Orion production.

The first live load can take several seconds. Lambda may be cold. The API may also open a new CockroachDB connection. Wait until the runtime status is ready.

Use the live production path:

https://d35b4jhpypc315.cloudfront.net/app?mode=live

If the live runtime is temporarily unavailable, use the labeled replay path for a read-only interface review:

https://d35b4jhpypc315.cloudfront.net/app?mode=replay&scenario=baseline

Run the frontend locally

Requirements:

  • Node.js 18 or newer;
  • npm;
  • a complete Orion checkout.

Run:

npm install
npm run dev -- --host 127.0.0.1

Open the local live app:

http://127.0.0.1:5173/app?mode=live

Use 4173 instead of 5173 when another project uses the default Vite port.

Run the backend locally

The backend uses Python 3.11 or newer. From the backend/ directory:

uv sync --extra test --extra live
uv run uvicorn orion_backend.main:app --reload --port 8000

The live frontend needs an API base URL:

VITE_ORION_MODE=live \
VITE_ORION_API_BASE_URL=http://127.0.0.1:8000 \
npm run dev -- --host 127.0.0.1

Do not put provider keys in Vite variables. The browser must never receive CockroachDB, MCP, S3, or OpenRouter credentials.

Build the documentation

Install the documentation tools:

python3 -m pip install -r requirements-docs.txt

Build the strict site:

npm run docs:build

Serve it locally:

mkdocs serve --dev-addr 127.0.0.1:8001

Open http://127.0.0.1:8001/.

Choose the correct mode

Mode Use Data Writes
live Real integration test Backend and external providers Server-side
replay Read-only fallback Checked-in fixture None

Do not call a replay run a live proof.