|
Some checks failed
macOS CI / PeekabooCore build & tests (push) Has been cancelled
Website (GitHub Pages) / build (push) Has been cancelled
macOS CI / Peekaboo CLI build & tests (push) Has been cancelled
macOS CI / Tachikoma build & tests (push) Has been cancelled
macOS CI / Build macOS apps (Peekaboo + Inspector) (push) Has been cancelled
macOS CI / SwiftLint (core + CLI) (push) Has been cancelled
Website (GitHub Pages) / deploy (push) Has been cancelled
|
||
|---|---|---|
| .. | ||
| agent.md | ||
| app.md | ||
| bridge.md | ||
| capture.md | ||
| clean.md | ||
| click.md | ||
| clipboard.md | ||
| completions.md | ||
| config.md | ||
| daemon.md | ||
| dialog.md | ||
| dock.md | ||
| drag.md | ||
| hotkey.md | ||
| image.md | ||
| learn.md | ||
| list.md | ||
| mcp.md | ||
| menu.md | ||
| menubar.md | ||
| move.md | ||
| open.md | ||
| paste.md | ||
| perform-action.md | ||
| permissions.md | ||
| press.md | ||
| README.md | ||
| run.md | ||
| scroll.md | ||
| see.md | ||
| set-value.md | ||
| sleep.md | ||
| space.md | ||
| swipe.md | ||
| tools.md | ||
| type.md | ||
| visualizer.md | ||
| window.md | ||
| summary | read_when | ||
|---|---|---|---|
| Index of Peekaboo CLI command docs |
|
Command docs index
Core automation
agent.md— run the autonomous agent loop.app.md— launch/quit/focus apps.open.md— open files/URLs with focus controls.window.md— move/resize/focus windows.menu.md,menubar.md— drive app menus and status items.click.md,move.md,scroll.md,swipe.md,drag.md,press.md,type.md,set-value.md,perform-action.md,hotkey.md,sleep.md— input primitives.see.md,image.md,capture.md— screenshots, annotated UI maps, capture sessions.
System & config
config.md,permissions.md,bridge.md,daemon.md,tools.md,clean.md,run.md,learn.md,list.md.completions.md— install shell-native completions for zsh, bash, and fish.- MCP helpers:
mcp.md. - Clipboard:
clipboard.md.
Reference tips
- Each command page lists flags, examples, and troubleshooting. For common pitfalls (permissions, focus, window targeting), see the “Common troubleshooting” section below.
Common troubleshooting
- Background/foreground issues — input commands use background delivery when they can resolve a target process. Element/query clicks can use Accessibility actions; grant Event Synthesizing for keyboard input, coordinates, and click fallback, or pass
--foregroundand ensure the target app/window is focused. - Element not found — run
peekaboo see --annotateto verify AX labels/roles; fall back to coordinates with--coordswhen needed. - Permission errors — re-run
peekaboo permissions grantand restart affected apps if dialogs persist. - Slow or flaky automation — add
--quiet-ms/--heartbeat-secfor capture/live commands; for input commands use--delaywhere available or precede withsleep.