Keyboard Maestro 6

https://www.keyboardmaestro.com/documentation/6/
Admin
Keyboard Maestro is a productivity enhancer for Mac that enables users to automate repetitive tasks,...
Tokens:50,742
Snippets:966
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Mathematical and Logical Examples

Source: https://www.keyboardmaestro.com/documentation/6/calculations.html

Illustrates various ways to use calculation functions in expressions, including arithmetic operations, comparisons, and trigonometric functions.

```keyboardmaestro
Amount in Dollars * 100
MJD() > 55928
NOW() > TIME(2012,3,23,12,2,1)
Radius*SIN(20°),Radius*COS(20°)
```

--------------------------------

### Mathematical and Logical Examples

Source: https://www.keyboardmaestro.com/documentation/6/keyboardmaestro.html

Illustrative examples of how to use various Keyboard Maestro functions in calculations and logical comparisons.

```Keyboard Maestro
Amount in Dollars * 100
```

```Keyboard Maestro
MJD() > 55928
```

```Keyboard Maestro
NOW() > TIME(2012,3,23,12,2,1)
```

```Keyboard Maestro
DOW(TIME(2012,4,4)) = 4
```

```Keyboard Maestro
Radius*SIN(20°),Radius*COS(20°)
```

```Keyboard Maestro
Window Frame[1]+Window Frame[3]/2,Window Frame[2]+Window Frame[4]/2
```

```Keyboard Maestro
MOUSEBUTTON() + 2 * MOUSEBUTTON(4)
```

--------------------------------

### Transforming Text with Recorded Macros

Source: https://www.keyboardmaestro.com/documentation/6/recording.html

Demonstrates a practical application of Record Quick Macros for transforming text. This example shows how to convert a list of color definitions into constant integer declarations.

```text
color Red
color Green
color Blue

```

```text
const int kRed = "Red";
const int kGreen = "Green";
const int kBlue = "kBlue";

```

--------------------------------

### Calculate Center of Front Window Frame

Source: https://www.keyboardmaestro.com/documentation/6/calculations.html

This snippet demonstrates how to get the front window's frame coordinates, calculate the center point, and then set the mouse location to that center. It uses array indexing to access frame components.

```Keyboard Maestro
Set variable ‘Temp’ To Text ‘%FrontWindowFrame%’
Set variable ‘Temp’ To Calculation ‘Temp[1]+Temp[3]/2,Temp[2]+Temp[4]/2’
Use ‘Temp’ to Set the Mouse Location
```

--------------------------------

### Date and Time Functions

Source: https://www.keyboardmaestro.com/documentation/6/calculations.html

Use JD, MJD, and TIME functions to get the current date and time or to specify a date and time. YEAR, MONTH, DAY, DOW, HOUR, MINUTE, and SECOND functions extract specific components from a given time or the current time.

```keyboardmaestro
JD()
MJD()
TIME(2012,3,23,12,2,1)
YEAR(TIME(2012,4,4))
MONTH(TIME(2012,4,4))
DAY(TIME(2012,4,4))
DOW(TIME(2012,4,4))
HOUR(TIME(2012,4,4))
MINUTE(TIME(2012,4,4))
SECOND(TIME(2012,4,4))
```

--------------------------------

### Get Selected Macros via AppleScript

Source: https://www.keyboardmaestro.com/documentation/6/macrogroups.html

Retrieve a list of currently selected macros within the Keyboard Maestro application using this AppleScript. This can be used to script operations on selected items.

```applescript
tell application "Keyboard Maestro"
  selectedMacro
end tell

```

--------------------------------

### Customize Web Server Styles

Source: https://www.keyboardmaestro.com/documentation/6/preferences.html

Use the defaults write command to apply custom CSS styles to the Keyboard Maestro web server interface. This is useful for differentiating multiple Macs.

```shell
defaults write com.stairways.keyboardmaestro.editor WebServerCustomStyles -string 'body { background: green; }'
```

--------------------------------

### Set Variable to Text and Calculation

Source: https://www.keyboardmaestro.com/documentation/6/actions.html

Demonstrates setting a variable to text, including dynamic content like front window frame, and then performing calculations on that variable. Ensure variables are properly initialized before calculations.

```applescript
Set variable ‘Temp’ To Text ‘%FrontWindowFrame%’
```

