Troubleshooting
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| Troubleshooting [2021/11/01 10:00] – peternlewis | Troubleshooting [2025/10/03 09:53] (current) – peternlewis | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ~~INTOC~~ | ||
| + | |||
| ====== Troubleshooting ====== | ====== 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 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. |
| ===== When Does the Issue First Occur ===== | ===== When Does the Issue First Occur ===== | ||
| Line 8: | Line 10: | ||
| 1. Immediately after you have installed Keyboard Maestro on a specific Mac -- See [[# | 1. Immediately after you have installed Keyboard Maestro on a specific Mac -- See [[# | ||
| - | 2. Immediately after you have updated Keyboard Maestro to a new version -- See [[#Situation_2_--_After_Update_to_New_Version_of_Keyboard_Maestro|Situation #2]]. | + | 1. Immediately after you have update macOS -- See [[# |
| - | 3. Keyboard Maestro’s behavior changes unexpectedly, | + | 1. Immediately after you have updated Keyboard Maestro to a new version -- See [[#Situation_3_--_After_Update_to_New_Version_of_Keyboard_Maestro|Situation #3]]. |
| - | 4. After you have created a new Macro, or added new Actions, that you have not used before -- See [[#Situation_4_--_After_New_Macros_or_Actions|Situation #4]]. | + | 1. Keyboard Maestro’s behavior changes unexpectedly, |
| + | 1. After you have created a new Macro, or added new Actions, that you have not used before -- See [[#Situation_5_--_After_New_Macros_or_Actions|Situation #5]]. | ||
| ===== General Troubleshooting ===== | ===== General Troubleshooting ===== | ||
| Line 20: | Line 23: | ||
| 1. **Restart Your Mac** | 1. **Restart Your Mac** | ||
| 1. As with all unexpected behavior on your Mac, the first line of recovery is to restart your Mac. | 1. As with all unexpected behavior on your Mac, the first line of recovery is to restart your Mac. | ||
| - | 1. Often it will be a permanent fix, but sometimes the issue will reoccur after some time | + | 1. Often it will be a permanent fix, but sometimes the issue will reoccur after some time. |
| 1. Try this first, and then you only need to do more troubleshooting if the issue returns. | 1. Try this first, and then you only need to do more troubleshooting if the issue returns. | ||
| 1. **Run the [[Troubleshooting# | 1. **Run the [[Troubleshooting# | ||
| - | 1. Choose the “Something expected is not happening” or “Something unexpected is happening” | + | 1. Choose the “Something expected is not happening” or “Something unexpected is happening”. |
| - | 1. Keyboard Maestro will check all of the key requirements and display the results, like this: | + | 1. Keyboard Maestro will check all of the key requirements and display the results. |
| - | {{ : | + | |
| 1. See [[Troubleshooting# | 1. See [[Troubleshooting# | ||
| - | 3. **More Help From Apple**\\ | ||
| - | [If an app freezes or quits unexpectedly on Mac - Apple Support](https:// | ||
| ==== Situation #1 -- New Install ==== | ==== Situation #1 -- New Install ==== | ||
| Line 45: | Line 45: | ||
| 1. To fix, see [How to Enable Google Chrome to Respond to KM Actions](https:// | 1. To fix, see [How to Enable Google Chrome to Respond to KM Actions](https:// | ||
| - | ==== Situation #2 -- After Update to New Version of Keyboard Maestro ==== | + | ==== Situation #2 -- After a System Update ==== |
| + | |||
| + | If Keyboard Maestro had been running fine, and then does not work as expected after upgrading macOS: | ||
| + | |||
| + | 1. Immediately after a system update, it is wise to Restart an additional time. Many times we have found the system to not be in a totally stable state after an update, and a Restart gives a clean fresh start. | ||
| + | 1. If lots of macros are failing, run the _Interactive Help Wizard_ from the Keyboard Maestro Editor Help menu and see if that helps. | ||
| + | 1. Check the Security preferences pane and verify that you have all the relevant security permissions. | ||
| + | 1. Keep in mind that after a system update (or any specific application update), your macro might break simply because things in the system or application have changed since the macro was created. See if the macro simply needs adjusting. | ||
| + | |||
| + | ==== Situation #3 -- After Update to New Version of Keyboard Maestro ==== | ||
| If Keyboard Maestro had been running fine, and then does not work as expected after an upgrade, then do the following: | If Keyboard Maestro had been running fine, and then does not work as expected after an upgrade, then do the following: | ||
| Line 51: | Line 60: | ||
| 1. As usual, restart your Mac. This will likely fix the issue. | 1. As usual, restart your Mac. This will likely fix the issue. | ||
| 1. Run the _Interactive Help Wizard_ from the Keyboard Maestro Editor Help menu. | 1. Run the _Interactive Help Wizard_ from the Keyboard Maestro Editor Help menu. | ||
| - | 1. If the issue persists, then you _may_ have found a bug. To confirm and get feedback for possible workarounds, | + | 1. If the issue persists, then you _may_ have found a bug. To confirm and get feedback for possible workarounds, |
| - | 1. Your versions of macOS and Keyboard Maestro | + | 1. Your versions of macOS and Keyboard Maestro. |
| - | 1. Observed Behavior | + | 1. Observed Behavior. |
| - | 1. Expected Behavior | + | 1. Expected Behavior. |
| 1. Upload example Macro that produces the issue. | 1. Upload example Macro that produces the issue. | ||
| - | ==== Situation #3 -- After Working Fine for a While ==== | + | ==== Situation #4 -- After Working Fine for a While ==== |
| 1. If Keyboard Maestro has been working well, as expected, for a while (let's say a week or more), and then it suddenly behaves in an unexpected manner, then most likely that is due to something that has recently changed.\\ | 1. If Keyboard Maestro has been working well, as expected, for a while (let's say a week or more), and then it suddenly behaves in an unexpected manner, then most likely that is due to something that has recently changed.\\ | ||
| So, ask yourself what has changed: | So, ask yourself what has changed: | ||
| - | 1. Keyboard Maestro update | + | 1. Keyboard Maestro update. |
| - | 1. macOS updates | + | 1. macOS updates. |
| - | 1. Install of new apps, or app updates | + | 1. Install of new apps, or app updates. |
| - | 1. Especially any utilities (like Clipboard managers) | + | 1. Especially any utilities (like Clipboard managers). |
| - | 1. etc | + | 1. etc. |
| - | 1. If you identify a recent change, then you need to determine if that is causing the issue with Keyboard Maestro\\ | + | 1. If you identify a recent change, then you need to determine if that is causing the issue with Keyboard Maestro. The best way to do this is to [Start up your Mac in safe mode](https:// |
| - | The best way to do this is to [Start up your Mac in safe mode](https:// | + | |
| 1. This will prevent all start-up items from starting. | 1. This will prevent all start-up items from starting. | ||
| 1. Then launch KM and test your macros. | 1. Then launch KM and test your macros. | ||
| Line 74: | Line 82: | ||
| 1. If that does not help, then you can search (using the Browser Find menu) the below Keyboard Maestro specific issues to find one or more that relates to your situation. | 1. If that does not help, then you can search (using the Browser Find menu) the below Keyboard Maestro specific issues to find one or more that relates to your situation. | ||
| - | ==== Situation #4 -- After New Macros or Actions ==== | + | ==== Situation #5 -- If a Macro “Does Nothing” ==== |
| + | |||
| + | 1. The issue is most likely caused by improper macro activation. | ||
| + | 1. Use the Interactive Help in the Help menu to determine if the macro is active. | ||
| + | 1. It will also show you if the macro triggers. | ||
| + | 1. If it triggers, it might be a problem with your actions, see the next section. | ||
| + | |||
| + | ==== Situation #6 -- After New Macros or Actions ==== | ||
| 1. The issue is most likely caused by improper use of the Action. | 1. The issue is most likely caused by improper use of the Action. | ||
| 1. Click on the _Gear_ popup menu at the top right of the Action, and select _Help_ to get detailed help from the Wiki. | 1. Click on the _Gear_ popup menu at the top right of the Action, and select _Help_ to get detailed help from the Wiki. | ||
| - | 1. If the previous Action was a command to an app, then you may need a short _Pause_ after that Action. | + | 1. If the previous Action was a command to an app, changed the window or focus, then you may need a short _Pause_ after that Action. |
| - | 1. If you still can't resolve the issue, then submit a topic to the [Keyboard Maestro Forum](https:// | + | 1. If the action might be failing, first ensure the the Keyboard Maestro Engine can display notification (otherwise it might be telling you the action is failing and you are not seeing it). |
| + | 1. You can also check for any errors reported in the Log file. Choose Open Logs Folder from the Help menu and you can see anything reported in the Engine.log file that might indicate a problem - this will also confirm that the macro is triggering - if not, check out the previous section for answers related to that. | ||
| + | 1. If you still can't resolve the issue, then submit a topic to the [[/Forum|Keyboard Maestro Forum]]. Please read [Tip: How Do I Get The Best Answer in the Shortest Time? | ||
| ===== Use the Interactive Help Wizard ===== | ===== Use the Interactive Help Wizard ===== | ||
| Line 85: | Line 102: | ||
| Generally Keyboard Maestro will only do what you tell it to do, but sometimes that can still result in something you don’t expect happening. | Generally Keyboard Maestro will only do what you tell it to do, but sometimes that can still result in something you don’t expect happening. | ||
| - | * Choose Interactive Help (previously Assistance) | + | * Choose Interactive Help from the Keyboard Maestro Editor Help menu. |
| - | + | ||
| - | {{: | + | |
| * Then choose one of the following: | * Then choose one of the following: | ||
| Line 93: | Line 108: | ||
| * Something expected is _not_ happening... | * Something expected is _not_ happening... | ||
| - | ==== Something Expected is Not Happening ==== | + | Then follow |
| - | + | ||
| - | * Click the *Something Expected is _not_ happening* link. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Click _Continue_ | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Click _Continue_ | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Click _Continue_ | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | ==== Something Unexpected is Happening ==== | + | |
| - | + | ||
| - | * Click the *Something unexpected is happening* link. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | * Click the *Quit the Engine* link. | + | |
| - | * If the issue remains, the problem is almost certainly unrelated to Keyboard Maestro. | + | |
| - | * Click the *Launch the Engine* link to relaunch the Keyboard Maestro Engine. | + | |
| - | * If the issue returns, check the recently executed macros which are listed in the window. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | * If the issue remains and there are no macros being triggered, ask Support for help. | + | |
| ===== Macro Issues ===== | ===== Macro Issues ===== | ||
| ==== Macros Not Firing (Triggered) ==== | ==== Macros Not Firing (Triggered) ==== | ||
| - | |||
| A relatively common situation occurs when a macro you expect to fire is not firing. | A relatively common situation occurs when a macro you expect to fire is not firing. | ||
| Line 157: | Line 137: | ||
| * If the macro triggers, but does not do what you expect, then you need to look at the actions. | * If the macro triggers, but does not do what you expect, then you need to look at the actions. | ||
| - | ==== Macros Not Firing After I Login ==== | + | ==== Macros Not Firing After You Login ==== |
| - | The macros are all enabled | + | The macros are all performed |
| ==== Run-Away Login Macros ==== | ==== Run-Away Login Macros ==== | ||
| Line 169: | Line 149: | ||
| - **Launch the Keyboard Maestro editor app without starting its _Engine_** | - **Launch the Keyboard Maestro editor app without starting its _Engine_** | ||
| - | - Hold down < | + | - Hold down < |
| - This will quit the Keyboard Maestro _Engine_ and start the Keyboard Maestro app _without_ starting its _Engine_. | - This will quit the Keyboard Maestro _Engine_ and start the Keyboard Maestro app _without_ starting its _Engine_. | ||
| - | - Locate the problem Macro, and remove the trigger or disable it\\ | + | - Locate the problem Macro, and remove the trigger or disable it. |
| - **Restart Your Mac in [[https:// | - **Restart Your Mac in [[https:// | ||
| - Use this option if //none of the above work//. | - Use this option if //none of the above work//. | ||
| - | - Hold down < | + | - Hold down < |
| - This will prevent the apps/ | - This will prevent the apps/ | ||
| - Then Hold down < | - Then Hold down < | ||
| Line 186: | Line 166: | ||
| ==== Timing Between Actions ==== | ==== Timing Between Actions ==== | ||
| - | Here's a common situation: You' | + | A common situation |
| Most of the actions in a script are immediate: Keyboard Maestro will execute them and then attempts to wait until they are completed, but for some actions it is not possible to tell when the action is completed. | Most of the actions in a script are immediate: Keyboard Maestro will execute them and then attempts to wait until they are completed, but for some actions it is not possible to tell when the action is completed. | ||
| Line 192: | Line 172: | ||
| To make the macro wait, there are two options: | To make the macro wait, there are two options: | ||
| - | * Pause: this adds a pause of a fixed length | + | * [[action: |
| - | * Pause Until: this tells Keyboard Maestro to wait until something happens | + | * [[action: |
| + | * [[action: | ||
| - | Often, adding pauses to your macro will solve the timing issues. A pause of 0.3 seconds is often enough, but in some cases (e.g. a ' | + | Often, adding pauses to your macro will solve the timing issues. A pause of 0.3 seconds is often enough, but in some cases (e.g. a [[action: |
| - | ===== Action | + | ===== Typing |
| ==== Sometimes Typing in Password Fields Drops Characters ==== | ==== Sometimes Typing in Password Fields Drops Characters ==== | ||
| Line 207: | Line 188: | ||
| This happens most commonly when you have a hot key trigger with the same key (eg Control-T) as a key you want to type in to a password field (eg "Hello there" | This happens most commonly when you have a hot key trigger with the same key (eg Control-T) as a key you want to type in to a password field (eg "Hello there" | ||
| + | ==== Sometimes Typing results in Characters Missing or out of Order ==== | ||
| + | This typically happens in web fields (especially Facebook) or cross platform apps. | ||
| + | |||
| + | The system has a queue for keyboard events, so they are sent by Keyboard Maestro in the correct order and then processed by the system | ||
| + | |||
| + | Typically you see this in fields where the app is processing the field. Essentially the app reads the field, does some processing or checking and then writes the field back, and the typing happens fast enough (as could keyboard typing if you could type fast enough) that changes happen while the field is being read/ | ||
| + | |||
| + | You can slow the typing down by using Set Action Delay action (https:// | ||
| + | |||
| + | ==== Everything is lowercase in remote desktops/ | ||
| + | |||
| + | Yes, unfortunately these types of environments seem to miss the shift key and the consequential uppercasing of lettings and symbols. | ||
| ===== Clipboard Issues ===== | ===== Clipboard Issues ===== | ||
| Line 284: | Line 277: | ||
| Eg: | Eg: | ||
| + | * Set Clipboard to Styled Text %CurrentClipboard% | ||
| + | * Filter Clipboard: Remove Styles | ||
| - | Set Clipboard to Styled Text %CurrentClipboard% | + | ===== Keyboard Maestro Issues ===== |
| - | Filter Clipboard: Remove Styles | + | |
| + | ==== Accessibility ==== | ||
| - | + | Keyboard Maestro | |
| - | ===== Keyboard Maestro | + | |
| - | + | ||
| - | ==== App Freezes (Locks up, Spinning Beachball) or Other Strange Behavior due to SIMBL ==== | + | |
| - | + | ||
| - | If Keyboard Maestro freezes, locks-up or is exhibiting very strange behavior, check to see if you have [[https:// | + | |
| - | + | ||
| - | `/ | + | |
| - | + | ||
| - | **SIMBL** is very clever, but some of its extensions can lead to bizarre behavior, crashes, freezes and other strange, unexpected behavior in one or more apps or the macOS itself. | + | |
| - | + | ||
| - | **More Help From Apple: | + | |
| - | [If an app freezes or quits unexpectedly on Mac - Apple Support](https:// | + | |
| ==== Secure Input Mode ==== | ==== Secure Input Mode ==== | ||
| Line 309: | Line 292: | ||
| Keyboard Maestro 6 and later detects the case where the Secure Input Mode flag is left on and alerts you to the issue. | Keyboard Maestro 6 and later detects the case where the Secure Input Mode flag is left on and alerts you to the issue. | ||
| - | Choose Interactive Help (v9+) (previously Assistance in v8) from the Help menu and click the *Something unexpected is happening* link and Keyboard Maestro will tell you if there are any obvious issues. | + | Choose Interactive Help (v9+) from the Help menu and click the *Something unexpected is happening* link and Keyboard Maestro will tell you if there are any obvious issues. |
| A related, very unusual case is that Terminal has a Secure Keyboard Entry mode (in the Terminal menu) - if you turn that on, that may also cause problems. | A related, very unusual case is that Terminal has a Secure Keyboard Entry mode (in the Terminal menu) - if you turn that on, that may also cause problems. | ||
| Line 363: | Line 346: | ||
| assuming that `Keyboard Maestro.app` is in the Applications folder. | assuming that `Keyboard Maestro.app` is in the Applications folder. | ||
| - | |||
| - | |||
| ===== Palette Issues ===== | ===== Palette Issues ===== | ||
| Line 377: | Line 358: | ||
| If you wish to briefly hide all the palettes (eg while watching a video), you can use the [Conceal Macro Palettes until Application Switch](https:// | If you wish to briefly hide all the palettes (eg while watching a video), you can use the [Conceal Macro Palettes until Application Switch](https:// | ||
| - | |||
| - | ==== White Menus or White Switchers or Palettes ==== | ||
| - | |||
| - | For some people, the menus or switchers sometimes appear completely white. | ||
| - | It is also seen in Photoshop and maybe other applications. | ||
| - | |||
| - | According to those threads, Adobe believe the issue to be a Mac OS X bug, and have a patch solution to resolve it (within Photoshop) and are working with Apple to resolve the problem properly. | ||
| - | |||
| - | This issue appears to have been resolved in 10.9.3 and later. | ||
| - | |||
| Line 408: | Line 379: | ||
| ===== Script Issues ===== | ===== Script Issues ===== | ||
| - | |||
| - | ==== Execute Script Actions are Not Working ==== | ||
| - | |||
| - | Your variables are sent to your scripts by placing them in environment variables. However, the total size of the environment variables is 256k. Therefore if the total size of your variables exceeds about 256k scripts will stop working. | ||
| - | |||
| Line 420: | Line 386: | ||
| To learn how to set a path in a Keyboard Maestro Execute Shell Script Action, see | To learn how to set a path in a Keyboard Maestro Execute Shell Script Action, see | ||
| - | [[action: | + | [[action: |
| Line 492: | Line 458: | ||
| ===== macOS Issues ===== | ===== macOS Issues ===== | ||
| - | ==== Yosemite and Accessibility Settings Problems ==== | ||
| - | Yosemite (10.10 GM1 through 10.10.2) has a serious problem adding applications to the accessibility pane properly. | + | ==== Mojave and Later Security Preferences Issues ==== |
| - | This bug was finally resolved in Yosemite 10.10.3. So if you are having problems | + | Sadly the System Security Permissions have been rather buggy since Mojave, and this continues right through to Monterey. Combined with the increasing number of different permissions |
| - | + | ||
| - | If you must stay on version 10.10.0-2 for any reason, see the forum topic on [possible solutions](http:// | + | |
| - | + | ||
| - | ==== Mojave and Catalina Issues ==== | + | |
| See Forum topics: | See Forum topics: | ||
| - [Resolving Catalina/ | - [Resolving Catalina/ | ||
| - | |||
| - | |||
| - | ==== Big Sur Issues ==== | ||
| - | |||
| - | See Forum topics | ||
| - [Resolving Big Sur Accessibility, | - [Resolving Big Sur Accessibility, | ||
| - [macOS Big Sur: Using and Upgrading To ](https:// | - [macOS Big Sur: Using and Upgrading To ](https:// | ||
| - | |||
| ===== Virtual Machine Issues ===== | ===== Virtual Machine Issues ===== | ||
| Line 518: | Line 473: | ||
| In Parallels, make sure the ”Enabled Mac OS X system shortcuts” preference is enabled, which will ensure Parallels reads the keyboard from the keyboard queue. | In Parallels, make sure the ”Enabled Mac OS X system shortcuts” preference is enabled, which will ensure Parallels reads the keyboard from the keyboard queue. | ||
| - | |||
| - | |||
| ===== Other Issues ===== | ===== Other Issues ===== | ||
Troubleshooting.1635760857.txt.gz · Last modified: by peternlewis
