Peekaboo/docs/install.md

title	summary	description	read_when
Install Peekaboo	Install Peekaboo through Homebrew, npm/MCP, the Mac app, or a source checkout.	Install the Peekaboo CLI, MCP server, or Mac app. Homebrew, npm, and source paths.	setting up Peekaboo for the first time choosing between Homebrew, npm, Mac app, and source builds

Install

Peekaboo ships in three flavors. They all use the same Swift core and the same toolset — pick whichever surface fits your workflow.

Homebrew (recommended)

The CLI is signed, notarized, and lives in steipete/homebrew-tap.

brew install steipete/tap/peekaboo
peekaboo --version

Update with brew upgrade steipete/tap/peekaboo.

npm (for MCP clients)

The npm package wraps the same CLI plus an MCP shim, so you can launch the server with npx:

npx -y @steipete/peekaboo mcp

This is the form you point Codex, Claude Code, and Cursor at. See MCP.md.

Mac app

The full menu-bar app (visualizer, permission flows, status item) is on the Releases page. The app and CLI are separate installs; use Homebrew or npm above when you also need the peekaboo command on your PATH.

Build from source

Requires macOS 15.0+ and a Swift 6.2+ toolchain. See platform-support.md for the support matrix across the CLI, app, Swift packages, and pnpm helper scripts.

git clone --recurse-submodules https://github.com/openclaw/Peekaboo.git
cd Peekaboo
pnpm install
pnpm run build:cli         # debug build
pnpm run build:swift:all   # universal release

The output binary lives under Apps/CLI/.build/.... See building.md for signing, notarization, and the pnpm run poltergeist:haunt rapid-rebuild loop.

Verify

peekaboo --version
peekaboo permissions status
peekaboo list apps

If any of those error out, jump to permissions.md.