Usage

Once Beats is installed, run it from the command line:

beats [options] INPUT_YAML_FILE [OUTPUT_WAVE_FILE]

If you don't specify an output Wave file, it will default to the input file name but with a .wav extension. For example, running Beats like this:

beats my_song.txt

...will result in output being written to my_song.wav in the current working directory.

Options

Option	Description	Example
-p PATTERN_NAME, --pattern PATTERN_NAME	Writes audio for just the named pattern, instead of the normal song flow.	beats -p Verse my_song.txt my_song.wav
-s, --split	Writes each track in the song to its own separate Wave file, instead of mixing all tracks down to a single file.	beats -s my_song.txt my_song.wav
--path BASE_PATH	Look for song files with relative paths relative to BASE_PATH, instead of relative to the song file's path.	beats --path ~/drum_sounds example_song.txt
-v	Displays the Beats version number and exits.	beats -v
-h	Displays a list of possible options, and exits.	beats -h