Skip to main content

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

Introduction

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:

/usr/local/bin/soundflow

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

To get the command ID of a command, click the "Command" menu and choose "Copy Command ID". That will give you an ID like the following

user:-LHdSqVWNHteMMKcJ3BE:cjlhc4jpx0000eo10ggwrdrfn

You're now ready to run this command:

soundflow run user:-LHdSqVWNHteMMKcJ3BE:cjlhc4jpx0000eo10ggwrdrfn

Built in commands

Note that some legacy built-in commands have more easily readable command id's, but they work just the same. For example the command ID for the command Window Anchor to Screen Left is:

window.anchorToScreen.left

And consequently, the CLI command is:

soundflow run window.anchorToScreen.left


โ€‹

Did this answer your question?