### CleanShot Settings Access Source: https://cleanshot.com/docs/-api Opens the main CleanShot settings or a specific settings tab. Supported tabs include general, wallpaper, shortcuts, quickaccess, recording, screenshots, annotate, cloud, advanced, and about. Requires CleanShot 4.7 or later. ```APIDOC cleanshot://open-settings cleanshot://open-settings?tab= ``` -------------------------------- ### CleanShot URL Scheme API Overview Source: https://cleanshot.com/docs/-api Provides an overview of how to use the CleanShot URL scheme to send commands to the macOS application. Commands are structured as URLs with a specific format. ```APIDOC URL Scheme Format: cleanshot://command-name?parameter1=value1¶meter2=value2 Example for fullscreen capture: cleanshot://capture-fullscreen ``` -------------------------------- ### CleanShot Quick Access Overlay Source: https://cleanshot.com/docs/-api Opens a new Quick Access Overlay with a specified image or video file. The filepath parameter is required. Requires CleanShot 3.8.1 or later. ```APIDOC cleanshot://add-quick-access-overlay?filepath= ``` -------------------------------- ### CleanShot All-In-One Mode Source: https://cleanshot.com/docs/-api Launches the 'All-In-One' mode in CleanShot. Supports optional parameters for specifying capture area and display. ```APIDOC /all-in-one Launches the "All-In-One" mode. Parameters: * x (optional) - X-coordinate of the capture area. * y (optional) - Y-coordinate of the capture area. * width (optional) - Width of the capture area. * height (optional) - Height of the capture area. * display (optional) - Specifies the display to capture (1 for main, 2 for secondary, etc.). Defaults to the display with the cursor. Requires CleanShot 4.2 or later. Parameters x, y, width, height, display require version 4.7 or later. Example: cleanshot://all-in-one cleanshot://all-in-one?x=100&y=120&width=200&height=150&display=1 ``` -------------------------------- ### CleanShot Screen Recording Source: https://cleanshot.com/docs/-api Opens CleanShot's "Record Screen" mode. Supports optional parameters for specifying the capture area (x, y, width, height) and the display to capture. Requires CleanShot 3.5.1 or later, with positional parameters requiring version 4.7 or later. ```APIDOC cleanshot://record-screen cleanshot://record-screen?x=&y=&width=&height=&display= ``` -------------------------------- ### CleanShot Annotation Tools Source: https://cleanshot.com/docs/-api Opens files in the CleanShot Annotate tool or opens the image from the clipboard for annotation. If no filepath is provided, the user will be prompted to select a file. Requires CleanShot 3.8.1 or later for opening files and 3.5.1 or later for clipboard access. ```APIDOC cleanshot://open-annotate cleanshot://open-annotate?filepath= cleanshot://open-from-clipboard ``` -------------------------------- ### CleanShot Pinning Files Source: https://cleanshot.com/docs/-api Opens a specified file as a pinned screenshot in CleanShot. If no file path is provided, the user will be prompted to select a file. ```APIDOC /pin Opens the specified file as a pinned screenshot. Parameters: * filepath (optional) - Path to the file (PNG/JPEG) to pin. If omitted, CleanShot prompts for file selection. Requires CleanShot 3.5.1 or later. Example: cleanshot://pin cleanshot://pin?filepath=/Users/john/Desktop/my%20screenshot.png ``` -------------------------------- ### CleanShot Screenshot Capture Commands Source: https://cleanshot.com/docs/-api API commands for various screenshot capture modes in CleanShot, including area, previous area, full screen, window, self-timer, and scrolling capture. Supports optional parameters for capture actions and display targeting. ```APIDOC /capture-area Opens the standard "Capture Area" mode. Supports optional parameters for capturing instantly. Parameters: * x (optional) - X-coordinate of the capture area. * y (optional) - Y-coordinate of the capture area. * width (optional) - Width of the capture area. * height (optional) - Height of the capture area. * display (optional) - Specifies the display to capture (1 for main, 2 for secondary, etc.). Defaults to the display with the cursor. * action (optional) - Action to perform after capture: (copy/save/annotate/upload/pin). Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. Example: cleanshot://capture-area cleanshot://capture-area?action=annotate cleanshot://capture-area?x=100&y=120&width=200&height=150&display=1 /capture-previous-area Repeats the last taken screenshot. Parameters: * action (optional) - Action to perform after capture: (copy/save/annotate/upload/pin). Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. Example: cleanshot://capture-previous-area /capture-fullscreen Takes a fullscreen screenshot. Parameters: * action (optional) - Action to perform after capture: (copy/save/annotate/upload/pin). Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. Example: cleanshot://capture-fullscreen /capture-window Opens "Capture Window" mode. Parameters: * action (optional) - Action to perform after capture: (copy/save/annotate/upload/pin). Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. Example: cleanshot://capture-window /self-timer Opens "Capture Area" mode with self-timer. Parameters: * action (optional) - Action to perform after capture: (copy/save/annotate/upload/pin). Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. Example: cleanshot://self-timer /scrolling-capture Opens "Scrolling Capture" mode. Supports optional parameters for capture location and behavior. Parameters: * x (optional) - X-coordinate of the capture area. * y (optional) - Y-coordinate of the capture area. * width (optional) - Width of the capture area. * height (optional) - Height of the capture area. * display (optional) - Specifies the display to capture (1 for main, 2 for secondary, etc.). Defaults to the display with the cursor. * start (optional) - Automatically start capture (true/false). * autoscroll (optional) - Enable auto-scroll mode (true/false). Requires CleanShot 3.5.1 or later. Parameters start and autoscroll require version 4.7 or later. Example: cleanshot://scrolling-capture cleanshot://scrolling-capture?x=100&y=120&width=200&height=150&start=true&autoscroll=true ``` -------------------------------- ### CleanShot Desktop Icons Management Source: https://cleanshot.com/docs/-api Toggles the visibility of desktop icons, or specifically hides or shows them. Requires CleanShot 3.5.1 or later for toggling and 3.8.1 or later for explicit hide/show actions. ```APIDOC cleanshot://toggle-desktop-icons cleanshot://hide-desktop-icons cleanshot://show-desktop-icons ``` -------------------------------- ### CleanShot History Management Source: https://cleanshot.com/docs/-api Opens the capture history or restores the most recently closed file. Opening history requires CleanShot 4.4 or later, while restoring the last closed file requires 3.5.1 or later. ```APIDOC cleanshot://open-history cleanshot://restore-recently-closed ``` -------------------------------- ### CleanShot Text Recognition (OCR) Source: https://cleanshot.com/docs/-api Opens the Text Recognition (OCR) tool or extracts text from a specified file. Can also capture text from a defined screen area using optional parameters. Supports keeping or removing line breaks. Requires CleanShot 3.8.1 and macOS 10.15 or later. ```APIDOC cleanshot://capture-text cleanshot://capture-text?filepath= cleanshot://capture-text?x=&y=&width=&height=&display=&linebreaks= ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.