Skip to main content

Quickstart

Get TRADEOS.tech running locally in paper trading mode in under 10 minutes.

Prerequisites​

  • Docker Desktop (or Docker Engine + Compose v2)
  • 16 GB RAM recommended (8 GB minimum)
  • macOS, Linux, or WSL2 on Windows

1. Open the checkout and configure​

cd /path/to/your/tradeos/tradeos-main
cp .env.example .env

Open .env and set at minimum:

PAPER_SEED_BALANCE=100000.0   # Starting paper balance in USD
PAPER_TRADING=true             # Keep true for paper mode
POSTGRES_PASSWORD=CHANGE_ME_POSTGRES_PASSWORD
DATABASE_URL=postgresql://tradeos:CHANGE_ME_POSTGRES_PASSWORD@postgres:5432/tradeos

2. Start the stack​

docker compose up -d

This starts all core services. First run takes 3-5 minutes to build images. Subsequent starts take ~30 seconds.

Monitor startup:

docker compose logs -f --tail=50

Wait until you see all services report healthy:

docker compose ps

3. Open the dashboard​

Local Docker deployment: Open http://localhost:18002 in your browser.

Remote deployment: Open the dashboard hostname or tunnel URL that fronts your dashboard-2 service.

The dashboard shows:

  • Current portfolio state and P&L
  • Active positions
  • Recent signals and their outcomes
  • System health status
  • Regime classification

4. Verify the trade pipeline​

Check that the pipeline is flowing end-to-end:

# Check ingestion is receiving market data
docker compose exec redis redis-cli -n 0 XLEN market_data

# Check signals are being generated
docker compose exec redis redis-cli -n 0 XLEN signals.raw

# Check feasibility is publishing execution-ready intents
docker compose exec redis redis-cli -n 0 XLEN intents

To verify bootstrap state explicitly:

docker compose run --rm migrations
docker compose run --rm policy-seed
docker compose run --rm system-config-seed
docker compose run --rm stream-init python scripts/init_streams.py --verify-only

All three streams should have entries and growing entry counts within a few minutes of startup.

5. Check service health​

# TRADEOS.tech API
curl http://localhost:18000/healthz

# Metrics API
curl http://localhost:18003/healthz

Port reference​

ServicePortURL
TRADEOS.tech API18000http://localhost:18000
Dashboard18002http://localhost:18002
Metrics API18003http://localhost:18003
Documentation18006http://localhost:18006
Backtest API8085http://localhost:8085

Next steps​