Command Line#

Zrythm comes with a few utilities below that can be used from the CLI.

zrythm#

Zrythm executable.

-h, --help#

Print a list of available options.

--pretty#

Pretty-print the output (where applicable).

-p, --print-settings#

Print all the user settings. Can be combined with --pretty to get pretty-printed output, like below.

../_images/print-settings.png
--reset-to-factory#

Reset user settings to their default values.

Note

Only affects the settings printed with -p. This will not affect any files in the Zrythm user path.

Warning

This will clear ALL your user settings.

-v, --version#
--zpj-to-yaml#

Convert a .zpj project file to YAML.

--yaml-to-zpj#

Convert a YAML file to the .zpj format.

Prints the Zrythm version.

zrythm_launch#

Wrapper over zrythm that sets the correct paths before launching Zrythm. All of the options for zrythm can also be passed to zrythm_launch.