Peekaboo/docs/index.md

title	summary	description	read_when
Peekaboo documentation	Entry point for installing, configuring, and using Peekaboo across CLI, MCP, app, and library surfaces.	macOS automation that sees the screen and does the clicks. Native CLI, MCP server, and agent runtime for OpenAI, Claude, Grok, Gemini, and Ollama.	starting with Peekaboo or looking for the right documentation page linking the public documentation hub from README, site, or release notes

Peekaboo documentation

Peekaboo is a macOS automation toolkit for humans and agents. It captures pixels, reads the accessibility tree, drives input, and ships an agent runtime plus an MCP server so AI clients (Codex, Claude Code, Cursor) can drive the desktop with the same primitives you'd use from the shell.

TL;DR — brew install steipete/tap/peekaboo, grant Screen Recording + Accessibility, then peekaboo agent "open Safari and search for Peekaboo".

Where to start

• Install — Homebrew, npm/MCP, source builds.
• Quickstart — first capture, first click, first agent run in five minutes.
• Platform support — supported macOS, Swift/Xcode, and Node versions by surface.
• Permissions — what to grant, why, and how to verify.
• Configuration — environment variables, config files, credential storage.

What Peekaboo does

• Capture & vision — pixel-accurate screen, window, and menu-bar capture; annotated AX maps.
• Automation — click, type, scroll, drag, hotkeys, menus, dialogs, windows, Spaces.
• Agent — natural-language plan/act loop with provider switching, resumable sessions, and visualizer feedback.
• MCP — expose every Peekaboo tool over stdio for Codex, Claude Code, and Cursor.
• Daemon — warm CLI runtime, lifecycle, sockets, and migration.
• Bridge host — TCC broker transport, discovery, security, and troubleshooting.

Reference

• Command reference — every CLI command, grouped.
• Command index — one page per command with flags and examples.
• Architecture — Core, CLI, Bridge, Daemon, Visualizer.
• AI providers — current model/provider and credential reference.
• Releasing — versioning, signing, distribution.

Surfaces

Surface	Use it for	Entry point
CLI	scripts, ad-hoc captures, CI	brew install steipete/tap/peekaboo
MCP server	Codex, Claude Code, Cursor	npx @steipete/peekaboo mcp
Mac app	menu-bar visualizer, permission prompts	Releases
Library	embed in Swift apps and tools	Core/PeekabooCore (Swift Package)

Get help

• File issues: github.com/openclaw/Peekaboo/issues
• Source: github.com/openclaw/Peekaboo
• Author: @steipete