CLI Reference

Complete reference for the Waremax command-line interface.

---

Overview

Waremax provides a comprehensive CLI for running and analyzing warehouse simulations.

waremax [COMMAND] [OPTIONS]

---

Commands

Simulation Commands

Command	Description
run	Run a simulation from a scenario file
validate	Validate a scenario file without running
demo	Run a quick demo simulation

Generation Commands

Command	Description
generate	Generate a scenario file from a preset
list-presets	List available scenario presets

Testing Commands

Command	Description
sweep	Run a parameter sweep
compare	Compare two configurations
ab-test	Run A/B test with statistical analysis
benchmark	Run benchmark suite
stress-test	Run stress test

Analysis Commands

Command	Description
analyze	Run root cause analysis

---

Global Options

Option	Description
--help, -h	Show help information
--version, -V	Show version number

---

Common Patterns

Run a simulation

waremax run --scenario my_scenario.yaml

Generate and run

waremax generate --preset standard --output scenario.yaml
waremax run --scenario scenario.yaml

Export results

waremax run --scenario scenario.yaml \
  --output-dir ./results \
  --per-robot \
  --per-station \
  --heatmap

Compare configurations

waremax compare \
  --baseline baseline.yaml \
  --variant variant.yaml \
  --replications 5

Parameter sweep

waremax sweep \
  --base baseline.yaml \
  --sweep "robots:5,10,15,20" \
  --output-dir ./sweep_results

---

Exit Codes

Code	Meaning
0	Success
1	General error (invalid config, runtime error)

---

Environment Variables

Currently, Waremax does not use environment variables for configuration.

---

Getting Help

Get help for any command:

# General help
waremax --help

# Command-specific help
waremax run --help
waremax generate --help
waremax sweep --help