4.2 KiB
4.2 KiB
| summary | read_when | ||
|---|---|---|---|
| Cheat sheet for every Peekaboo CLI command grouped by category. |
|
CLI Command Reference
Peekaboo’s CLI mirrors everything the agent can do. Commands share the same session cache and most support --json-output for scripting. Run peekaboo with no arguments to print the root help menu, and peekaboo --version at any time to see the embedded build/commit metadata that Poltergeist stamped into the binary.
Use peekaboo <command> --help for inline flag descriptions; this page links to the authoritative docs in docs/commands/.
Vision & Capture
see– Capture annotated UI maps, produce session IDs, and optionally run AI analysis.image– Save raw PNG/JPG captures of screens, windows, or menu bar regions; supports--analyzeprompts.list– Subcommands:apps,windows,screens,menubar,permissions.tools– Filter native vs MCP tools; group by server or emit JSON summaries.run– Execute.peekaboo.jsonscripts (--output,--no-fail-fast).sleep– Millisecond pauses between steps.clean– Remove session caches by ID, age, or all at once (--dry-runsupported).config– Subcommands:init,show,edit,validate,set-credential,add-provider,list-providers,test-provider,remove-provider,models.permissions–status(default) andgranthelpers for Screen Recording/Accessibility.learn– Print the complete agent guide (system prompt, tool catalog, Commander signatures).
Interaction
click– Target elements by ID/query/coords with smart waits and focus helpers.type– Send text and control keys; supports--clear,--delay, tab counts, etc.press– FireSpecialKeysequences with repeat counts.hotkey– Emit modifier combos likecmd,shift,tin one shot.scroll– Directional scrolling with optional element targeting and smooth mode.swipe– Gesture-style drags between IDs or coordinates (--duration,--steps).drag– Drag-and-drop across elements, coordinates, or Dock destinations with modifiers.move– Position the cursor at coordinates, element centers, or screen center with optional smoothing.
Windows, Menus, Apps, Spaces
window– Subcommands:close,minimize,maximize,move,resize,set-bounds,focus,list.space–list,switch,move-windowfor Spaces/virtual desktops.menu–click,click-extra,list,list-allfor application menus + menu extras.menubar–listandclickstatus-bar icons by name or index.app–launch,quit,relaunch,hide,unhide,switch,list;launchnow accepts repeatable--open <url|path>arguments (plus--wait-until-ready,--no-focus) to pass documents/URLs directly to the target app.open– Enhanced macOSopenthat respects--app/--bundle-id,--wait-until-ready,--no-focus, and emits JSON payloads for scripting.dock–launch,right-click,hide,show,listDock items.dialog–click,input,file,dismiss,listsystem dialogs.
Automation & Integrations
agent– Natural-language automation with dry-run planning, resume, audio modes, and model overrides.mcp–serve,list,add,remove,enable,disable,info,test,call,inspect(stub) for Model Context Protocol workflows.
Need structured payloads? Pass --json-output (where supported) or orchestrate multiple commands inside .peekaboo.json scripts executed via peekaboo run.