Peekaboo/docs/commands
Peter Steinberger dda07c245f
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
fix: document element IDs as opaque (#202)
2026-06-24 09:11:52 +01:00
..
agent.md docs: refresh runtime and provider guidance 2026-06-12 00:45:45 -07:00
app.md fix: harden background computer automation 2026-06-13 21:44:58 -07:00
bridge.md fix(cli): clarify bridge permission source 2026-05-04 09:09:49 +01:00
capture.md docs: refresh runtime and provider guidance 2026-06-12 00:45:45 -07:00
clean.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
click.md fix: document element IDs as opaque (#202) 2026-06-24 09:11:52 +01:00
clipboard.md fix(clipboard): validate alternate text payloads (#180) 2026-06-06 17:42:04 -07:00
completions.md feat(cli): add completions 2026-05-05 06:38:24 +01:00
config.md docs: refresh runtime and provider guidance 2026-06-12 00:45:45 -07:00
daemon.md fix: harden background computer automation 2026-06-13 21:44:58 -07:00
dialog.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
dock.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
drag.md refactor(cli): remove stale observation shims 2026-05-07 10:18:22 +01:00
hotkey.md docs: document input delivery modes 2026-06-01 01:46:31 +01:00
image.md feat: add daemon-backed fast capture and model refresh 2026-05-10 09:46:55 +01:00
learn.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
list.md fix: harden background computer automation 2026-06-13 21:44:58 -07:00
mcp.md docs: refresh runtime and provider guidance 2026-06-12 00:45:45 -07:00
menu.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
menubar.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
move.md refactor(cli): remove stale observation shims 2026-05-07 10:18:22 +01:00
open.md fix: harden background computer automation 2026-06-13 21:44:58 -07:00
paste.md docs: document input delivery modes 2026-06-01 01:46:31 +01:00
perform-action.md fix: document element IDs as opaque (#202) 2026-06-24 09:11:52 +01:00
permissions.md fix: harden background computer automation 2026-06-13 21:44:58 -07:00
press.md docs: document input delivery modes 2026-06-01 01:46:31 +01:00
README.md fix: harden background computer automation 2026-06-13 21:44:58 -07:00
run.md fix(process): expand script file paths 2026-05-07 19:17:34 +01:00
scroll.md docs(ui-input): document action-first automation 2026-05-08 08:44:40 +01:00
see.md fix(cli): keep implicit see screenshots private (#200) 2026-06-24 00:58:16 +01:00
set-value.md fix: document element IDs as opaque (#202) 2026-06-24 09:11:52 +01:00
sleep.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
space.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00
swipe.md refactor(cli): remove stale observation shims 2026-05-07 10:18:22 +01:00
tools.md feat(cli): expose MCP wrappers and capture action 2026-06-07 07:35:00 +01:00
type.md fix(type): remove default keystroke delay 2026-06-13 02:20:30 -04:00
visualizer.md perf(visualizer): fail fast when unavailable 2026-05-07 02:54:41 +01:00
window.md docs(cli): standardize peekaboo help/examples (#71) (thanks @vabole) 2026-03-13 03:47:30 +00:00

summary read_when
Index of Peekaboo CLI command docs
browsing available Peekaboo CLI commands
linking to specific 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 --foreground and ensure the target app/window is focused.
  • Element not found — run peekaboo see --annotate to verify AX labels/roles; fall back to coordinates with --coords when needed.
  • Permission errors — re-run peekaboo permissions grant and restart affected apps if dialogs persist.
  • Slow or flaky automation — add --quiet-ms/--heartbeat-sec for capture/live commands; for input commands use --delay where available or precede with sleep.