Keyboard Maestro

https://wiki.keyboardmaestro.com/
Admin
Keyboard Maestro is a powerful automation tool for macOS that uses macros to automate workflows and...
Tokens:302,634
Snippets:4,671
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Execute Shell Script with pbcopy/pbpaste

Source: https://wiki.keyboardmaestro.com/Getting_Started

This example suggests using shell scripts with `pbcopy` and `pbpaste` for text conversion tasks within Keyboard Maestro, allowing for powerful text manipulation.

```shell-script
# Example usage (conceptual):
# echo "Your text" | pbcopy
# pbpaste
```

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

### Example Action Page Structure in Wiki Markup

Source: https://wiki.keyboardmaestro.com/Style_Guide_rev=1523751407

This snippet demonstrates the wiki markup used for structuring an example action page, including image inclusion, section headings, version indicators, and links to related documentation and forum discussions.

```wiki
{{:trigger:focused-window-icon.png?nolink|}}
====== Focused Window Trigger ======
  
The //Focused Window trigger// (v7.0+) executes the macro when the selected option occurs. 
  
{{:trigger:km-focused-window-trigger.png?nolink|}}
  
Other info …
  
===== See Also =====
  
----
  
==== Documentation ====
  
=== Triggers ===
  
* [[:Triggers|See all Triggers]]
  
----
  
==== Forum ====
  
- [[https://forum.keyboardmaestro.com/t/auto-close-a-window/2879/9|Auto-close a window]]
  
Keywords/Synonyms:  Focussed Window
```

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

### Execute AppleScript in Keyboard Maestro

Source: https://wiki.keyboardmaestro.com/Getting_Started

This shows how to use the 'Execute an AppleScript' action in Keyboard Maestro, which is useful for performing system-level tasks or complex operations when quitting an application.

```applescript
# Example: Unmount a server or disconnect from the Internet
# tell application "Finder"
#     eject disk "YourServerVolume"
# end tell
```

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

### Speak Text with AppleScript

Source: https://wiki.keyboardmaestro.com/Getting_Started

This snippet demonstrates how to use AppleScript within a Keyboard Maestro macro to speak text, providing audible feedback during macro execution.

```applescript
say "hello"
```

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

### Application Launch Macro Trigger

Source: https://wiki.keyboardmaestro.com/manual/Macro_Examples

Sets up a macro to automatically execute when a specific application is launched. This is useful for performing initial setup tasks, like arranging windows or loading default settings. It uses the 'Application Macro Trigger'.

```Keyboard Maestro
Trigger: Application Launched
Action: Macro to execute on launch (e.g., arrange windows)
```

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

### Wiki Text Formatting Example

Source: https://wiki.keyboardmaestro.com/Style_Guide_rev=1693887894

Demonstrates wiki text formatting for headings, emphasis (italic and bold), image embedding, and external links, as used in the Keyboard Maestro wiki.

```wiki_text
====== Focused Window Trigger ======
  
The //Focused Window trigger// (v7.0+) executes the macro when the selected option occurs. 
  
{{:trigger:km-focused-window-trigger.png?nolink|}}
  
Other info …
  
===== See Also =====
      
==== User Manual ====

* [[/User Manual]]

==== Triggers ====

* [[:Triggers|See all Triggers]]
      
==== Forum ====
  
- [[https://forum.keyboardmaestro.com/t/auto-close-a-window/2879/9|Auto-close a window]]
  
Keywords/Synonyms:  Focussed Window
```

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

### Save Text Clipping with Timestamp

Source: https://wiki.keyboardmaestro.com/Getting_Started

This macro saves the current clipboard content as a text clipping with a timestamp. It involves copying, opening a file, inserting text, pasting, and saving.

```keyboard-maestro-macro
Copy
Open File "Clippings.rtf"
Simulate Keystroke Command-Down Arrow
Insert Text "== %LongDate% %ShortTime% ==<return>" by Typing
Paste
Simulate Keystroke Return
Simulate Keystroke Return
Select Menu Item File » Save
Manipulate Window Close Front Window
Switch to Last Application (or Quit Specific Application or Command-Q)
Delayed Click
```

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

### Execute JavaScript for Automation Action Example (JXA)

Source: https://wiki.keyboardmaestro.com/action/Execute_a_JavaScript_For_Automation_do=diff&rev=1491424927

This JavaScript code demonstrates how to execute a JXA script, including setting up the application object, including standard additions, and interacting with the Keyboard Maestro Engine. It shows how to get and set Keyboard Maestro variables and the system clipboard.

```javascript
'use strict';
(function run() {
  // this will auto-run when script is executed

  // --- SET CURRENT APP VARIABLE NEEDED FOR DIALOGS & StandardAdditions.osax ---
  var app = Application.currentApplication();
  app.includeStandardAdditions = true;

  // --- SET KME APP VARIABLE NEEDED TO GET/SET KM VARIABLES ---
  var kme = Application(" Keyboard Maestro Engine");
})();
```

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

### Example Text Transformation with Keystrokes

Source: https://wiki.keyboardmaestro.com/manual/Recording

This example demonstrates a sequence of keystrokes to transform text, illustrating how a 'Record Quick Macro' can be used to automate repetitive editing tasks. It shows a practical application for converting plain text lines into formatted code snippets.

```text/plain
color Red
color Green
color Blue
```

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

```text/plain
Option-Shift-Right Arrow, Delete, Forward Delete, Command-Shift-Right Arrow, Command-X, c, o, n, s, t, <space>, i, n, t, <space>, k, Command-V, =, ", Command-V, ", ;.
```

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

### Swap Characters with Named Clipboard

Source: https://wiki.keyboardmaestro.com/Getting_Started

This macro swaps two adjacent characters by using a temporary named clipboard. It simulates keystrokes to move the cursor, cut, paste, and save the temporary content.

```keyboard-maestro-macro
Simulate Keystroke Shift-Right Arrow
Cut to Named Clipboard "Temp"
Simulate Keystroke Left Arrow
Paste from Named Clipboard "Temp"
Save a Text Clipping
```

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

### Real-World AppleScript Example for Keyboard Maestro Variables (7.1+)

Source: https://wiki.keyboardmaestro.com/AppleScript

A practical AppleScript example for Keyboard Maestro, demonstrating getting specific string variables, processing them (finding a substring's position), and setting an output variable. Error checking is omitted for simplicity. Requires Keyboard Maestro 7.1+.

```applescript
### Requires Keyboard Maestro 7.1+ ###
 
--- GET REQUIRED KM VARIABLES ---
 
tell application "Keyboard Maestro Engine"
  set mainStr to getvariable "SCPT__MainString"
  set subStr to getvariable "SCPT__StringToFind"
end tell
 
--- PROCESS THESE KM VARIABLES ---
 
--- Get Start of StringToFind ---
set posSubStr to offset of subStr in mainStr
 
--- SET OUTPUT KM VARIABLE ---
 
tell application "Keyboard Maestro Engine" to setvariable "SCPT__PosSubStr" to posSubStr
```

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

### Real-World Example: Get Strings, Find Position, Set Result with AppleScript

Source: https://wiki.keyboardmaestro.com/AppleScript_rev=1507941985

An example of using AppleScript to get two string variables from Keyboard Maestro, perform a string operation (finding the position of a substring), and then set the result as a new Keyboard Maestro variable. Requires Keyboard Maestro 7.1+.

```applescript
### Requires Keyboard Maestro 7.1+ ###

--- GET REQUIRED KM VARIABLES ---

tell application "Keyboard Maestro Engine"
  set mainStr to getvariable "SCPT__MainString"
  set subStr to getvariable "SCPT__StringToFind"
end tell

--- PROCESS THESE KM VARIABLES ---

--- Get Start of StringToFind ---
set posSubStr to offset of subStr in mainStr

--- SET OUTPUT KM VARIABLE ---

tell application "Keyboard Maestro Engine" to setvariable "SCPT__PosSubStr" to posSubStr
```

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

### Get Available Screen Resolutions

Source: https://wiki.keyboardmaestro.com/token/ScreenResolutions

This example demonstrates using the %ScreenResolutions% token to get a list of available resolutions for a specific screen, such as the 'Second' screen. Resolutions are separated by a comma and a space.

```text
%ScreenResolutions%Second%
```

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

### Setup Applications on Launch with Macros

Source: https://wiki.keyboardmaestro.com/Getting_Started_rev=1696918950

Use an Application Macro Trigger to automatically execute a macro when an application is launched. This allows for pre-configuration of application windows or other settings.

```text
If you always do a set of things every time you launch an application (eg arrange the windows in a particular way), use an application Macro Trigger to execute a Macro when you launch the application, then have the Macro do the work for you.
```

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

### Keyboard Maestro Action Plist Example

Source: https://wiki.keyboardmaestro.com/manual/Plug_In_Actions_do=edit

An example of the 'Keyboard Maestro Action.plist' file, which is an XML-based Cocoa Property List. This file defines the user interface elements and parameters for a Plug In Action within the Keyboard Maestro editor.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>ActionUID</key>
	<string>com.example.myaction</string>
	<key>ActionName</key>
	<string>My Custom Action</string>
	<key>ActionDescription</key>
	<string>Performs a custom task.</string>
	<key>ScriptFile</key>
	<string>Action.scpt</string>
	<key>Parameters</key>
	<array>
		<dict>
			<key>Name</key>
			<string>InputText</string>
			<key>Label</key>
			<string>Input Text:</string>
			<key>Type</key>
			<string>Text</string>
		</dict>
		<dict>
			<key>Name</key>
			<string>NumericValue</string>
			<key>Label</key>
			<string>Numeric Value:</string>
			<key>Type</key>
			<string>Number</string>
		</dict>
	</array>
</dict>
</plist>
```

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

### DokuWiki Syntax: Ordered List Example

Source: https://wiki.keyboardmaestro.com/wiki/syntax_rev=1622344510

Shows the DokuWiki syntax for creating an ordered (numbered) list. Each list item is indented by two spaces and starts with a hyphen (-). Nested lists are supported via indentation.

```dokuwiki
- The same list but ordered
- Another item
  - Just use indention for deeper levels
  - That's it
```

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

### Date/Time Format Examples

Source: https://wiki.keyboardmaestro.com/Dates_and_Times_rev=1497049795

This table provides examples of common date and time formats using Keyboard Maestro's ICUDateTime tokens. It shows how different format codes translate into readable date representations for various regional standards and file naming conventions.

```text
Usage| Token and Format| Results  
---|---|---
ISO/International| %ICUDateTime%yyyy-MM-dd%| 2015-11-28  
Australia  
Europe| %ICUDateTime%dd/MM/yyyy%| 28/11/2015  
United States| %ICUDateTime%EEE, MMM d, yyyy%| Sat, Nov 28, 2015  
United States| %ICUDateTime%MM/dd/yyyy%| 11/28/2015  
Use in File Name| %ICUDateTime%yyyy-MM-dd-HHmmssA%| 2015-11-28-15210755267426
```

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

### Keyboard Maestro: Example Expressions for Calculations

Source: https://wiki.keyboardmaestro.com/manual/Calculations_do=diff&rev=1530343476

Provides a list of example expressions that can be used within Keyboard Maestro for various calculations. These examples cover mathematical operations, date/time comparisons, and array manipulation. No specific external dependencies beyond Keyboard Maestro.

```text
Amount in Dollars * 100
MJD() > 55928
NOW() > TIME(2023,3,23,12,2,1)
DOW(TIME(2023,4,4)) = 4
Radius*SIN(20°),Radius*COS(20°)
Window Frame[1]+Window Frame[3]/2,Window Frame.MidY
```

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

### Get and Set Local/Instance Variables in AppleScript for Keyboard Maestro

Source: https://wiki.keyboardmaestro.com/AppleScript_do=diff&rev=1496617602

Demonstrates how to get and set local or instance variables within Keyboard Maestro using AppleScript. It requires Keyboard Maestro 8.0.3+ and utilizes the KMINSTANCE environment variable. The script retrieves a variable's value and then sets another variable's value.

```applescript
set kmInst to system attribute " KMINSTANCE" 
tell application " Keyboard Maestro Engine" 
set v to getvariable " Local__SomeLocalVariable" instance kmInst 
setvariable " Local__FromAS" instance kmInst to "Variable set in AppleScript".
end tell

log v
```

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

### Example Transformation Using Keyboard Maestro Recording

Source: https://wiki.keyboardmaestro.com/manual/Recording_do=edit

This example demonstrates a text transformation task using Keyboard Maestro's recording feature. It outlines the sequence of keyboard shortcuts and actions to convert lines from one format to another, illustrating the practical application of recorded macros for repetitive tasks.

```text
color Red
color Green
color Blue
```

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

```text
Option-Shift-Right Arrow, Delete, Forward Delete, Command-Shift-Right Arrow, Command-X, c, o, n, s, t, <space>, i, n, t, <space>, k, Command-V, =, ", Command-V, ", ;.
Command-Left Arrow, Down Arrow
```

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

### Real-world AppleScript Example for KM Variables (v7.1+)

Source: https://wiki.keyboardmaestro.com/AppleScript_rev=1484357859

A practical example of using AppleScript to retrieve two Keyboard Maestro variables ('SCPT__MainString' and 'SCPT__StringToFind'), process them (finding the position of a substring), and then set a new Keyboard Maestro output variable ('SCPT__PosSubStr'). This snippet simplifies error checking for clarity.

```applescript
--- GET REQUIRED KM VARIABLES ---

tell application "Keyboard Maestro Engine"
  set mainStr to getvariable "SCPT__MainString"
  set subStr to getvariable "SCPT__StringToFind"
end tell

--- PROCESS THESE KM VARIABLES ---

--- Get Start of StringToFind ---
set posSubStr to offset of subStr in mainStr

--- SET OUTPUT KM VARIABLE ---

tell application "Keyboard Maestro Engine" to setvariable "SCPT__PosSubStr" to posSubStr
```

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

### Example Expressions for Calculations

Source: https://wiki.keyboardmaestro.com/manual/Calculations_do=diff&rev=1560829595

Provides a collection of example expressions that can be used in Keyboard Maestro calculation fields, demonstrating various mathematical operations, date/time functions, and variable accesses.

```text
Amount in Dollars * 100
MJD() > 55928
NOW() > TIME(2023, 3, 23, 12, 2, 1)
DOW(TIME(2023, 4, 4)) = 4
Radius*SIN(20°),Radius*COS(20°)
Window Frame[1]+Window Frame[3]/2,Window Frame.MidY
```

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

### TIME() Function Examples - Keyboard Maestro

Source: https://wiki.keyboardmaestro.com/function/TIME_do=edit

Demonstrates various ways to use the TIME() function in Keyboard Maestro to get unixtime. It covers getting the current unixtime, the start of a specific date, and a precise date and time. It also highlights the GMT nature of TIME() and potential issues with local time conversions, suggesting the use of midday for date conversions.

```Keyboard Maestro
TIME()

TIME( 2015, 8, 23 )

TIME( 2015, 8, 23, 12, 0, 0 )

%ICUDateTimeFor% TIME(2015, 8, 23,12,0,0) %EEE, MMM d, yyyy%
```

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

### Example Expressions for Calculations (Keyboard Maestro)

Source: https://wiki.keyboardmaestro.com/manual/Calculations_do=diff&rev=1633330735

Provides a list of example expressions that can be used in Keyboard Maestro calculation fields. These examples demonstrate arithmetic operations, date/time comparisons, and trigonometric functions.

```text
Amount in Dollars * 100
MJD() > 55928
NOW() > TIME(2023,3,23,12,2,1)
DOW(TIME(2023,4,4)) = 4
Radius*SIN(20°),Radius*COS(20°)
```

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

### Java Syntax Highlighting Example

Source: https://wiki.keyboardmaestro.com/wiki/syntax_rev=1412755163

Demonstrates how to highlight Java code using the `<code java>` tag in DokuWiki. This feature relies on the GeSHi library for syntax highlighting.

```java
/**  * The HelloWorldApp class implements an application that  * simply displays “Hello World!” to the standard output.  */ class HelloWorldApp {     public static void main(String[] args) {         System.out.println(“Hello World!”); _Display the string.     } }
```

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

### Modern Syntax Example in JXA

Source: https://wiki.keyboardmaestro.com/action/Execute_a_JavaScript_For_Automation_do=diff&rev=1491424927

This example showcases the modern syntax for executing JavaScript for Automation scripts in Keyboard Maestro version 11.0 and later. It demonstrates how to wrap scripts and return values using the 'return' keyword, and provides a basic script that returns a string.

```javascript
(function () {
  // ...
})();
```

```javascript
return " Hello";
```

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

### Real-world Example: Get and Set Keyboard Maestro Variables with AppleScript (KM 7.1+)

Source: https://wiki.keyboardmaestro.com/AppleScript_do=edit

A practical example showing how to extract substrings and find their positions within a larger string by getting and setting Keyboard Maestro variables. Error checking is omitted for clarity. Assumes Keyboard Maestro 7.1 or later.

```applescript
### Requires Keyboard Maestro 7.1+
--- GET REQUIRED KM VARIABLES ---
tell application "Keyboard Maestro Engine"
    set mainStr to getvariable "SCPT__MainString"
    set subStr to getvariable "SCPT__StringToFind"
end tell
--- PROCESS THESE KM VARIABLES ---
--- Get Start of StringToFind ---
set posSubStr to offset of subStr in mainStr
--- SET OUTPUT KM VARIABLE ---
tell application "Keyboard Maestro Engine" to setvariable "SCPT__PosSubStr" to posSubStr
```

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

### Enable and Setup Web Server

Source: https://wiki.keyboardmaestro.com/trigger/Web_Server_do=edit

This section details the steps and preferences required to enable and configure the Keyboard Maestro web server, including port settings, authentication, and access controls.

```APIDOC
## Enable and Setup Web Server

### Description
Configure the built-in Keyboard Maestro web server through its preferences. This includes enabling the server, setting the HTTP port, defining username and password for authentication, and controlling browser access and clipboard behavior.

### Method
Preferences Configuration

### Endpoint
Keyboard Maestro Preferences > Web Server

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
*(Configuration is done through the Keyboard Maestro application interface, not via API requests.)*

### Response
#### Success Response
*(Indicates successful saving of preferences.)*

#### Response Example
*(N/A - Configuration Interface)*

### Configuration Fields:
- **Web Server Enabled** (boolean) - Required - Check to enable the web server.
- **HTTP Port** (integer) - Required - The port for HTTP access (default: 4490). HTTPS port is HTTP Port + 1.
- **Username** (string) - Required for authenticated access - The username for logging into the web server.
- **Password** (string) - Required for authenticated access - The password for logging into the web server.
- **Web Browser Access Enabled** (boolean) - Required - Enables access from iOS devices using Keyboard Maestro Control.
- **Receive Clipboards into Clipboard History** (boolean) - Optional - Enables sending clipboard content between Macs.
- **Replacing Current Clipboard** (boolean) - Optional - If checked, received clipboards replace the current system clipboard; otherwise, they are added to the history.
```

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

### Keyboard Maestro: Unary Prefix Operators Example

Source: https://wiki.keyboardmaestro.com/manual/Calculations_rev=1526526871

Shows examples of unary prefix operators in Keyboard Maestro, including square root, negation, and sub-expression grouping.

```keyboardmaestro
√number
-number
(expression)
```

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

### DokuWiki Syntax: Unordered List Example

Source: https://wiki.keyboardmaestro.com/wiki/syntax_rev=1622344510

Illustrates the DokuWiki syntax for creating an unordered (bulleted) list. Each list item is indented by two spaces and starts with an asterisk (*). Nested lists are achieved through further indentation.

```dokuwiki
* This is a list
* The second item
  * You may have different levels
  * Another item
```

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

### Get Resolution of Screen Containing Mouse

Source: https://wiki.keyboardmaestro.com/token/ScreenResolutions

This example demonstrates how to get the resolution of the screen that currently contains the mouse cursor. This is useful for dynamic actions based on mouse position.

```text
%ScreenResolution%Mouse%
```

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

### DokuWiki Syntax for Media Embedding

Source: https://wiki.keyboardmaestro.com/wiki/syntax_rev=1546766327

Demonstrates syntax for embedding various media formats (images, videos, audio, flash) with options for resizing and alignment. Includes examples for real size, resizing by width, resizing by width and height, and using external images. It also shows how to create a link to media without displaying it inline.

```dokuwiki
Real size:
{{wiki:dokuwiki-128.png}}

Resize to given width:
{{wiki:dokuwiki-128.png?200}}

Resize to given width and height3):
{{wiki:dokuwiki-128.png?200x100}}