```applescript
Set variable ‘Temp’ To Calculation ‘Temp[1]+Temp[3]/4,Temp[2]+Temp[4]/4’
```

```applescript
Use ‘Temp’ to Set the Mouse Location
```

--------------------------------

### Screen Coordinate Functions

Source: https://www.keyboardmaestro.com/documentation/6/calculations.html

Reference screens using indices or descriptive names like 'Main', 'Internal', or 'Mouse'. The optional 'p' parameter allows for percentage-based offsets relative to the screen's width or height.

```keyboardmaestro
SCREEN(Internal,Left,10%)
```

--------------------------------

### Execute Action by XML

Source: https://www.keyboardmaestro.com/documentation/6/scripting.html

Control Keyboard Maestro by executing a specific action defined by its XML code. This allows for dynamic action construction without pre-defined macros.

```applescript
tell application "Keyboard Maestro Engine"
  do script "<dict><key>MacroActionType</key><string>SwitchToLastApplication</string></dict>"
end tell
```

--------------------------------

### Adjust Recording Countdown

Source: https://www.keyboardmaestro.com/documentation/6/preferences.html

Set the delay in seconds before macro recording begins. The default value is 5.

```shell
defaults write com.stairways.keyboardmaestro.engine RecordingCountDown -int 5
```

--------------------------------

### Accessing Plugin Action Parameters in AppleScript

Source: https://www.keyboardmaestro.com/documentation/6/pluginactions.html

Demonstrates how to access parameters passed to a plug in action script from AppleScript. Parameters are available as environment variables prefixed with KMPARAM_.

```applescript
set myText to do shell script "echo $KMPARAM_My_Text"
```

--------------------------------

### AppleScript Display Dialog Workaround

Source: https://www.keyboardmaestro.com/documentation/6/troubleshooting.html

Use 'System Events' to perform user interaction like 'display dialog' from AppleScript, as osascript runs in the background and cannot directly interact with the user.

```applescript
tell application "System Events"
  activate
  display dialog "Hello"
end tell
```

--------------------------------

### Insert Text with Tokens

Source: https://www.keyboardmaestro.com/documentation/6/actions.html

Use this action to insert dynamic text, including variables, calculations, and formatted dates. Ensure tokens are correctly formatted for desired output.

```text
/*
 *  Created by %UserName% on %ICUDateTime%EEE d MMM yyyy%. 
 *  Copyright (c) %ICUDateTime%yyyy% Stairways Software. All rights reserved.
 */

```

--------------------------------

### Window Coordinate Functions

Source: https://www.keyboardmaestro.com/documentation/6/calculations.html

Access window coordinates and dimensions using indices or descriptive names like 'Front' or 'Back'. Indices can be positive for Z-order or negative for reverse order.

```keyboardmaestro
WINDOW(Left)
WINDOW(Right)
WINDOW(Top)
WINDOW(Bottom)
WINDOW(Width)
WINDOW(Height)
WINDOW(MidX)
WINDOW(MidY)
```

--------------------------------

### Window Referencing

Source: https://www.keyboardmaestro.com/documentation/6/keyboardmaestro.html

Functions to reference windows based on their Z-order or focus. Index 0 is the main focused window, positive indices are Z-order from front to back, and negative indices are reverse order.

```Keyboard Maestro
WINDOW(Left|Right|Top|Bottom|Width|Height|MidX|MidY)
```

--------------------------------

### Configure Password Matching

Source: https://www.keyboardmaestro.com/documentation/6/preferences.html

Define regular expressions to identify text that should be treated as passwords or not. This helps in concealing sensitive information.

```shell
defaults write com.stairways.keyboardmaestro.engine LooksLikePassword "^[a-zA-Z0-9]+"$
```

```shell
defaults write com.stairways.keyboardmaestro.engine LooksLikeNotPassword "^[a-zA-Z0-9]+"$
```

--------------------------------

### Manage AppleScript Variables

Source: https://www.keyboardmaestro.com/documentation/6/scripting.html

Use this AppleScript to create, read, and set Keyboard Maestro variables. Ensure the 'Keyboard Maestro Engine' is targeted.

```applescript
tell application "Keyboard Maestro Engine"
  set kmVarRef to make variable with properties {name:"Calculation Result"}
  set oldValue to value of kmVarRef
  set value of kmVarRef to 10
end tell

```
Tokens:
Raw