NAME¶

h2cli - manual page for h2cli 1.2.4-

SYNOPSIS¶

h2cli [options]

DESCRIPTION¶

Hydrogen 1.2.4- [Dec 17 2024] [http://www.hydrogen-music.org] Copyright 2002-2008 Alessandro Cominu Copyright 2008-2024 The hydrogen development team Hydrogen comes with ABSOLUTELY NO WARRANTY This is free software, and you are welcome to redistribute it under certain conditions. See the file COPYING for details.

The CLI of Hydrogen can be used in two different ways. Either for exporting a song into an audio file

h2cli -s /usr/share/hydrogen/data/demo_songs/GM_kit_demo1.h2song \

-d GMRockKit -d auto -o ./example.wav

or for checking, extracting, installing, or upgrading an existing drumkit

h2cli -c /usr/share/hydrogen/data/drumkits/GMRockKit

OPTIONS¶

-d, --driver <Audiodriver>

Use the selected audio driver - JACK - PulseAudio - ALSA - PortAudio - Auto [default]

-s, --song <File>

Load a song (*.h2song) at startup

-p, --playlist <File>

Load a playlist (*.h2playlist) at startup

-o, --outfile <File>

Output to file (export)

-P, --data <Path>

Use an alternate system data path

--config <Path>

Use an alternate config file

-r, --rate <int>

Set bitrate while exporting file

-b, --bits <int>

Set bits depth while exporting file

--compression-level <double>

Trade-off between max. quality (0.0) and max. compression (1.0).

-k, --kit <DrumkitName>

Load a drumkit at startup

-I, --interpolation <int>

Interpolation: - 0 (linear) [default] - 1 (cosine) - 2 (third) - 3 (cubic) - 4 (hermite)

-i, --install <File>

Install a drumkit (*.h2drumkit)

-c, --check <File>

Validates a drumkit (*.h2drumkit) against current drumkit format

-l, --legacy-check <File>

Validates a drumkit (*.h2drumkit) against current as well as legacy drumkit formats

-u, --upgrade <File>

Upgrades a drumkit. The provided file can be either an absolute path to a folder containing a drumkit, an absolute path to a drumkit file (drumkit.xml) itself, or an absolute path to a compressed drumkit ( *.h2drumkit). If no target folder was specified using the -t option, a backup of the drumkit is created and the original one is upgraded in place. If a compressed drumkit is provided as first argument, the upgraded drumkit will be compressed as well.

-x, --extract <File>

Extracts the content of a drumkit (.h2drumkit). If no target is specified using the -t option, this command behaves like --install.

-t, --target <File>

Target folder the extracted (-x) or upgraded (-u) drumkit will be stored in. The folder is created if it does not exists yet.

-O, --osc-port <int>

Custom port for OSC connections

-V, --verbose <Level>

Debug level, if present, may be - None - Error [default] - Warning - Info - Debug - Constructors - Locks

-L, --log-file <Path>

Alternative log file path

-T, --log-timestamps

Add timestamps to all log messages

-h, --help

Displays help on commandline options.

--help-all

Displays help including Qt specific options.

-v, --version

Displays version information.