Skip to main content
The fastest path is the install script, which downloads the prebuilt binary for your OS from the latest GitHub Release and puts cadenza on your PATH.

​
Install the binary

curl -fsSL https://raw.githubusercontent.com/aparekh02/cadenza-cli/main/install.sh | bash
Downloads cadenza-mac (macOS) or cadenza-linux (Linux), installs it to /usr/local/bin/cadenza, and marks it executable. You may be prompted for sudo if /usr/local/bin isn’t writable.

​
Verify

cadenza --version
# cadenza 1.0.0
If cadenza isn’t found, open a new terminal (so PATH refreshes) and try again.
The standalone binary is self-contained and bundles its own Python. It does not include the optional simulation/fine-tuning extras (gym, lora), which require a Python install. For those features, install from source below.

​
Install from source

Use this for development, or to get the simulation (gym) and fine-tuning (lora) features. Requires Python 3.10+.
1

Clone and install

git clone https://github.com/aparekh02/cadenza.git
cd cadenza-cli
pip install -e .
This exposes the cadenza-cli command.
2

Add extras (optional)

pip install -e ".[gym]"    # MuJoCo simulator, needed for env run
pip install -e ".[lora]"   # LoRA fine-tuning, needed for env lora
3

Run

cadenza-cli            # interactive shell
cadenza-cli --version
cadenza vs cadenza-cli. The install script ships a binary named cadenza. A source install exposes cadenza-cli. The commands are otherwise identical. These docs use cadenza, so substitute cadenza-cli if you installed from source.

​
Next

Quickstart

Sign in and run your first mission.

Configuration

Extras, API keys, and environment variables.