Local development environment setup and commands. Use when helping with dev server, Docker, or local testing.
Install
npx skillscat add comet-ml/opik/local-dev Install via the SkillsCat registry.
SKILL.md
Local Development
Quick Start
./scripts/dev-runner.sh --restart # First time / full rebuild
./scripts/dev-runner.sh --start # Daily start (no rebuild)
./scripts/dev-runner.sh --stop # Stop everything
./scripts/dev-runner.sh --verify # Check statusModes
| Mode | Command | Frontend | Use When |
|---|---|---|---|
| Standard | --restart |
localhost:5174 | Frontend work, full-stack |
| BE-only | --be-only-restart |
localhost:5173 | Backend-focused, faster rebuilds |
| Platform (EM) | PLATFORM_ENABLED=true ./scripts/dev-runner.sh --restart |
localhost:9100 | Opik-team only: run Opik connected to the Comet Platform |
Platform (EM) mode — Opik-team only
PLATFORM_ENABLED=true runs the Comet EM/Platform stack (comet-backend +comet-react, auto-detected sibling checkouts) alongside Opik behind a
single-origin nginx proxy, with Opik in comet mode authenticating/resolving
workspaces via comet-backend. Off by default — Standard/BE-only dev is
unaffected. comet-backend builds under a detected JDK 17/21; Opik still uses JDK 25.
PLATFORM_ENABLED=true ./scripts/dev-runner.sh --restart # then also --start/--stop/--verify
# Integrated UI: http://localhost:9100 (comet-react / Platform)
# http://localhost:9100/opik (Opik, comet mode)Env vars (COMET_BACKEND_PATH, COMET_REACT_PATH, PLATFORM_JAVA_HOME, PLATFORM_*_PORT)
and --platform-build are documented in ./scripts/dev-runner.sh --help.
URLs
- Frontend: localhost:5174 (standard) / localhost:5173 (BE-only)
- Backend API: localhost:8080
- Health: http://localhost:8080/health-check?name=all
Build Commands
./scripts/dev-runner.sh --build-be # Backend only
./scripts/dev-runner.sh --build-fe # Frontend only
./scripts/dev-runner.sh --lint-be # Spotless
./scripts/dev-runner.sh --lint-fe # ESLint
./scripts/dev-runner.sh --migrate # DB migrationsLogs
tail -f /tmp/opik-backend.log # Backend
tail -f /tmp/opik-frontend.log # Frontend (standard)
docker logs -f opik-frontend-1 # Frontend (BE-only)SDK Config
export OPIK_URL_OVERRIDE='http://localhost:8080'
export OPIK_WORKSPACE='default'Troubleshooting
Won't start:
./scripts/dev-runner.sh --verify
lsof -i :8080 # Port conflict?
./scripts/dev-runner.sh --stop && ./scripts/dev-runner.sh --restartBuild fails:
cd apps/opik-backend && mvn clean install -DskipTests
cd apps/opik-frontend && rm -rf node_modules && npm installDatabase issues:
./scripts/dev-runner.sh --stop
./opik.sh --clean # WARNING: deletes data
./scripts/dev-runner.sh --restart