Differences

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

--- manual:Scripting [2017/09/10 22:26]
peternlewis
+++ manual:Scripting [2021/10/17 23:33]
peternlewis [Using Keyboard Maestro Facilities from AppleScript]
@@ Line 18: / Line 18: @@
 For example, the [[action:Execute_an_AppleScript]] Action:\\
 {{:km-7.3-execute-script.png?nolink|}}\\
+**There are two setup options:**
+^ Setup Option ^ Choices\\ (Default shown first) ^
+| Script location | Execute text script (type or paste script into Action text field)\\ Execute script file (This may be faster if it is a compiled script file `.scpt`) |
+| Script Results | Ignored.\\ Displayed in a floating window.\\ Displayed briefly in a Notification.\\ Typed in the current text field that has focus.\\ Pasted in text field that has focus.\\ Saved to a Keyboard Maestro Variable.\\ Saved to the System or Named Clipboard.\\ Ignore Results and run //Asynchronously// (the script runs while the macro continues on to the next //Action//). |
 ==== Getting Script Results ====
@@ Line 29: / Line 35: @@
 For more information about using the Clipboard in scripts, see:
   * [AppleScript Clipboard Commands suite](https://developer.apple.com/library/mac/documentation/AppleScript/Conceptual/AppleScriptLangGuide/reference/ASLR_cmds.html)
-  * [Shell Scripts Pasteboard Commands: pbcopy, pbpaste](https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/pbpaste.1.html)
+  * The unix man pages for pbcopy, pbpaste.
 ==== Automating Applications and Adding Functionality to Keyboard Maestro ====
@@ Line 165: / Line 171: @@
 </code>
-You can ask Keyboard Maestro Engine to process tokens for you with:
+or process tokens with:
 <code applescript>
 tell application "Keyboard Maestro Engine"
-  set clip to process tokens "%PastClipboard%3%"
+  process tokens "%LongDate%"
+end tell
+</code>
+The `calculate` and `process tokens` commands can also take an `instance` parameter (v10.0+) to specify the instance for local variable access.
+You can ask Keyboard Maestro Engine to find strings in other scripts:
+<code applescript>
+tell application "Keyboard Maestro Engine"
+   count found in "The Source" for ".e" with regex
+end tell
+</code>
+And you can search and replace with:
+<code applescript>
+tell application "Keyboard Maestro Engine"
+	search "3+4" for "(\\d+)" replace "%CalculateFormat%CALCULATE(\\1)%Currency%" with regex and process tokens
 end tell
 </code>
@@ Line 199: / Line 223: @@
 See the Keyboard Maestro AppleScript dictionary for more information.
-===== URL Schemes =====
+===== Controlling Keyboard Maestro Engine via Scripting =====
-==== Editor ====
+You can adjust Keyboard Maestro Engine windows with:
-Another way you can control Keyboard Maestro Editor is using the "`keyboardmaestro`" URL scheme, which supports the following formats:
+<code applescript>
+tell application "Keyboard Maestro Engine"
-^ Example Editor URL Command ^ Description ^
+    set bounds of window "Clipboard History Switcher" to {1000, 50, 2000, 1200}
-| `keyboardmaestro://u=support%40stairways.com/s=ABCDEFGH0123456789` | enter your username/serial number. |
+end tell
-| `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. |
+</code>
-| `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://a=Execute` | filter actions with this keyword. |
-| `keyboardmaestro://c=All%20Actions/a=Execute` | select action category and filter actions with this keyword. |
----
-==== Triggers ====
-You can trigger a macro (that is Active and Enabled) using the "`kmtrigger`" URL scheme.  The URL uses this format:
-`kmtrigger://macro=<Macro Name or UUID>[&<Trigger Value>]`
-where
-  * `<Macro Name or UUID>` is either the Macro Name, OR, its UUID
-  * `<Trigger Value>` is the _optional_ Trigger Value
-  * `[ ]` are _not_ included.  Used only to show _optional_ parameters
-  * `&` must precede the Trigger Value, if it is provided.
-Note both Macro Name and Trigger Value must be URL encoded.
-You can easily get the Trigger URL by clicking on the "Or by Script" Trigger option, and selecting "Or by URL".
-{{:manual:km-7.3-macro-trigger-url-setup.png?nolink|}}
-{{:manual:km-7.3-macro-trigger-url-results.png?nolink|}}
-^ Example Trigger URL Command ^ Description ^
-| `kmtrigger://macro=Your%20Macro%20Name` | Using the Macro Name |
-| `kmtrigger://macro=224AA8CB-07EB-4C92-8201-68FED82B6E9F` | Using the Macro UUID |
-| `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  |

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools