Configuration

RoboCI keeps configuration local and file-backed. Most workflows work with command-line options only; environment variables are used for paths, dashboard/API wiring, and shared-token protection.

Common CLI Options

  • --suite: path to a closed-loop suite YAML file.
  • --agent: path to a Python, C++, or Rust agent implementation.
  • --sim: simulator name or simulator config path. Use mock for the bundled local simulator.
  • --run: run directory or runs/latest when generating reports.
  • --current: current run directory for regression comparison.
  • --baseline or --baseline-name: baseline source for regression comparison.

Environment Variables

Variable Purpose
ROBOCI_RUNS_DIR Override the directory used for generated run artifacts.
ROBOCI_DASHBOARD_URL Embed dashboard deep links in generated static reports.
ROBOCI_API_TOKEN Require a shared token on API routes when serving beyond local-only use.
NEXT_PUBLIC_ROBOCI_API Point the Next.js dashboard at a non-default API URL.
ROBOCI_SERVER_API Point server-rendered dashboard requests at a different API URL, such as a Docker Compose service name.
NEXT_PUBLIC_ROBOCI_API_TOKEN Send the shared API token from dashboard requests.
ROBOCI_CARLA_HOST Override the CARLA adapter host from scenario YAML, used by the CARLA Compose profile.
ROBOCI_CARLA_PORT Override the CARLA adapter port from scenario YAML, used by the CARLA Compose profile.

ROBOCI_API_TOKEN is a trusted-network shared token, not a hosted multi-user security model.

Suite Files

Suite YAML files list scenario files and can include metadata used by reports and dashboard filters:

id: smoke
name: Smoke Suite
scenarios:
  - ../scenarios/simple_lane_follow.yaml

Scenario Files

Scenario YAML files define simulator setup, task goals, tags, and optional assertions. Tags and assertion results are propagated into run artifacts, API responses, reports, and dashboard filters.

Generated Paths

  • Runs: runs/<run_id>/
  • Named baselines: baselines/<name>/
  • Dashboard build output: frontend/.next/ for local Node builds; Docker dashboard builds happen inside the dashboard image target.
  • Documentation build output: site/

Generated paths are ignored by Git unless specific demo assets are intentionally committed.

See Data Formats for artifact schemas and Operations for local serving and troubleshooting.