Our macOS app exposes actions that lets pro users and developers of other apps send commands to CleanShot. This page explains how it works.
URL scheme is a special type of link that works just like a normal https:// link you use every day. Instead of opening a webpage, it performs a specific action in the CleanShot macOS app.
Commands are sent to CleanShot by constructing a special URL:
cleanshot://command-name?parameter1=value1¶meter2=value2
Opening these links will launch the app and execute the command. For example, here's how you would tell CleanShot to take a fullscreen screenshot:
cleanshot://capture-fullscreen
Launch the "All-In-One" mode.
Example:
cleanshot://all-in-one
Requires CleanShot 4.2 or later.
Opens the standard "Capture Area" mode. You can also provide the optional parameters and capture the screen instantly. Point (0,0) is located in the lower left corner of the screen.
Parameters:
Example:
cleanshot://capture-area
or
cleanshot://capture-area?x=100&y=120&width=200&height=150&display=1
Requires CleanShot 3.5.1 or later.
Repeats last taken screenshot.
Example:
cleanshot://capture-previous-area
Requires CleanShot 3.5.1 or later.
Takes a fullscreen screenshot.
Example:
cleanshot://capture-fullscreen
Requires CleanShot 3.5.1 or later.
Opens "Capture Window" mode.
Example:
cleanshot://capture-window
Requires CleanShot 3.5.1 or later.
Opens "Capture Area" mode with self-timer.
Example:
cleanshot://self-timer
Requires CleanShot 3.5.1 or later.
Opens "Scrolling Capture" mode.
Example:
cleanshot://scrolling-capture
Requires CleanShot 3.5.1 or later.
Opens the specified file as a pinned screenshot.
Parameters:
Example:
cleanshot://pin
or
cleanshot://pin?filepath=/Users/john/Desktop/my%20screenshot.png
Requires CleanShot 3.5.1 or later.
Opens "Record Screen" mode.
Example:
cleanshot://record-screen
Requires CleanShot 3.5.1 or later.
Opens Text Recognition (OCR) tool or extracts text from the specified file. You can also provide the optional parameters (x, y, width, height, display) and capture the text from a specified area on screen. Point (0,0) is located in the lower left corner of the screen.
Parameters:
Example:
cleanshot://capture-text
or
cleanshot://capture-text?filepath=/Users/john/Desktop/my%20screenshot.png
or
cleanshot://capture-text?x=100&y=120&width=200&height=150&display=1
Requires CleanShot 3.8.1 and macOS 10.15 or later.
Opens specified file in Annotate.
Parameters:
Example:
cleanshot://open-annotate
or
cleanshot://open-annotate?filepath=/Users/john/Desktop/my%20screenshot.png
Requires CleanShot 3.8.1 or later.
Opens the image from clipboard in Annotate.
Example:
cleanshot://open-from-clipboard
Requires CleanShot 3.5.1 or later.
Toggles Desktop icons visiblity.
Example:
cleanshot://toggle-desktop-icons
Requires CleanShot 3.5.1 or later.
Hides Desktop icons.
Example:
cleanshot://hide-desktop-icons
Requires CleanShot 3.8.1 or later.
Shows Desktop icons.
Example:
cleanshot://show-desktop-icons
Requires CleanShot 3.8.1 or later.
Opens a new Quick Access Overlay with the specified image or video.
Parameters:
Example:
cleanshot://add-quick-access-overlay?filepath=/Users/john/Desktop/my%20screenshot.png
Requires CleanShot 3.8.1 or later.
Opens capture history.
Example:
cleanshot://open-history
Requires CleanShot 4.4 or later.
Restores the most recently closed file from history.
Example:
cleanshot://restore-recently-closed
Requires CleanShot 3.5.1 or later.