Automate MouseViz by triggering actions via URL schemes from Raycast, Alfred, Keyboard Maestro, or custom scripts.

MouseViz supports a URL scheme API that lets you trigger any action programmatically. URL schemes are special links that, when opened, tell MouseViz to perform a specific action.

The general format is:

mouseviz://command-name?param1=value1&param2=value2

Quick Start

You can trigger URL schemes from Terminal, automation tools, or scripts:

Terminal:

open mouseviz://start-recording

AppleScript:

open location "mouseviz://start-recording"

Recording & Control

Commands to start and stop mouse tracking sessions and access app settings.

Start Recording

mouseviz://start-recording

Begin a new mouse tracking session. If tracking is not already active, this starts a countdown and begins recording mouse movements, clicks, and scrolls.

Available since v1.0

Stop Recording

mouseviz://stop-recording

Stop the current tracking session. If auto-save is enabled, the session data is saved automatically.

Available since v1.0

Open Settings

mouseviz://settings

Open the MouseViz settings window.

Available since v1.0

Study Scripts

Commands for managing UX study scripts — structured task sequences used to guide participants through research sessions.

Open Study Scripts

mouseviz://study-scripts

Open the Study Scripts panel to view, create, and manage your study scripts.

Available since v1.0

Import Study Script

mouseviz://import-study?file=/path/to/script.json

Import a study script from a JSON file on disk. The file must conform to the MouseViz study script schema. After import, the Study Scripts panel opens automatically.

Parameter	Type	Required	Description
`file`	string	Yes	Absolute file path to the study script JSON file.

Examples:

# Import from Desktop
open "mouseviz://import-study?file=/Users/me/Desktop/usability-test.json"

# Import from Downloads
open "mouseviz://import-study?file=/Users/me/Downloads/study.json"