Skip to content

URL Scheme

FoxSnip registers foxsnip://. Opening a link launches or focuses the app and runs a command.

foxsnip://command-name?parameter1=value1&parameter2=value2
  • x, y, width, height in points; origin top-left of the target display; Y down (matches capture rect).
  • display: 1 primary, 2 second, …; omit = display under cursor.
  • All four geometry params must be present with width/height > 0 to skip UI and capture immediately.
action Behavior
(omit) User default (usually Quick Access)
copy Clipboard, no overlay
save Save, no overlay
annotate Open annotate
pin Pin to screen
upload Upload (plan permitting)
Command Purpose
foxsnip://capture-area Area; optional geometry + action
foxsnip://capture-previous-area Last rectangle
foxsnip://capture-fullscreen Full screen; optional display
foxsnip://capture-window Window picker
foxsnip://scrolling-capture Scrolling; optional start, autoscroll
foxsnip://self-timer?delay=5 Countdown full screen (1–60s)
foxsnip://capture-text OCR box
foxsnip://pin?filepath=... Pin local PNG/JPEG
foxsnip://open-annotate?filepath=... Open annotate
foxsnip://add-quick-access-overlay Show overlay for file
foxsnip://toggle-desktop-icons Toggle desktop icons
foxsnip://open-settings Settings; optional tab=
foxsnip://open-home Home
foxsnip://capture / foxsnip://all-in-one Capture bar; geometry → immediate area shot

filepath is an absolute path, URL-encoded; file:///… accepted.

CleanShot uses bottom-left origin. Convert Y with display_height - y - height.

Full command list: ../focal/docs/specs/0013-url-scheme-api.md (in-repo spec, synced with the client).

The scheme also includes FoxClip-oriented record-* commands; this guide focuses on capture. Use FoxClip docs for long-form recording.