Skip to main content
relai simulate runs selected learning environments against the generated simulator. 
relai simulate [OPTIONS]

​
Select environments

At least one selector should identify what to run.
OptionDescription
--learning-envs {NAMES}Learning environment names. May be repeated or comma-separated.
--tags {TAGS}Tags selecting learning environments. May be repeated or comma-separated.
--benchmarks {IDS}Registered benchmark ids. May be repeated or comma-separated.

​
Runtime and output

OptionDescription
--result-json {PATH}Write machine-readable results to this JSON file.
--env-file {PATH}Load simulator runtime variables from a KEY=VALUE file.
--env {KEY=VALUE}Set one simulator runtime variable.

​
Examples

relai simulate --learning-envs {name}
relai simulate --tags {tag} --env-file .relai/simulator.env
relai simulate --benchmarks {name}
relai simulate --learning-envs {name-a},{name-b} --result-json .relai/runs/{results}.json

​
What to expect

  • terminal simulation summary.
  • optional result JSON when --result-json is provided.
  • local run artifacts under .relai/runs/ when produced by the simulator.
  • backend upload of selected artifacts when configured and within upload limits.
Uploaded simulation results appear on the Simulations tab after you open your agent from the Agents page. Common failures: missing simulator, unknown tag or benchmark, missing runtime credentials, invalid environment file, simulator dependency failure, or backend upload failure. relai simulate does not intentionally edit agent source. If simulator execution fails, RELAI may ask the configured backend to repair selected learning environment or simulator code and retry.