Differences

This shows you the differences between two versions of the page.

--- manual:URL_Schemes [2019/06/20 22:26]
peternlewis created
+++ manual:URL_Schemes [2023/09/12 22:33]
peternlewis
@@ Line 1: / Line 1: @@
+====== Command Line Tool ======
+Keyboard Maestro includes a command line tool to let you execute macros from the shell command line. The tool is named `keyboardmeastro` and is located within the `Keyboard Maestro.app` application. Assuming the application is installed in the Applications folder, the command line tool will reside at:
+```
+/Applications/Keyboard Maestro.app/Contents/MacOS/keyboardmeastro
+```
+You may want to create a shell alias for it, or add `/Applications/Keyboard Maestro.app/Contents/MacOS` to your PATH, or you can link to it from `/usr/local/bin` with the command:
+```bash
+sudo ln -s '/Applications/Keyboard Maestro.app/Contents/MacOS/keyboardmeastro' /usr/local/bin/keyboardmeastro
+```
+Use `--help` to list out the argument options.
+The command can pass a value to the macro (available via the [[token:TriggerValue|%TriggerValue%]] token), and execute the macro asynchronously, or wait for the macro to finish, receiving a result (returned via the [[action:Return_Result|Return Result]] action) which is output the stdout.
+Alternatively, the command can ask to edit the specified macro in the Keyboard Maestro editor.
 ====== URL Schemes ======
@@ Line 6: / Line 26: @@
 ^ Example Editor URL Command ^ Description ^
-| `keyboardmaestro://u=support%40stairways.com/s=ABCDEFGH0123456789` | enter your username/serial number. |
+| `keyboardmaestro://u=support%40stairways.com/s=ABCDEFGH0123456789` | Enter your username/serial number. |
-| `keyboardmaestro://m=Activate%20Application%20Switcher`\\ `keyboardmaestro://m=D2F427A1-51E3-4719-820B-4C25B6FF7329` | edit a specific macro or macro group.\\ You may used either the Macro Name, or UUID. |
+| `keyboardmaestro://m=Activate%20Application%20Switcher`\\ `keyboardmaestro://m=D2F427A1-51E3-4719-820B-4C25B6FF7329` | Edit a specific macro or macro group.\\ You may used either the Macro Name, or UUID. |
-| `keyboardmaestro://q=Activate` | filter macros with this keyword. |
+| `keyboardmaestro://q=Activate` | Filter macros with this keyword. |
-| `keyboardmaestro://g=All%20Macros/q=Activate` | select a macro group and filter macros with this keyword. |
+| `keyboardmaestro://g=All%20Macros/q=Activate` | Select a macro group and filter macros with this keyword. |
-| `keyboardmaestro://a=Execute` | filter actions with this keyword. |
+| `keyboardmaestro://a=Execute` | Filter actions with this keyword. |
-| `keyboardmaestro://c=All%20Actions/a=Execute` | select action category and filter actions with this keyword. |
+| `keyboardmaestro://c=All%20Actions/a=Execute` | Select action category and filter actions with this keyword. |
 ---
@@ Line 40: / Line 60: @@
 | `kmtrigger://macro=Your%20Macro%20Name&value=Your%20Trigger%20Value` | Using Macro Name with Trigger Value |
 | `kmtrigger://macro=224AA8CB-07EB-4C92-8201-68FED82B6E9F&value=Your%20Trigger%20Value` | Using Macro UUID with Trigger Value  |
+The `kmtrigger` URL will only work on the local Mac, but you can use the [[trigger:Remote|Remote]] trigger to trigger macros with a URL even from remote locations via the Keyboard Maestro trigger server.

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools