Keyboard Maestro Wiki

Prompt_for_User_Input

Anonymous (anonymous@undisclosed.example.com) — 2023-09-13T04:04:43+00:00

Prompt For User Input Action Prompt For User Input allows you to design a form that will ask for user input, storing the results in Keyboard Maestro Variables. You can prompt for variables with text, checkbox, popup menu, or password fields. [ Prompt For User InputAction ] This action produces this Display:

Custom_HTML_Prompt

Anonymous (anonymous@undisclosed.example.com) — 2021-12-11T15:14:15+00:00

Custom HTML Prompt Action The Custom HTML Prompt action allows you to display an entirely customized window to gather or display information in any way desired (v7.0+). This is quite an advanced action, and requires designing the window in HTML (including

Prompt_for_Snippet

Anonymous (anonymous@undisclosed.example.com) — 2023-10-31T02:25:16+00:00

Prompt For Snippet Action The Prompt For Snippet action (v11.0+) allows you to create a snippet built from a template with fields entered when you execute the macro. The snippet defines the template using the %Ask% token, which can include a size and a default value.

Prompt_for_File

Anonymous (anonymous@undisclosed.example.com) — 2021-10-14T07:53:58+00:00

Prompt for File Action The Prompt for File action (v8+) prompts for selected files or folders and saves the path(s) into a variable. [ Prompt for File ] You can prompt for an existing file(s) or folder(s), or for a new file or folder. You can choose whether you want to select only a single file or folder, or allow selecting multiple files or folders (v10.0+).

Execute_a_JavaScript_in_Custom_Prompt

Anonymous (anonymous@undisclosed.example.com) — 2023-11-28T08:07:21+00:00

Execute JavaScript in Custom HTML Prompt The Execute JavaScript in Custom HTML Prompt action let you execute JavaScript in a Custom HTML Prompt window. [ Execute JavaScript in Custom HTML Prompt Action ] This action allows you to execute a specified JavaScript, either from a file or text entered in the Action itself, and return the results.

Get_Touch_Bar_Selection

Anonymous (anonymous@undisclosed.example.com) — 2021-10-08T06:17:52+00:00

Get Touch Bar Selection Action The Get Touch Bar Selection action (v8+) lets you display a set of buttons in the Touch Bar and process the result. The buttons are separated by vertical bars (|) just like the Prompt for User Input Popup fields. So, for example F__Fail|C__OK|B__Good|A__Excellent

Prompt_With_List

Anonymous (anonymous@undisclosed.example.com) — 2022-09-27T06:37:16+00:00

Prompt With List Action The Prompt With List action (v8+) lets you select from a list of values. The values should be placed on separate lines, and can come from a clipboard, variable, file or text within the action. [ Prompt With List ] You can include a title (which is only displayed when the search field is empty), as well as a default search string (v8.1+). You can also configure the width of the window (narrow, normal, wide, automatic) and whether to allow multiple selections (v8.1+) a…

Prompt_for_Screen_Rectangle

Anonymous (anonymous@undisclosed.example.com) — 2021-10-08T06:15:59+00:00

Prompt for Screen Rectangle Action The Prompt for Screen Rectangle action allows you select an area (or optionally just a point) on the screen. By default, the area will always be a positive rectangle, but you can preserve negative values (and hence the direction of selection) using action (gear) ⚙ menu.

Set_Next_Engine_Window_Position

Anonymous (anonymous@undisclosed.example.com) — 2026-03-27T04:29:38+00:00

Set Next Engine Window Position Action The Set Next Engine Window Position action allows you to specify where the next Keyboard Maestro Engine window will be placed. This applies to pretty much any window, such as text displays. This allows you to specify the position of windows that would otherwise appear in a predefined spot.

Whats_New

Anonymous (anonymous@undisclosed.example.com) — 2026-07-30T04:19:39+00:00

What’s New? Keyboard~~Maestro~~11 expands on the powerful base of previous versions, improving the editor, adding many new actions and triggers, New Macro Wizard, a new Security preference pane, a keyboardmaestro command line tool, support for Apple Text Recognition, and more. Keyboard

Alert

Anonymous (anonymous@undisclosed.example.com) — 2021-10-08T06:16:09+00:00

Alert Action The Alert action displays an alert in a separate window. The alert may contain static text which you enter in the Comment field. The comment field can also contain Text Tokens such as the name of the macro, a variable, a date, the clipboard or numerous other tokens.

Variables

Anonymous (anonymous@undisclosed.example.com) — 2025-03-02T03:08:23+00:00

Variables Like most programming languages, Keyboard Maestro allows you to create Variables to store data for use later on in the same Macro, or in other Macros. Variables can be set from many actions. You can set variables to specific tokenised text, to the result of a

HTMLResult

Anonymous (anonymous@undisclosed.example.com) — 2017-09-05T05:40:37+00:00

The %HTMLResult% token (v8+) returns the result of the last Custom HTML Prompt action in this execution instance. This deprecates the HTML Result Button special variable. See Also Actions * Alert action * Prompt for User Input action * Custom HTML Prompt action Tokens * %AlertButton% token * %PromptButton% token

PromptButton

Anonymous (anonymous@undisclosed.example.com) — 2017-09-05T05:40:35+00:00

The %PromptButton% token (v8+) returns the name of the last selected Prompt for User Input button in this execution instance. This deprecates the Result Button special variable. See Also Actions * Alert action * Prompt for User Input action * Custom HTML Prompt action Tokens * %AlertButton% token * %HTMLResult% token

JavaScript_for_Automation

Anonymous (anonymous@undisclosed.example.com) — 2019-01-12T17:43:46+00:00

JavaScript for Automation (JXA) Discussion Scope and Summary This Wiki article is a broad topic, which covers these major areas: * Introduction to JXA * Using JXA with Keyboard Maestro * JXA Background * Comparison with AppleScript Introduction

Show_Palette_of_Macros

Anonymous (anonymous@undisclosed.example.com) — 2023-12-01T04:44:49+00:00

Show Palette of Macros The Show Palette of Macros action (v8+) allows you to display a palette of selected macros and select which one to execute. [ Show Palette of Macros Action ] You can elect to have only active, only enabled, or all macros displayed — macros selected will be triggered even if they are currently inactive.

Preferences

Anonymous (anonymous@undisclosed.example.com) — 2024-07-16T12:10:53+00:00

Preferences To configure Keyboard~~Maestro, first launch Keyboard~~Maestro and choose Preferences from the Keyboard Maestro menu. [ Preferences General Pane ] The preferences are divided into sections. General Preferences In the General preference pane you can: * enable or disable launching the Keyboard~~Maestro~~Engine at Login.

AlertButton

Anonymous (anonymous@undisclosed.example.com) — 2017-09-05T05:41:17+00:00

The %AlertButton% token (v8+) returns the name of the last selected Alert button in this execution instance. This deprecates the Alert Button special variable. See Also Actions * Alert action * Prompt for User Input action * Custom HTML Prompt action Tokens * %PromptButton% token * %HTMLResult% token

Ask

Anonymous (anonymous@undisclosed.example.com) — 2023-09-13T09:20:31+00:00

Ask Token The %Ask% tokens is a placeholder used in the Prompt for Snippet action to indicate locations where user input for the snippet is required. It takes the form: %Ask<=Variable Name> or <:Default Value>% Where Size is the rough size in characters or the number of lines.

PromptWithListModifiers

Anonymous (anonymous@undisclosed.example.com) — 2022-09-30T09:37:11+00:00

PromptWithListModifiers Token The %PromptWithListModifiers% token returns (v10.2+) the modifiers used to complete the last Prompt With List action. See Also Actions * Prompt With List action * See all Actions Tokens * PromptWithListText token * See all Tokens

PromptWithListText

Anonymous (anonymous@undisclosed.example.com) — 2022-09-30T09:36:47+00:00

PromptWithListText Token The %PromptWithListText% token returns (v10.0+) the text entered in the last Prompt With List action. See Also Actions * Prompt With List action * See all Actions Tokens * PromptWithListModifiers token * See all Tokens

Typed_String

Anonymous (anonymous@undisclosed.example.com) — 2025-10-28T02:40:57+00:00

Typed String Trigger The Typed String trigger lets you execute a macro in response to a sequence of keys. Typed String triggers allow you to use more verbose (and hence descriptive) sequences of keys to trigger a macro. Because the keys first go through to the current application, the keys are usually deleted prior to executing the macro, although with this disabled you can use it in an application that largely ignores keys. Triggers can include non-

Frequently_Asked_Questions

Anonymous (anonymous@undisclosed.example.com) — 2025-10-03T09:53:10+00:00

How do I get started? * Read the Quick Start (Help ➤ Quick Start) which will get you familiar with Keyboard Maestro terminology. * Do the Tutorial (Help ➤ Tutorial). Now you know the basics of creating a macro. * When Keyboard Maestro asks, sign up for the Getting Started email series.

Keyboard_Maestro_Markdown_Library

Anonymous (anonymous@undisclosed.example.com) — 2014-10-18T02:17:09+00:00

With these macros you can write Markdown with any text editor using the help of Keyboard Maestro. They use Keyboard Maestro's variables and user prompt actions. Whenever necessary you get a dialog where you can insert information, such as URLs, text for links, etc. Then when you click OK the text gets inserted into your document and you can continue writing.********

Transition_From_QuicKeys

Anonymous (anonymous@undisclosed.example.com) — 2023-09-05T04:18:46+00:00

Transition from QuicKeys A lot of users are moving from QuicKeys to Keyboard Maestro as the last several major Mac OS X upgrades have left many QuicKeys users stranded without a macro solution. Keyboard Maestro strives to ensure it always uses legitimate Mac

Display_Clipboard

Anonymous (anonymous@undisclosed.example.com) — 2020-12-14T02:56:15+00:00

Display Clipboard Action The Display (Named) Clipboard action displays the system clipboard or a Named Clipboard in a window. Select which clipboard to display from the Display pop-up. This can display an image. You can also display a file by reading the file in to the system clipboard, or in to a named clipboard.

Display_Text

Anonymous (anonymous@undisclosed.example.com) — 2020-12-14T02:56:22+00:00

Display Text Action The Display Text Action provides two very different functions: * Display Text in a Popup Window * Insert Text in a Text Document or Text Field Action Screenshot When you initially insert this Action, it looks like this:

Execute_a_Shell_Script

Anonymous (anonymous@undisclosed.example.com) — 2026-05-25T12:35:09+00:00

Execute a Shell Script The Execute a Shell Script action executes a specified shell script using /bin/sh, either from a file or from the script embedded in the action. Important: * It is best to always specify the language using the #! at the front of the script.

Execute_a_JavaScript_in_Browser

Anonymous (anonymous@undisclosed.example.com) — 2024-01-25T03:06:57+00:00

Execute JavaScript in Browser Actions There are several Execute a JavaScript in Browser actions that let you execute a JavaScript in a web browser page: * Execute a JavaScript in Front Browser * The “Front Browser” is whichever of the following is currently frontmost, or was the last web browser that was frontmost:

Screen_Recording_Permission

Anonymous (anonymous@undisclosed.example.com) — 2021-10-13T01:55:10+00:00

Screen Recording Permission Screen Recording permission allows Keyboard Maestro to capture the image on your screen or in windows. This is used for actions like Find Image on Screen or Screen Capture. If you wish to use these actions in macOS Catalina or later you will need to enable the permission for Keyboard Maestro Engine in the System Preferences, Security & Privacy, Privacy, Screen Recording permissions.

WINDOW

Anonymous (anonymous@undisclosed.example.com) — 2026-01-05T11:13:53+00:00

WINDOW Function The WINDOW() function returns the desired coordinate of the specified window, and can have one or two parameters. Usage * WINDOW(Coordinate) * WINDOW(Index, Coordinate) With two parameters, the first parameter specifies which window in the front application to operate on. With only one parameter, the

Administrative_Details

Anonymous (anonymous@undisclosed.example.com) — 2025-04-28T03:41:19+00:00

Administrative Details Requirements Keyboard~~Maestro~~11 requires macOS 10.13 or later. Distribution You may distribute this application in any way you wish as long as you only distribute the unmodified Keyboard~~Maestro package, as downloaded from

Scripting

Anonymous (anonymous@undisclosed.example.com) — 2023-10-04T08:27:35+00:00

Scripting Executing Scripts The following Execute Script Actions are provided to execute a variety of script languages: * Execute an AppleScript * Execute an Automator Workflow * Execute a JavaScript For Automation * Execute JavaScript in Custom HTML Prompt * Execute a JavaScript in Browser * Execute a Shell Script * Execute Shortcut * Execute a Swift Script * Apply a BBEdit Text Factory to the Clipboard You can specify the script to be executed either by reference to a file or as t…

URL

Anonymous (anonymous@undisclosed.example.com) — 2025-03-07T08:06:17+00:00

URL Trigger Any active macro can be triggered using the kmtrigger: scheme with a URL like this: kmtrigger://macro=[&value=] where "" is either the URL encoded Macro Name, or the Macro UUID "[&value=]" is the option to pass "" as the Macro %TriggerValue% • Do not include the square brackets [ ] in the actual URL. • Do not include the "&value=" without a value.

Scripting

Anonymous (anonymous@undisclosed.example.com) — 2019-07-01T05:11:58+00:00

Scripting on OS X Using Keyboard Maestro While the number of, and power of, native Keyboard Maestro Actions is vast, sometimes you may need to do something that Keyboard Maestro is not well suited to do. But Keyboard Maestro has anticipated, and provided for this, by providing a number of Execute Script Actions, all of these available from the Execute category in the Action List:

Troubleshooting

Anonymous (anonymous@undisclosed.example.com) — 2025-10-03T09:53:40+00:00

Troubleshooting This Wiki article is intended to address situations where you find that Keyboard Maestro does not work as you expect, or works in an unexpected way, and you have been unable to identify the cause and fix it. This article aims to help you resolve this issue and make Keyboard Maestro work as you intend. This article does

Contacts_Permission

Anonymous (anonymous@undisclosed.example.com) — 2022-11-18T06:47:32+00:00

Contacts Permission Contacts permission allows Keyboard Maestro to read your contacts. This is used for the %AddressBook% token, and also used in the Feedback form to fill in your email address if requested. If you wish to use these tokens you will need to enable the permission for Keyboard Maestro and Keyboard Maestro Engine in the System Preferences, Security & Privacy, Privacy, Contacts permissions.

Features

Anonymous (anonymous@undisclosed.example.com) — 2023-09-21T08:13:55+00:00

Features Keyboard~~Maestro is a productivity enhancer with several main functions. It allows you to: * record and design your own macro shortcuts and activate them at any time. * work with clipboard history using Clipboard History Switcher. * work with an unlimited number of saved clipboards using

Tokens

Anonymous (anonymous@undisclosed.example.com) — 2023-10-02T04:10:22+00:00

Tokens Keyboard Maestro provides two means to get information about objects (like web pages and windows) in the user's environment: * Tokens (returns text, used in text token fields) * Functions (returns numbers, used in numeric fields) You can enter a Token in any text field in an Action, and when the Macro is triggered and the Action is executed, the token will be replaced by the value that is returned at that time. This allows you to easily combine static text with dynamic data that is s…