Deep links
Mouseless handles ‘deep links’ – app-directed urls, e.g. mouseless://toggle-overlay. Any app or script that can open a url can therefore trigger Mouseless commands.
This is useful for:
- Triggering Mouseless commands from a launcher (e.g. Raycast, Alfred), macro tool (e.g. Keyboard Maestro, AutoHotkey), stream deck, or window manager config
- Avoiding conflicts with global hotkey handling between Mouseless and other apps (see App conflicts)
- Scripting and automation
Commands
Currently there are eight commands (in 1.1 preview: eleven):
| Action | Url |
|---|---|
| Toggle overlay | mouseless://toggle-overlay |
| Show overlay | mouseless://show-overlay |
| Hide overlay | mouseless://hide-overlay |
| Toggle free mode | mouseless://toggle-free-mode |
| Enter free mode | mouseless://enter-free-mode |
| Exit free mode | mouseless://exit-free-mode |
| Toggle label mode (1.1 preview) | mouseless://toggle-label-mode |
| Enter label mode (1.1 preview) | mouseless://enter-label-mode |
| Exit label mode (1.1 preview) | mouseless://exit-label-mode |
| Toggle enabled | mouseless://toggle-enabled |
| Open settings | mouseless://settings |
Running Mouseless with the --links CLI flag prints this list.
Using them
Most apps that can trigger a url take one directly – look for an ‘open url’ action – so no terminal is involved.
Where a tool runs a shell command instead (window manager keybinds, scripts), or if you just want to check that a url works:
- macOS:
open mouseless://toggle-overlay - Windows:
start mouseless://toggle-overlay - Linux:
xdg-open mouseless://toggle-overlay
AutoHotkey has its own: Run "mouseless://toggle-overlay"
Behavior when app is disabled
In 1.1 preview: if the app is in the “disabled” state (e.g. you triggered the toggle app enabled action, or toggle-enabled deep link), any deep link that would activate a Mouseless mode will be ignored – e.g. show-overlay, enter-free-mode, enter-label-mode, or a mode toggle when that mode is off.
Callbacks
Callbacks will be added soon so Mouseless can notify other apps when a mode is exited or a command is finished.