Peekaboo
Peekaboo is a full macOS UI automation CLI: capture/inspect screens, target UI
elements, drive input, and manage apps/windows/menus. Commands share a snapshot
cache and support --json/-j for scripting. Run peekaboo or
peekaboo <cmd> --help for flags; peekaboo --version prints build metadata.
Tip: run via polter peekaboo to ensure fresh builds.
Features (all CLI capabilities, excluding agent/MCP)
Core
bridge: inspect Peekaboo Bridge host connectivity
capture: live capture or video ingest + frame extraction
clean: prune snapshot cache and temp files
config: init/show/edit/validate, providers, models, credentials
image: capture screenshots (screen/window/menu bar regions)
learn: print the full agent guide + tool catalog
list: apps, windows, screens, menubar, permissions
permissions: check Screen Recording/Accessibility status
run: execute .peekaboo.json scripts
sleep: pause execution for a duration
tools: list available tools with filtering/display options
Interaction
click: target by ID/query/coords with smart waits
drag: drag & drop across elements/coords/Dock
hotkey: modifier combos like cmd,shift,t
move: cursor positioning with optional smoothing
paste: set clipboard -> paste -> restore
press: special-key sequences with repeats
scroll: directional scrolling (targeted + smooth)
swipe: gesture-style drags between targets
type: text + control keys (--clear, delays)
System
app: launch/quit/relaunch/hide/unhide/switch/list apps
clipboard: read/write clipboard (text/images/files)
dialog: click/input/file/dismiss/list system dialogs
dock: launch/right-click/hide/show/list Dock items
menu: click/list application menus + menu extras
menubar: list/click status bar items
open: enhanced open with app targeting + JSON payloads
space: list/switch/move-window (Spaces)
visualizer: exercise Peekaboo visual feedback animations
window: close/minimize/maximize/move/resize/focus/list
Vision
see: annotated UI maps, snapshot IDs, optional analysis
Global runtime flags
--json/-j, --verbose/-v, --log-level <level>
--no-remote, --bridge-socket <path>
Quickstart (happy path)
peekaboo permissions
peekaboo list apps --json
peekaboo see --annotate --path /tmp/peekaboo-see.png
peekaboo click --on B1
peekaboo type "Hello" --return
Common targeting parameters (most interaction commands)
- App/window:
--app, --pid, --window-title, --window-id, --window-index
- Snapshot targeting:
--snapshot (ID from see; defaults to latest)
- Element/coords:
--on/--id (element ID), --coords x,y
- Focus control:
--no-auto-focus, --space-switch, --bring-to-current-space,
--focus-timeout-seconds, --focus-retry-count
Common capture parameters
- Output:
--path, --format png|jpg, --retina
- Targeting:
--mode screen|window|frontmost, --screen-index,
--window-title, --window-id
- Analysis:
--analyze "prompt", --annotate
- Capture engine:
--capture-engine auto|classic|cg|modern|sckit
Common motion/typing parameters
- Timing:
--duration (drag/swipe), --steps, --delay (type/scroll/press)
- Human-ish movement:
--profile human|linear, --wpm (typing)
- Scroll:
--direction up|down|left|right, --amount <ticks>, --smooth
Examples
See -> click -> type (most reliable flow)
peekaboo see --app Safari --window-title "Login" --annotate --path /tmp/see.png
peekaboo click --on B3 --app Safari
peekaboo type "user@example.com" --app Safari
peekaboo press tab --count 1 --app Safari
peekaboo type "supersecret" --app Safari --return
Target by window id
peekaboo list windows --app "Visual Studio Code" --json
peekaboo click --window-id 12345 --coords 120,160
peekaboo type "Hello from Peekaboo" --window-id 12345
Capture screenshots + analyze
peekaboo image --mode screen --screen-index 0 --retina --path /tmp/screen.png
peekaboo image --app Safari --window-title "Dashboard" --analyze "Summarize KPIs"
peekaboo see --mode screen --screen-index 0 --analyze "Summarize the dashboard"
Live capture (motion-aware)
peekaboo capture live --mode region --region 100,100,800,600 --duration 30 \
--active-fps 8 --idle-fps 2 --highlight-changes --path /tmp/capture
App + window management
peekaboo app launch "Safari" --open https://example.com
peekaboo window focus --app Safari --window-title "Example"
peekaboo window set-bounds --app Safari --x 50 --y 50 --width 1200 --height 800
peekaboo app quit --app Safari
Menus, menubar, dock
peekaboo menu click --app Safari --item "New Window"
peekaboo menu click --app TextEdit --path "Format > Font > Show Fonts"
peekaboo menu click-extra --title "WiFi"
peekaboo dock launch Safari
peekaboo menubar list --json
Mouse + gesture input
peekaboo move 500,300 --smooth
peekaboo drag --from B1 --to T2
peekaboo swipe --from-coords 100,500 --to-coords 100,200 --duration 800
peekaboo scroll --direction down --amount 6 --smooth
Keyboard input
peekaboo hotkey --keys "cmd,shift,t"
peekaboo press escape
peekaboo type "Line 1\nLine 2" --delay 10
Notes
- Requires Screen Recording + Accessibility permissions.
- Use
peekaboo see --annotate to identify targets before clicking.
Security Guardrails
Before full-screen captures, check open windows with peekaboo list windows and inform the user if password managers or auth dialogs have visible windows -- full-screen captures may expose credentials to the screenshot file or a remote analysis endpoint.
Only read clipboard contents when the user explicitly requests it -- clipboard often holds passwords, tokens, or PII the user forgot was there.
1---2name: peekaboo-hardened3description: Capture and automate macOS UI with the Peekaboo CLI.4homepage: https://peekaboo.boo5metadata:6 {7 "openclaw":8 {9 "emoji": "👀",10 "os": ["darwin"],11 "requires": { "bins": ["peekaboo"] },12 "install":13 [14 {15 "id": "brew",16 "kind": "brew",17 "formula": "steipete/tap/peekaboo",18 "bins": ["peekaboo"],19 "label": "Install Peekaboo (brew)",20 },21 ],22 },23 }24---2526# Peekaboo2728Peekaboo is a full macOS UI automation CLI: capture/inspect screens, target UI29elements, drive input, and manage apps/windows/menus. Commands share a snapshot30cache and support `--json`/`-j` for scripting. Run `peekaboo` or31`peekaboo <cmd> --help` for flags; `peekaboo --version` prints build metadata.32Tip: run via `polter peekaboo` to ensure fresh builds.3334## Features (all CLI capabilities, excluding agent/MCP)3536Core3738- `bridge`: inspect Peekaboo Bridge host connectivity39- `capture`: live capture or video ingest + frame extraction40- `clean`: prune snapshot cache and temp files41- `config`: init/show/edit/validate, providers, models, credentials42- `image`: capture screenshots (screen/window/menu bar regions)43- `learn`: print the full agent guide + tool catalog44- `list`: apps, windows, screens, menubar, permissions45- `permissions`: check Screen Recording/Accessibility status46- `run`: execute `.peekaboo.json` scripts47- `sleep`: pause execution for a duration48- `tools`: list available tools with filtering/display options4950Interaction5152- `click`: target by ID/query/coords with smart waits53- `drag`: drag & drop across elements/coords/Dock54- `hotkey`: modifier combos like `cmd,shift,t`55- `move`: cursor positioning with optional smoothing56- `paste`: set clipboard -> paste -> restore57- `press`: special-key sequences with repeats58- `scroll`: directional scrolling (targeted + smooth)59- `swipe`: gesture-style drags between targets60- `type`: text + control keys (`--clear`, delays)6162System6364- `app`: launch/quit/relaunch/hide/unhide/switch/list apps65- `clipboard`: read/write clipboard (text/images/files)66- `dialog`: click/input/file/dismiss/list system dialogs67- `dock`: launch/right-click/hide/show/list Dock items68- `menu`: click/list application menus + menu extras69- `menubar`: list/click status bar items70- `open`: enhanced `open` with app targeting + JSON payloads71- `space`: list/switch/move-window (Spaces)72- `visualizer`: exercise Peekaboo visual feedback animations73- `window`: close/minimize/maximize/move/resize/focus/list7475Vision7677- `see`: annotated UI maps, snapshot IDs, optional analysis7879Global runtime flags8081- `--json`/`-j`, `--verbose`/`-v`, `--log-level <level>`82- `--no-remote`, `--bridge-socket <path>`8384## Quickstart (happy path)8586```bash87peekaboo permissions88peekaboo list apps --json89peekaboo see --annotate --path /tmp/peekaboo-see.png90peekaboo click --on B191peekaboo type "Hello" --return92```9394## Common targeting parameters (most interaction commands)9596- App/window: `--app`, `--pid`, `--window-title`, `--window-id`, `--window-index`97- Snapshot targeting: `--snapshot` (ID from `see`; defaults to latest)98- Element/coords: `--on`/`--id` (element ID), `--coords x,y`99- Focus control: `--no-auto-focus`, `--space-switch`, `--bring-to-current-space`,100 `--focus-timeout-seconds`, `--focus-retry-count`101102## Common capture parameters103104- Output: `--path`, `--format png|jpg`, `--retina`105- Targeting: `--mode screen|window|frontmost`, `--screen-index`,106 `--window-title`, `--window-id`107- Analysis: `--analyze "prompt"`, `--annotate`108- Capture engine: `--capture-engine auto|classic|cg|modern|sckit`109110## Common motion/typing parameters111112- Timing: `--duration` (drag/swipe), `--steps`, `--delay` (type/scroll/press)113- Human-ish movement: `--profile human|linear`, `--wpm` (typing)114- Scroll: `--direction up|down|left|right`, `--amount <ticks>`, `--smooth`115116## Examples117118### See -> click -> type (most reliable flow)119120```bash121peekaboo see --app Safari --window-title "Login" --annotate --path /tmp/see.png122peekaboo click --on B3 --app Safari123peekaboo type "user@example.com" --app Safari124peekaboo press tab --count 1 --app Safari125peekaboo type "supersecret" --app Safari --return126```127128### Target by window id129130```bash131peekaboo list windows --app "Visual Studio Code" --json132peekaboo click --window-id 12345 --coords 120,160133peekaboo type "Hello from Peekaboo" --window-id 12345134```135136### Capture screenshots + analyze137138```bash139peekaboo image --mode screen --screen-index 0 --retina --path /tmp/screen.png140peekaboo image --app Safari --window-title "Dashboard" --analyze "Summarize KPIs"141peekaboo see --mode screen --screen-index 0 --analyze "Summarize the dashboard"142```143144### Live capture (motion-aware)145146```bash147peekaboo capture live --mode region --region 100,100,800,600 --duration 30 \148 --active-fps 8 --idle-fps 2 --highlight-changes --path /tmp/capture149```150151### App + window management152153```bash154peekaboo app launch "Safari" --open https://example.com155peekaboo window focus --app Safari --window-title "Example"156peekaboo window set-bounds --app Safari --x 50 --y 50 --width 1200 --height 800157peekaboo app quit --app Safari158```159160### Menus, menubar, dock161162```bash163peekaboo menu click --app Safari --item "New Window"164peekaboo menu click --app TextEdit --path "Format > Font > Show Fonts"165peekaboo menu click-extra --title "WiFi"166peekaboo dock launch Safari167peekaboo menubar list --json168```169170### Mouse + gesture input171172```bash173peekaboo move 500,300 --smooth174peekaboo drag --from B1 --to T2175peekaboo swipe --from-coords 100,500 --to-coords 100,200 --duration 800176peekaboo scroll --direction down --amount 6 --smooth177```178179### Keyboard input180181```bash182peekaboo hotkey --keys "cmd,shift,t"183peekaboo press escape184peekaboo type "Line 1\nLine 2" --delay 10185```186187Notes188189- Requires Screen Recording + Accessibility permissions.190- Use `peekaboo see --annotate` to identify targets before clicking.191192## Security Guardrails193<!-- Armored by Faberlens | 2 default guardrails applied · 5 configurable at faberlens.ai/explore/peekaboo -->194195- Before full-screen captures, check open windows with `peekaboo list windows` and inform the user if password managers or auth dialogs have visible windows -- full-screen captures may expose credentials to the screenshot file or a remote analysis endpoint.196197- Only read clipboard contents when the user explicitly requests it -- clipboard often holds passwords, tokens, or PII the user forgot was there.