Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.62 KB

permissions.md

File metadata and controls

40 lines (30 loc) · 1.62 KB
summary read_when
Grant required macOS permissions and understand performance trade-offs for Peekaboo.
Peekaboo cannot capture screens or focus windows
tuning capture performance or troubleshooting permission dialogs

Permissions & Performance

Requirements

  • macOS 15.0+ (Sequoia) – core automation APIs depend on Sequoia.
  • Screen Recording (required) – enables CGWindow capture and multi-app automation.
  • Accessibility (recommended) – improves window focus, menu interaction, and dialog control.

Granting Permissions

  1. Screen Recording

    • System Settings → Privacy & Security → Screen & System Audio Recording.
    • Enable Terminal, your editor, or whatever shell runs peekaboo.
    • Benefit: fast CGWindow enumeration and background captures.

  2. Accessibility

    • System Settings → Privacy & Security → Accessibility.
    • Enable the same terminals/IDEs so Peekaboo can send clicks/keystrokes reliably.

  3. Automation Check

    peekaboo permissions check
peekaboo permissions request screen-recording
peekaboo permissions request accessibility

Performance Tips

  • Hybrid enumeration – with Screen Recording enabled, Peekaboo prefers the CGWindowList APIs and falls back to AX only when necessary.
  • Built-in timeouts – window/menu operations have ~2 s default timeouts to avoid hangs; adjust via CLI options if needed.
  • Parallel processing – when both permissions are enabled, window queries and captures stream concurrently.

If automation feels sluggish, confirm permissions, then re-run with --verbose to inspect timings.