Command Line Reference

The syntoniq and syntoniq-kbd commands have detailed --help options that explain how to invoke them from the command line. Both commands also support completion for a number of common shells. Run syntoniq completion --help or syntoniq-kbd completion --help for details.

The most important commands are syntoniq-kbd run and syntoniq generate. You can run syntoniq-kbd run --help and syntoniq generate --help for help on those.

Syntoniq includes a pitch calculator, which is covered in Pitch Calculator.

Example Commands

The following command converts a score to all available outputs.

syntoniq generate \
   --score=score.stq \
   --csound=score.csd \
   --midi=score.midi \
   --json=score-timeline.json \
   --text=score-timeline.txt

There are several command-line examples in the Complete Example section. The Keyboard chapters include examples of running the keyboard.