SoundFlow CLI reference

Instructions on how to use SoundFlow from Terminal, bash/shell scripts or from other software


When you install SoundFlow, it also installs a little CLI (command line interface) utility so you can control SoundFlow from the Terminal, from shell scripts or from other software.The basic syntax for the CLI is typing soundflow, space, followed by the specific action you want to execute. See below in the relevant sections for more information.Some software might require you to specify the full path of the CLI utility instead:

Running commands soundflow run

Right now, the only thing you can do with the CLI is to run commands. You can both run the built in SoundFlow commands and any custom commands you may have created or installed.Here's the syntax for running a command from the CLI (ie. type this into Terminal):
soundflow run <command-id>
The <command-id> is a string that uniquely identifies the built-in or custom command you want to run.

Getting the command id

The easiest way to get the command id is to copy the web trigger of the command using the SoundFlow app.1. Click on the Web Trigger of the command you'd like to call. This will copy the web trigger to the clipboard. Here's an example of a web trigger:
2. Remove everything up to and including the last forward slash /, that leaves you with the command id: user:-LHdSqVWNHteMMKcJ3BE:cjlhc4jpx0000eo10ggwrdrfn3.
You're now ready to run this command:
soundflow run user:-LHdSqVWNHteMMKcJ3BE:cjlhc4jpx0000eo10ggwrdrfn

Built in commands

Note that built-in commands have more easily readable command id's, but they work just the same (take everything after last forward slash from the web trigger). For example the web trigger for the command Window Anchor to Screen Left is:
And consequently, the CLI command is:
soundflow run window.anchorToScreen.left