Welcome to the Keyboard Maestro Wiki, a wiki designed for Keyboard Maestro users of all levels of expertise and experience. Keyboard Maestro is a powerful automation tool for macOS which uses Macros to automate your workflow. If you are relatively new to Keyboard Maestro, and need help, then you may want to just jump to Quick Start.

Key Terms:

• “Macro” – Define an automation or workflow.
• “Macro Groups” – Contain Macros and control when they are available.
• “Triggers” – Describe the event that causes a macro to be executed (eg, a hot key).
• “Actions” – Describe what the macro does at each step.
• For a complete list, see Glossary

This wiki aims to help new users get started, and then provide wider and deeper understanding of Keyboard Maestro by explaining how to create and use Macros and Actions in detail, with references and examples. We want to help you get started quickly, and then learn how to take full advantage of Keyboard Maestro. Note that the User Manual is actually part of this Wiki. A search of this Wiki will include the User Manual. Also note that in the editor you can select Help from the gear ⚙ menu in each action and it will take you directly to the wiki reference for that action. When adding Triggers (or Tokens or other things), holding the option key down while selecting the item will similarly take you directly to the help on that thing.

This Wiki mostly provides information about using the Keyboard Maestro.app, or as it is sometimes called, the “Keyboard Maestro editor”. This is the application that you use to create and manage your Keyboard Maestro Macros, and Macro Groups. Separate from the Keyboard Maestro app, is the Keyboard Maestro Engine, which is normally always running in the background. It is the software that detects and processes your Macro triggers, whether or not the Keyboard Maestro.app is running.

The Wiki also includes how to access your Macros and Keyboard Maestro Variables from other tools, like scripts, custom URL scheme, and the Keyboard Maestro Web Server.

This Wiki will respond to a “help” request make from an Action in the Keyboard Maestro.app. For details see Getting Help in the Keyboard Maestro app.

The wiki reflects the most recent version of Keyboard Maestro, usually with notes to indicate when something applies only to recent versions. The official Keyboard Maestro User Manual for the current version is also on the wiki. If you do not immediately see the appropriate topic, try searching the wiki.

• Search is a powerful tool to find the topic/subject of interest.
• Please use the Search box at the top right of every page to find topics (and sub-topics) not listed here.
• Tip: Add an asterisk (*) to the end of a keyword to find both singular and plural forms of the word.
  • For example, operator* will find both operator and operators (without this, the wiki search will not find both unless you search for either operator* or operator|operators).
• For more details, see Searching the Wiki.

You do not need any account to view this wiki. However to edit it, you do need an account, which are manually created as needed. If you spot a typo, just email us with the details and we will get it fixed.

If you are interested in doing more on the wiki, we would love to have real users editing these wiki pages, so if you would like an account to help add to the documentation about Keyboard Maestro, please email us!

For details on how to format a wiki page and on keyboard shortcuts, see Markdown Syntax for Wiki.

In order to ensure consistent styling/formatting throughout the wiki, we have established these guidelines on styling, see:
Style_Guide