CLI Overview

Proteus CLI is installed from the proteus-cli crate and run with the prot binary.

cargo install proteus-cli
prot path/to/file.prot

The root command starts interactive playback when an input path is provided. Subcommands handle non-playback workflows such as info, verify, peaks, init, create, meter, and bench.

Common Workflows

Play a packaged Proteus file:

prot song.prot

Print container information:

prot info song.prot --print

Create project JSON files for a directory of audio takes:

prot init ./song-project

Generate waveform peaks:

prot peaks json take.wav

Generate a default effects JSON payload:

prot create effects-json > effects_chain.json