Development

SnippetsLab defines a JSON library format and can import data from any .json file that conforms to the required format, as discussed below. This makes it possible to import from arbitrary third-party sources as long as they are converted to the supported format first. The JSON format is designed to support the app’s full feature set while allowing users to use only a subset of features. For example, you can generate and import a JSON file that contains only snippets (no folders, tags, etc.). Most attributes are optional, with a few exceptions that are marked as “required” in the description. Schema Root Key path: (root) Field Type Description contents Dictionary A dictionary containing all folders, snippets, smart groups, tags, and shortcuts. Required. Contents Key path: (root).contents Field Type Description folders [Folder] An array of all root-level folders. snippets [Snippet] An array of all snippets. smartGroups [SmartGroup] An array of all smart groups. tags [Tag] An array of all tags. shortcuts [Shortcut] An array of all shortcuts. Folder Key path: (root).contents.folders[*]. Field Type Description title String Name of the folder. uuid String Unique identifier. See discussion. Required. children [Folder] An array of subfolders inside the folder. Snippet Key path: (root).contents.snippets[*]. Field Type Description title String Name of the snippet. Required. folder String UUID of the folder that this snippet belongs to. tags [String] An array of UUIDs of tags assigned to this snippet. pinned Boolean Indicates whether this snippet is pinned. dateCreated String Creation date of the snippet. See discussion. dateModified String Last modification date of the snippet. See discussion. fragments [Fragment] An array of fragments. Each snippet must have at least one fragment. Required. Fragment Key path: (root).contents.snippets[*].fragments[*]. Field Type Description title String Name of the fragment. This is often omitted if there is only one fragment. note String Text for the notes area. noteAttributes [NotesAttribute] Rich text attributes for the notes. content String The content of the snippet. Required. language String Language of the fragment. See discussion. dateCreated String Creation date of the fragment. See discussion. dateModified String Last modification date of the fragment. See discussion. Smart Group Key path: (root).contents.smartGroups[*]. Field Type Description title String Name of the smart group. uuid String Unique identifier. See discussion. Required. predicate String Search predicate of the smart group. See discussion. Required. Tag Key path: (root).contents.tags[*]. Field Type Description title String Name of the tag. uuid String Unique identifier. See discussion. Required. Shortcut Key path: (root).contents.shortcuts[*]. Field Type Description uuid String Unique identifier of the folder, smart group or tag that this shortcut links to. Required. Note Attribute Key path: (root).contents.snippets[*].fragments[*].noteAttributes[*]. Field Type Description name String Name of the attribute, for example strong, underline, link, etc. Required. range [Int] Range of this attribute, in the format of [location, length]. The offsets are measured in UTF-16 code units. Required. stringValue String An optional string value for the attribute, currently only used for the link attribute, where this should be the URL for the link. Discussion UUID: In the JSON format, UUIDs are used for cross-referencing between entities. For example, each folder must have a uuid, whose value is then referenced by all snippet located within the folder. Similarly, a shortcut references the target folder, smart group, or tag with their UUID. The UUIDs do not have to conform to any specific format, but they must be unique across all UUIDs in the JSON file. Date: All dates, such as dateCreated and dateModified, are formatted as strings that conform to the ISO 8601 standard. For example, 2011-08-29T20:34:41Z. Language: In a fragment, the language is expressed by a Pygments lexer name. See Pygments documentation for a complete list. Note that some languages listed there may not be supported by SnippetsLab. Predicate: Each smartGroup must have a predicate attribute indicating the search criteria. This predicate is used by NSPredicate internally. Example { "contents": { "folders": [ { "title": "Publishing", "uuid": "D3F0277B-6230-46C1-9D2E-3E1B8CE509BF" }, { "title": "Graphic Design", "uuid": "D42BB115-44C4-4931-ACF8-8AD5F2D1778C", "children": [ { "title": "Subfolder 1", "uuid": "4D356EC0-6118-4DDE-B09C-EC4116698877", }, { "title": "Subfolder 2", "uuid": "2C6E47F2-A23F-4B4D-B63E-B1C37973A7BC", } ]

Docs Why updates expire? URL Scheme API Security & Legal CleanShot Security Bug Bounty Program EULA CleanShot Cloud Terms of Service Privacy Policy Subprocessors DPA URL scheme API Our macOS app exposes actions that lets pro users and developers of other apps send commands to CleanShot. This page explains how it works. Overview 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&parameter2=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 ✨  All-In-One mode /all-in-one Launch the "All-In-One" mode. You can also provide the optional parameters to open the tool at specific location. Point (0,0) is located in the lower left corner of the screen. Parameters: x (optional) y (optional) width (optional) height (optional) display (optional) - Capture a specified display: 1 is the main display, 2 is the secondary, etc. If not specified, CleanShot will use the display which the cursor is on. Example: cleanshot://all-in-one or cleanshot://all-in-one?x=100&y=120&width=200&height=150&display=1 Requires CleanShot 4.2 or later. Parameters x, y, width, height, display require version 4.7 or later. 📸  Screenshots /capture-area 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: x (optional) y (optional) width (optional) height (optional) display (optional) - Capture a specified display: 1 is the main display, 2 is the secondary, etc. If not specified, CleanShot will use the display which the cursor is on. action (optional) - Perform a specific action after taking a screenshot: (copy/save/annotate/upload/pin). Example: cleanshot://capture-area or cleanshot://capture-area?action=annotate or cleanshot://capture-area?x=100&y=120&width=200&height=150&display=1 Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. /capture-previous-area Repeats last taken screenshot. Parameters: action (optional) - Perform a specific action after taking a screenshot: (copy/save/annotate/upload/pin) Example: cleanshot://capture-previous-area Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. /capture-fullscreen Takes a fullscreen screenshot. Parameters: action (optional) - Perform a specific action after taking a screenshot: (copy/save/annotate/upload/pin) Example: cleanshot://capture-fullscreen Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. /capture-window Opens "Capture Window" mode. Parameters: action (optional) - Perform a specific action after taking a screenshot: (copy/save/annotate/upload/pin) Example: cleanshot://capture-window Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. /self-timer Opens "Capture Area" mode with self-timer. Parameters: action (optional) - Perform a specific action after taking a screenshot: (copy/save/annotate/upload/pin) Example: cleanshot://self-timer Requires CleanShot 3.5.1 or later. Parameter action requires version 4.7 or later. /scrolling-capture Opens "Scrolling Capture" mode. You can also provide the optional parameters to open the tool at specific location. Point (0,0) is located in the lower left corner of the screen. Parameters: x (optional) y (optional) width (optional) height (optional) display (optional) - Capture a specified display: 1 is the main display, 2 is the secondary, etc. If not specified, CleanShot will use the display which the cursor is on. start (optional) - Automatically start capture (true/false) autoscroll (optional) - Enable auto-scroll mode (true/false) Example: cleanshot://scrolling-capture or cleanshot://scrolling-capture?x=100&y=120&width=200&height=150&start=true&autoscroll=true Requires CleanShot 3.5.1 or later. Parameters start and autoscroll require version 4.7 or later. /pin Opens the specified file as a pinned screenshot. Parameters: filepath (optional) - path to the file (PNG/JPEG) you want to pin. If you don’t pass this parameter, CleanShot will ask to select the file manually. Example: cleanshot://pin or cleanshot://pin?filepath=/Users/john/Desktop/my%20screenshot.png Requires CleanShot 3.5.1 or later. 🎥  Screen Recording /record-screen Opens "Record Screen" mode. You can also provide the optional parameters to open the tool at specific location. Point (0,0) is located in the lower left corner of the screen. Parameters: x (optional) y (optional) width (optional) height (optional) display (optional) - Capture a specified display: 1 is the main display, 2 is t