Documentation

Getting Started

Complete a reliable 10-minute setup so screenshots, pin windows, and platform-specific extras work on day one.

What you will complete in 10 minutes

  • Permission setup
  • First screenshot and annotation
  • First pin window
  • Platform-specific feature check
  • Hotkey conflict check

Runtime prerequisites

macOS

  • macOS 14+
  • Screen Recording permission
  • Accessibility permission recommended for window detection and smoother workflows

Windows

  • Windows 10+
  • Microphone permission only when recording audio

Linux beta

SnapTray provides an Ubuntu 22.04 X11 beta as an AppImage. Recording and OCR are not included in the Linux beta and their UI is hidden. Wayland sessions are not supported.

Permission checklist

macOS

Before your first serious capture session, verify:

  1. System Settings > Privacy & Security > Screen Recording
  2. System Settings > Privacy & Security > Accessibility

Enable SnapTray in both places, then restart the app if you changed permissions.

Windows

Most runtime permissions are handled by the OS and installer shape. If you record audio, confirm the selected microphone or audio source is available and permitted.

Step 1: Verify tray runtime (1 min)

  1. Launch SnapTray.
  2. Confirm the tray icon is visible.
  3. Open the menu and verify these entries exist:
    • Region Capture
    • Screen Canvas
    • Settings

If the tray icon does not appear, continue with Troubleshooting.

Step 2: Test screenshot flow (2 min)

  1. Press F2.
  2. Drag any region and confirm the magnifier and size overlay appear.
  3. Add one arrow annotation.
  4. Press Ctrl/Cmd + C and paste into a text editor.
  5. Press Ctrl/Cmd + S and confirm the file was written.

Step 3: Test pin workflow (2 min)

  1. Capture again with F2.
  2. Press Enter to pin the result.
  3. Move, resize, and zoom the pin window.
  4. Switch apps and confirm the pin stays visible.

Step 4: Check platform-specific features (3 min)

macOS and Windows

  1. Start recording from the tray menu or with snaptray record start.
  2. Record 5 to 10 seconds.
  3. Stop and export MP4.
  4. Confirm the output path in Settings > Files.

Recording and OCR are available only on macOS and Windows.

Linux beta

Confirm that OCR and Recording actions are not shown, then continue to hotkey checks.

Step 5: Resolve hotkey conflicts (2 min)

Open Settings > Hotkeys and rebind any conflicting actions.

Minimum recommended actions:

  • Region Capture
  • Screen Canvas
  • Quick Pin
  • Paste

If you want hands-on learning:

If you want feature deep dives: