Browse the docs

switchboard list

Prints every macro in the Library with its state, triggers and id.

Details #

switchboard list asks the running engine for its macros. Each line shows a marker, the name, the triggers in brackets and the id.

A disabled macro starts with -. An enabled one starts with a space.

switchboard list
  Paste ticket as title  [hotkey cmd+shift+t]  m_4f2a9c
- Morning cleanup  [time]  m_81be07

Add --json to print the full macro files as a JSON array instead. The array is the same one GET /macros returns.

switchboard list --json | jq -r '.[] | select(.enabled) | .name'

Parameters #

switchboard list [--json]

List the macros.

Examples #

# ids of all enabled macros
switchboard list --json | jq -r '.[] | select(.enabled) | .id'

Gotchas #

  • The engine must be running. If it is not, the command prints how to start it and exits with code 69.

  • list takes no other arguments. Anything else exits with code 64.

See also #