The flags
| Flag | Value | What it is for |
|---|---|---|
--help | — | Print the flag roster and exit |
--console | — | Open the operator console at launch, on a display other than the show’s |
--list-devices | — | Enumerate audio capture endpoints and exit (Windows-only) |
--list-adapters | — | Enumerate graphics adapters and exit, from both rosters |
--list-presets | — | List the presets this launch would load, with each file’s status, and exit |
--schema | — | Print the preset schema as JSON on stdout and exit |
--check | <path> | Check a preset file, or a directory of them, and exit |
--strict | — | Make a --check warning cost the same exit code an error does. Needs --check |
--events | — | Report as JSON lines on stderr, for a parent process |
--preview | stdout | stdout@WxH | Mirror the windowed show to a parent process, as a fixed-size copy |
--input | loopback | line-in | Where audio comes from (Windows-only) |
--device | "<friendly name>" | Which capture endpoint to open (Windows-only) |
--tier | floor | rich | Pin the quality tier instead of letting the engine pick |
--grid-scale | 0.25–1 | auto | Draw the internal grids at this fraction of the frame — the window and --stream both. Overrides [quality] grid_scale for one run |
--osc | <host:port> | Publish analyzer telemetry as OSC over UDP, and turn the sink on |
--control | <host:port> | Listen for studio control messages as OSC over UDP, and turn the listener on |
--marks | <path> | Read and write the preset marks in this file instead of the per-user marks.toml — the window and --stream both. Overrides the marks file’s location for one run and writes nothing to config.toml |
--soak | [path] | Write a long-run frame-time trace; bare, a default path |
--downbeat-log | [path] | Write the per-beat downbeat decomposition; bare, a default path |
--stream | — | Run headless and publish every frame to a sink |
--sink | spout | stdout | Where the published frames go, default spout. Needs --stream |
--size | WxH | Published frame size; default 1280x720 on --sink spout, 640x360 on --sink stdout. Under --render, the rendered size, default 1280x720. Needs --stream or --render |
--fps | <n> | Published frame rate; default 60 on --sink spout, 30 on --sink stdout. Under --render and --bars, the rendered rate — a whole number or an exact num/den such as 30000/1001 — default 60. Needs --stream, --render or --bars |
--sender | <name> | The published Spout sender name, default ritmolux. Needs --stream |
--frames | <n> | Stop after this many frames. Needs --stream |
--gpu | <name|index> | Which graphics adapter to render on — the window and --stream both. Overrides [output] gpu for one run |
--preset | <name> | Hold one scene and disable rotation; under --render, the preset to render |
--render | <clip.wav> | Render --preset over a 16-bit PCM WAV as a Y4M video stream on stdout, and exit |
--bars | <clip.wav> | Write the bar grid a --render of the same WAV draws, as JSON, to --out, and exit |
--out | <path> | The file --bars writes. Needs --bars |
A flag marked Needs passed without any of the flags it names is a startup error naming them, rather than silence.
In this section
Built from f4f807a at version 0.178.0. This site tracks main and is not versioned per release.