Resized external image:
{{http://de.wikipedia.org/upload/shared/d/d6/Wiki.png?100}}

Real size:
{{wiki:video.mp4}}

Resize to given width:
{{wiki:video.mp4?300}}

Resize to given width and height:
{{wiki:video.mp4?300x200}}

Resized external image:
{{http://.../video.mp4?250}}

By using left or right whitespaces you can choose the alignment.
{{ wiki:dokuwiki-128.png }}
{{left}}{{wiki:dokuwiki-128.png}}{{right}}

Of course, you can add a title (displayed as a tooltip by most browsers), too.
{{wiki:dokuwiki-128.png|A short title}}

By adding `?linkonly` you provide a link to the media without displaying it inline
{{wiki:dokuwiki-128.png?linkonly}}
```

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

### Keyboard Maestro: Get Window Size Example

Source: https://wiki.keyboardmaestro.com/token/Window_Tokens_redirect=2

Example of using the %WindowSize% token to retrieve the pixel dimensions (width, height) of a specified window. This can be used to resize windows or check their dimensions.

```keyboardmaestro
%WindowSize%Front%
```

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

### Shell Script: Initial Defaults Write Example (Bash)

Source: https://wiki.keyboardmaestro.com/Shell_Scripting

This is an initial example of writing a default preference using the 'defaults' command. It highlights how bash processes the command line, splitting it into an array of arguments based on spaces and special characters, which can lead to unexpected behavior if not properly quoted.

```bash
defaults write /Users/me/Library/Application\ Support/Witch/Settings $KMVAR_witchPref
```

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

### Keyboard Maestro CLI Tool Help and Version

Source: https://wiki.keyboardmaestro.com/trigger/keyboardmaestro

Shows how to display the help message for the keyboardmaestro CLI tool to understand all available options and arguments, and how to check the installed version.

```shell
keyboardmaestro --help
```

```shell
keyboardmaestro -h
```

```shell
keyboardmaestro --version
```

```shell
keyboardmaestro -V
```

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

### Keyboard Maestro: Get Window Position Example

Source: https://wiki.keyboardmaestro.com/token/Window_Tokens_redirect=2

Example of using the %WindowPosition% token to retrieve the pixel coordinates (left, top) of a specified window. Useful for moving windows to specific screen locations.

```keyboardmaestro
%WindowPosition%Front%
```

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

### LINES Function Documentation Example (Text)

Source: https://wiki.keyboardmaestro.com/function/LINES_do=diff&rev=1467552619

This snippet illustrates the typical documentation format for the LINES function, including its definition, parameters, and an example of its usage with Keyboard Maestro tokens like %CurrentClipboard% and %Variable%. It also lists related functions.

```text
====== LINES Function ======

The LINES**(t)** function takes an arbitrary [[:Tokens|token text]] string, processes the text tokens, and then returns the number of lines in the string.

  LINES(%CurrentClipboard%)
  LINES(%Variable%MyVar%)

===== Example =====

**{{function: function-lines-example.jpg? nolink|}}**

===== See Also =====

=== Actions ===

=== Functions ===
* [[function: CALCULATE|CALCULATE]] 
* [[function:CHARACTERS|CHARACTERS]] 
* [[function:WORDS|WORDS]] 
* [[:Functions|See all Functions]]

==== Forum ====
* [[https://forum.keyboardmaestro.com/search?q=LINES|Keyboard Maestro Forum topics about LINES() function]]
```

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

### Keyboard Maestro: Get Window Frame Example

Source: https://wiki.keyboardmaestro.com/token/Window_Tokens_redirect=2

Example of using the %WindowFrame% token to retrieve the pixel coordinates (left, top, width, height) of a specified window. This is useful for positioning or resizing actions.

```keyboardmaestro
%WindowFrame%1%
```

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

### Automate Text Conversions with Shell Script

Source: https://wiki.keyboardmaestro.com/Getting_Started_rev=1414981183

This example demonstrates automating text format conversions using a shell script. It leverages `pbcopy` and `pbpaste` for interacting with the system clipboard, allowing for text manipulation between applications or scripts.

```Shell Script
# Example: Convert header functions to function entries
# Assumes input is piped to stdin and output goes to stdout
# pbcopy and pbpaste can be used to interact with the clipboard
# Example usage within a Keyboard Maestro macro:
# Execute Shell Script
# script:
#   pbpaste | YOUR_SCRIPT_HERE | pbcopy
```

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

### Example JXA Script for Plug In Action

Source: https://wiki.keyboardmaestro.com/manual/Plug_In_Actions_do=edit

An example of a JXA (JavaScript for Automation) script that can function as an 'Action.scpt' for a Keyboard Maestro Plug In Action. It shows how to retrieve parameters passed from the plist.

```javascript
function run(actionParameters) {
  const inputText = actionParameters["InputText"];
  const numericValue = actionParameters["NumericValue"];
  
  console.log("Input Text: " + inputText);
  console.log("Numeric Value: " + numericValue);
  
  // Your custom action logic here
  
  return "Action completed successfully.";
}
```

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

### Keyboard Shortcut Guide Creation using Apple Pages

Source: https://wiki.keyboardmaestro.com/Ideas_do=edit

A method for creating custom visual guides for keyboard shortcut keys using Apple Pages. Involves measuring the keyboard, creating a table with appropriate cell dimensions and text formatting, and printing the guide for placement near function keys.

```pages
Insert a table equal in width to the keyboard measurement and divided into 14 equal cells.
```

```pages
Select the entire table and format the text centered in the cells both horizontally and vertically. Chose a small but readable text size and font. Helvetica 10 pt works for me.
```

```pages
Select the entire table and set the cell height to a minimal size.
```

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

### Get Current Screen Saver Name - AppleScript

Source: https://wiki.keyboardmaestro.com/action/Start_Screen_Saver

This AppleScript retrieves the name of the screen saver that the system currently believes is active. This can be useful for debugging issues with the 'Start Screen Saver' action.

```applescript
tell application "System Events" to current screen saver
```

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

### Extracting SKU and Price using Regex - Example

Source: https://wiki.keyboardmaestro.com/action/Search_Clipboard

This example demonstrates how to use a regular expression to extract specific parts of a string, such as a product SKU and its price. It highlights the use of capture groups to isolate desired data. This action is best suited for finding the first match; for multiple matches, a loop is required.

```text
SKU1234Δ    Widget 1Δ	$12.95
```

```regex
(SKU\d{4})\h(.+)\h(.+)
```

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

### Get Resolution of Indexed Screen (Right to Left)

Source: https://wiki.keyboardmaestro.com/token/ScreenResolutions

This example shows how to retrieve the resolution of a screen using negative indexing, counting from right to left. For example, '-1' would refer to the rightmost screen.

```text
%ScreenResolution%-1%
```

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

### Keyboard Maestro Window Resizing and Centering

Source: https://wiki.keyboardmaestro.com/Ideas_rev=1413455232

Demonstrates using Keyboard Maestro's 'Resize Front Window to Pixels' and 'Center Front Window' actions to manage window dimensions and positioning. Useful for setting up specific layouts.

```Keyboard Maestro
Resize Front Window to Pixels 1280x720
Center Front Window
```

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

### DokuWiki Quoting Syntax Example

Source: https://wiki.keyboardmaestro.com/wiki/syntax_rev=1439533626

Demonstrates the DokuWiki syntax for creating quoted text, often used for replies or comments. It shows nested quoting levels.

```text
I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!
```

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

### Get Keyboard Maestro Variable via osascript

Source: https://wiki.keyboardmaestro.com/Shell_Scripting

Example of how to retrieve a Keyboard Maestro variable's value from an external application using osascript. This command interacts with the 'Keyboard Maestro Engine' to get the specified variable.

```shell
osascript -e 'tell application "Keyboard Maestro Engine" to getvariable "My KM Var"'
```

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

### Application Setup on Launch/Quit with AppleScript

Source: https://wiki.keyboardmaestro.com/Getting_Started_rev=1696918975

Configure applications automatically on launch or quit using Keyboard Maestro's application macro triggers. This can involve arranging windows, mounting/unmounting servers, or disconnecting from the internet, potentially requiring AppleScript for complex actions.

```applescript
# Example: Unmount a server volume (replace with actual volume name)
disconnect from server "afp://myserver.local/share"

```

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

### Get Keyboard Maestro Variable with Error Handling (osascript)

Source: https://wiki.keyboardmaestro.com/action/Execute_a_Shell_Script_rev=1634201113

A more robust example using osascript to get a Keyboard Maestro variable, including error handling if the variable does not exist. The AppleScript is embedded within a shell script for execution.

```shell
read -r -d '' theAppleScript <<'EOF'
   tell application "Keyboard Maestro Engine"
      set kmVarName to "My KM Var"
      tell variable kmVarName
         if it exists then
            return its value
         else
            return "Error → Keyboard Maestro variable '" & kmVarName & "' does not exist!"
         end if
      end tell
   end tell
EOF

osascript -e "$theAppleScript"
```

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

### DokuWiki Fallback Media Example

Source: https://wiki.keyboardmaestro.com/wiki/syntax_rev=1622336714

Illustrates how DokuWiki handles fallback formats for video and audio files, ensuring wider browser compatibility. It shows embedding an MP4 with WebM and Ogg alternatives, and the use of a poster image.

```dokuwiki
{{video.mp4}}
{{video.webm}}
{{video.ogv}}
{{video.jpg?poster}}
```

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

### DokuWiki Image Resizing Syntax Example

Source: https://wiki.keyboardmaestro.com/wiki/syntax_do=diff&rev=1412755163

Shows how to resize images displayed in DokuWiki to specific dimensions. This allows control over the image's display size, with options for both width and height, or just width. The syntax appends dimension parameters to the image path.

```text
{{wiki:dokuwiki-128.png?200x50}}
```

```text
{{wiki:dokuwiki-128.png?50}}
```

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

### Get Available Screen Resolutions (Keyboard Maestro Token)

Source: https://wiki.keyboardmaestro.com/token/ScreenResolution

This example shows how to use the %ScreenResolutions% token to get a list of all available screen resolutions. The resolutions are returned separated by a comma and a space. This token also accepts screen selection parameters.

```Keyboard Maestro
%ScreenResolutions%All%
```

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

### Token Format Examples - Keyboard Maestro

Source: https://wiki.keyboardmaestro.com/manual/Tokens_do=edit

Demonstrates the basic syntax for using tokens in Keyboard Maestro, both with and without parameters. Tokens are enclosed in percent signs.

```text
No Parameter:
%TokenName%

With Parameter:
%TokenName%Parameter%
```

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

### Example Input and Output for Quick Macro

Source: https://wiki.keyboardmaestro.com/manual8/index

This snippet illustrates how a 'Record Quick Macro' action can be used. Triggering the macro with one hotkey (Control-F1) and then performing actions (typing 'hello') followed by another trigger (Control-F1) allows the captured sequence to be executed later with a different hotkey (Option-F1).

```text
Control-F1, h, e, l, l, o, Control-F1
```

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

### Keyboard Maestro: Create Calendar Event Action Example

Source: https://wiki.keyboardmaestro.com/action/Create_Calendar_Event_do=edit

This code snippet demonstrates a typical time calculation for setting the start time of a calendar event. It calculates the start time to be 9 AM on the following day, adjusted for the system's GMT offset.

```actionscript
TIME(YEAR(),MONTH(),DAY()+1,9,0,0)-GMTOFFSET()
```

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

### Get Keyboard Maestro Variable with Error Handling (osascript)

Source: https://wiki.keyboardmaestro.com/Shell_Scripting

A more comprehensive example using osascript to get a Keyboard Maestro variable, including error handling to check if the variable exists. It returns the variable's value or an error message if the variable is not found.

```shell
read -r -d '' theAppleScript <<'EOF'
   tell application "Keyboard Maestro Engine"
      set kmVarName to "My KM Var"
      tell variable kmVarName
         if it exists then
            return its value
         else
            return "Error → Keyboard Maestro variable '" & kmVarName & "' does not exist!"
         end if
      end tell
   end tell
EOF
osascript -e "$theAppleScript"
```

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

### Setup Frames Macro Base Script

Source: https://wiki.keyboardmaestro.com/Window_Movers

This Ruby script is the core of the 'Setup Frames' macro. It calculates and sets variables that hold potential frame sizes and coordinates for window manipulation.

```ruby
# This is a conceptual representation. The actual script would be within Keyboard Maestro.
# It would likely interact with system APIs to get screen and window information.

# Example of setting variables (within Keyboard Maestro context):
# Set Variable ‘FB_Monitor0Frame’ to Text ‘%Screen%1%’
# Set Variable ‘FB_Monitor1Frame’ to Text ‘%Screen%2%’

puts "Setting up frame variables..."
```

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

### Keyboard Maestro %Ask% Token Syntax Examples

Source: https://wiki.keyboardmaestro.com/token/Ask_do=edit

Demonstrates the various syntaxes of the %Ask% token for user input fields in Keyboard Maestro's 'Prompt for Snippet' action. Includes examples for inline text fields and multi-line input fields, with options for size, default values, and variable assignment.

```text
^Token^Meaning^ | %Ask% | 20 character wide text field |
| %Ask12% | 12 character wide text field |
| %Ask12:Default% | 12 character wide text field with initial value “Default” |
| %Ask40=VarName% | 40 character wide text field with initial value from variable VarName |
```

```text
^Token^Meaning^ | %Ask% | 5 line text field |
| %Ask8% | 8 line text field |
| %Ask12:Default% | 12 line text field with initial value “Default” |
| %Ask3=VarName% | 3 line text field with initial value from variable VarName |
```

```text
%Ask5:7:50%
```

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

### JD Function for Julian Date Conversion

Source: https://wiki.keyboardmaestro.com/function/JD

The JD() function calculates the Julian Date. It can be called with no arguments to get the current Julian Date, or with year, month, and day to get the Julian Date of the start of that day. It can also accept hour, minute, and second for a precise Julian Date of a specific moment.

```keyboardmaestro
JD() === the current JulianDate
JD( year, month, day ) === the JulianDate of the start of the year/month/day
JD( year, month, day, hour, minute, second ) === the JulianDate of the specified moment
```

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

### Text Transformation Example with Keyboard Maestro Quick Macro

Source: https://wiki.keyboardmaestro.com/manual/Single_Page_Version

Demonstrates a sequence of keystrokes to transform lines of text using a Keyboard Maestro quick macro. This sequence involves cursor movements, deleting text, copying, pasting, and typing new characters to convert lines like 'color Red' into 'const int kRed = "Red";'. This is an example of how quick macros can automate repetitive text editing tasks.

```text
Control-F1, h, e, l, l, o, Control-F1
Option-F1 (repeatedly for subsequent lines)
```

```text
Option-Shift-Right Arrow, Delete, Forward Delete, Command-Shift-Right Arrow, Command-X, c, o, n, s, t, <space>, i, n, t, <space>, k, Command-V, =, ", Command-V, ", ;
Command-Left Arrow, Down Arrow
```

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

### Execute Emacsclient with a Hardcoded URL in Bash

Source: https://wiki.keyboardmaestro.com/action/Execute_a_Shell_Script_do=diff&rev=1574718820

This Bash snippet executes the emacsclient command to open a specific URL using w3m-browse-url. It serves as a direct example of passing a known string argument, useful for testing or when the URL is static. Similar to other examples, it relies on the correct installation and configuration of emacsclient.

```bash
#!/bin/bash
/usr/local/bin/emacsclient -e '(w3m-browse-url "https://www.apple.com")'
```

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

### Window Frame Token Example

Source: https://wiki.keyboardmaestro.com/token/FrontWindowSize

Demonstrates the output format for the %WindowFrame% token, showing pixel values for left, top, width, and height of a window.

```text
228,23,1314,1173

left,top,width,height
```

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

### Example of Accessing Token Array Item

Source: https://wiki.keyboardmaestro.com/manual9/index

Demonstrates accessing a specific element from a token that returns a list of values. This example retrieves the third item from the WindowFrame token.

```plaintext
%WindowFrame[3]%1%
```

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

### Get and Set Local/Instance Variables in Keyboard Maestro (v8.0.3+)

Source: https://wiki.keyboardmaestro.com/AppleScript_do=diff&rev=1740638090

This snippet illustrates how to access local or instance variables within Keyboard Maestro scripts, starting from version 8.0.3. It utilizes the KMINSTANCE environment variable to pass the macro execution instance to the AppleScript. This is crucial for correctly scoping variable operations.

```applescript
set kmInst to system attribute "KMINSTANCE"
tell application "Keyboard Maestro Engine"
	-- To get or set Local or Instance Variables, you must pass the macro execution instance
	-- The instance is passed in to your script via the KMINSTANCE environment variable (v8.0.3+)
end tell
```

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

### Apply Text Conversions with Shell Script

Source: https://wiki.keyboardmaestro.com/Getting_Started_rev=1462780727

This demonstrates using a shell script with `pbcopy` and `pbpaste` for text conversions, which can be integrated into Keyboard Maestro macros for automating format translations.

```shell
# Example: Convert header functions to function entries
echo "Converting text..." | pbcopy
# ... perform text conversion logic ...
cat /tmp/converted_text.txt | pbpaste
```

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

### Example Expressions in Calculations

Source: https://wiki.keyboardmaestro.com/manual/Calculations_do=diff&rev=1560830395

Provides a set of example expressions that can be used in Keyboard Maestro calculation fields. These examples cover date/time comparisons, trigonometric functions, and array/dot notation access for variable data.

```Keyboard Maestro Macro Language
Amount in Dollars * 100
MJD() > 55928
NOW() > TIME(2023 ,3,23,12,2,1)
DOW(TIME(2023 ,4,4)) = 4
Radius*SIN(20°),Radius*COS(20°)
Window Frame[1]+Window Frame[3]/2,Window Frame.MidY
```

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

### Downloadable Code Blocks

Source: https://wiki.keyboardmaestro.com/wiki/syntax_rev=1626239576

Code blocks can be made downloadable by specifying a filename after the language code within the `<code>` or `<file>` tags (e.g., `<file php myexample.php>`). If only download is desired without highlighting, use a dash (`-`) as the language code.

```php
<?php echo "hello world!"; ?>

```

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

### Get Keyboard Maestro Variable with Error Handling (osascript)

Source: https://wiki.keyboardmaestro.com/action/Execute_a_Shell_Script_do=edit

This comprehensive example uses 'osascript' to safely get a Keyboard Maestro variable, including error handling for cases where the variable might not exist. It defines the AppleScript within a shell heredoc for readability and then executes it. Customize 'My KM Var' for your specific variable.

```shell
read -r -d '' theAppleScript <<'EOF'
tell application "Keyboard Maestro Engine"
    set kmVarName to "My KM Var"
    tell variable kmVarName
        if it exists then
            return its value
        else
            return "Error → Keyboard Maestro variable '" & kmVarName & "' does not exist!"
        end if
    end tell
end tell
EOF
osascript -e "$theAppleScript"
```

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

### Window Size Token Example

Source: https://wiki.keyboardmaestro.com/token/FrontWindowSize

Shows the output format for the %WindowSize% token, displaying pixel values for the width and height of a window.

```text
1314,1173

width,height
```

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

### Keyboard Maestro TIME Function Examples

Source: https://wiki.keyboardmaestro.com/function/TIME

Demonstrates the usage of the TIME() function in Keyboard Maestro to retrieve unixtime. It shows how to get the current unixtime and how to convert specific dates and times to unixtime. It also highlights the GMT nature of the function and provides an example of using %ICUDateTimeFor% with midday GMT to avoid time zone issues.

```keyboardmaestro
TIME() === NOW() === the current unix time (GMT).
TIME( year, month, day ) === the unix time of the start of the year/month/day (GMT).
TIME( year, month, day, hour, minute, second ) === the unix time of the specified moment (GMT).
```

```keyboardmaestro
%ICUDateTimeFor% TIME(2015, 8, 23,12,0,0) %EEE, MMM d, yyyy%
```

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

### Installing and Aliasing keyboardmaestro CLI Tool

Source: https://wiki.keyboardmaestro.com/trigger/keyboardmaestro

This section provides instructions on how to create a symbolic link to the keyboardmaestro CLI tool for easier access from the command line, and how to set up an alias for convenience.

```shell
sudo ln -s '/Applications/Keyboard Maestro.app/Contents/MacOS/keyboardmaestro' /usr/local/bin/keyboardmaestro
```

```shell
alias keyboardmaestro='/Applications/Keyboard\ Maestro.app/Contents/MacOS/keyboardmaestro'
```

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

### Keyboard Maestro Calculation Examples

Source: https://wiki.keyboardmaestro.com/manual/Calculations_do=edit

Provides a collection of example expressions that can be used in Keyboard Maestro's calculation fields. These examples showcase mathematical operations, date/time functions, trigonometric functions, array indexing, and screen object referencing.

```text
Amount in Dollars * 100
MJD()
NOW() > TIME(2023,3,23,12,2,1)
DOW(TIME(2023,4,4)) = 4
Radius*SIN(20°),Radius*COS(20°)
Window Frame[1]+Window Frame[3]/2,Window Frame.MidY
MOUSEBUTTON() + 2 * MOUSEBUTTON(4)
SCREEN(Internal,Left,10%)
```

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

### Real-world AppleScript example for Keyboard Maestro

Source: https://wiki.keyboardmaestro.com/AppleScript_rev=1483742947

This AppleScript example shows a practical application of getting and setting Keyboard Maestro variables. It retrieves two variables ('SCPT__MainString' and 'SCPT__StringToFind'), processes them to find the position of the substring within the main string, and then sets the result ('SCPT__PosSubStr') as a new Keyboard Maestro variable. Error checking is removed for simplification.

```applescript
---
-- GET REQUIRED KM VARIABLES --
---

tell application "Keyboard Maestro Engine"
  set mainStr to getvariable "SCPT__MainString"
  set subStr to getvariable "SCPT__StringToFind"
end tell

---
-- PROCESS THESE KM VARIABLES --
---

---
-- Get Start of StringToFind --
---
set posSubStr to offset of subStr in mainStr

---
-- SET OUTPUT KM VARIABLE --
---

tell application "Keyboard Maestro Engine" to setvariable "SCPT__PosSubStr" to posSubStr
```

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

### DokuWiki Image Resizing Syntax

Source: https://wiki.keyboardmaestro.com/wiki/syntax_do=diff&rev=1626239576

Demonstrates DokuWiki syntax for displaying images, including resizing to a specific width, or both width and height. It also shows how to resize external images.

```dokuwiki
{{wiki:dokuwiki-128.png?200x50}}
{{http://php.net/images/php.gif?200x50}}
{{wiki:dokuwiki-128.png?50}}
{{wiki:dokuwiki-128.png?200x50}}
{{https://www.php.net/images/php.gif?200x50}}
```

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

### Clipboard Operations using JXA

Source: https://wiki.keyboardmaestro.com/action/Execute_a_JavaScript_For_Automation_do=diff&rev=1461810157

Provides examples of how to get the current clipboard content and copy new text to the clipboard using JavaScript for Automation.

```javascript
var app = Application.currentApplication()
app.includeStandardAdditions = true

//--- GET TEXT ON CLIPBOARD ---
var clipboardStr = app.theClipboard()
console.log("clipboardStr: " + clipboardStr)

var someDataStr = " Example text to put on clipboard" ;

//--- COPY TO CLIPBOARD ---
// Verify using KM Clipboard History Viewer
app.setTheClipboardTo(someDataStr)
```

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

### Keyboard Maestro Token Syntax Examples

Source: https://wiki.keyboardmaestro.com/manual/Tokens

Demonstrates the basic syntax for using Keyboard Maestro tokens, both with and without parameters. Tokens are enclosed in percent signs (%) and can include parameters for more specific data retrieval.

```text
%TokenName%
```

```text
%TokenName%Parameter%
```

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

### Set Variable to Calculation Example

Source: https://wiki.keyboardmaestro.com/manual/Variables_rev=1695977042

Illustrates setting a Keyboard Maestro variable by evaluating a numeric expression. Variables can be directly used in the calculation without tokens.

```Keyboard Maestro
Set Variable "ResultVar" to Calculation "VarName * 3"
```
Tokens:
Raw