Command Reference
The installed binary is prot.
prot [OPTIONS] [INPUT]
prot <COMMAND> [COMMAND_OPTIONS]
Root Playback
prot song.prot
prot song.mka
prot input.wav
prot ./song-project
Options:
-s, --seek <TIME>seeks to a time in seconds before playback.-g, --gain <GAIN>sets playback gain. Default:70.-E, --effects-json <PATH>loads a JSONVec<AudioEffect>.--start-buffer-ms <MS>sets startup audio buffering. Default:20.--start-sink-chunks <CHUNKS>sets queued sink chunks before playback starts or resumes. Default:3.--max-sink-chunks <CHUNKS>sets the maximum queued sink chunks before producer wait.0disables the limit. Default:40.--startup-silence-ms <MS>adds silence pre-roll. Default:0.--startup-fade-ms <MS>sets playback-start fade-in. Default:150.--append-jitter-log-ms <MS>logs append jitter above the threshold. Default:0.--effect-boundary-loglogs per-effect DSP boundary discontinuities.--track-eos-ms <MS>sets the container track end-of-stream threshold. Default:1000.--read-durationsreads duration metadata and exits.--scan-durationsscans packets for durations and exits.-q, --quietsuppresses the terminal UI and console output.-d <debug>enables debug output.
info
Display container information in a terminal UI:
prot info song.prot
Print information to stdout:
prot info song.prot --print
Printed output includes file path, track count, channel count, sample rate, bits per sample, and per-track durations when available.
verify
Probe or decode audio without playback:
prot verify probe song.prot
prot verify decode song.prot
prot verify verify song.prot
probereads container metadata.decodedecodes packets and reports decode errors.verifydecodes packets in strict mode and fails when decode errors are found.
peaks
Output waveform peaks as JSON:
prot peaks json input.wav
prot peaks json input.wav --limited
Legacy JSON mode is also accepted:
prot peaks input.wav
Write binary peaks:
prot peaks write input.wav input.peaks
Read binary peaks as JSON:
prot peaks read input.peaks
Read a window with a target peak count and channel limit:
prot peaks read input.peaks --start 10 --end 25 --peaks 800 --channels 2
--start and --end must be provided together.
init
Generate directory project files:
prot init ./song-project
The input must be a directory containing supported audio files.
create
Print a default enabled effects chain:
prot create effects-json
Redirect it to a file for editing:
prot create effects-json > effects_chain.json
See Effects and Metering for the supported effect types.
meter
Run offline effect-chain metering:
prot meter effects input.wav
This command requires the CLI to be installed with the effect-meter-cli feature.
bench
Run DSP benchmarks:
prot bench dsp
prot bench sweep
Benchmark commands require the CLI to be installed with the bench feature.