URL Scheme
FoxSnip registers foxsnip://. Opening a link launches or focuses the app and runs a command.
foxsnip://command-name?parameter1=value1¶meter2=value2Coordinates & display
Section titled “Coordinates & display”x,y,width,heightin points; origin top-left of the target display; Y down (matches capture rect).display:1primary,2second, …; omit = display under cursor.- All four geometry params must be present with width/height > 0 to skip UI and capture immediately.
action after capture
Section titled “action after capture”| 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) |
Common commands
Section titled “Common commands”| 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.
Migrating from CleanShot
Section titled “Migrating from CleanShot”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).
Recording commands
Section titled “Recording commands”The scheme also includes FoxClip-oriented record-* commands; this guide focuses on capture. Use FoxClip docs for long-form recording.