[ Documentation ]
Setup

Setup

The primary way agents drive Peach is the peach CLI. Use the same peach path a human uses after the standalone install; there is no separate agent install.

curl -fsSL https://peachsim.com/install.sh | sh

From inside any agent (Claude Code, Cursor, Codex, or anything that can run shell commands), peach describe, peach do tap-text "Sign in", and the rest of the CLI work against whatever sim is running.

Pick an integration surface

your agentusewhy
runs shell commands (Claude Code, Cursor, Codex, CI)the peach CLIfastest, React Native-aware reads, auto-settle, claim leases
runs shell and works in this repo oftenCLI + peach skill installskills teach the supported workflows once, per agent home
browser-only tooling (Chrome MCP, DOM automation)the accessibility DOM mirrorthe sim exposes real <button>/<input> proxies, so browser tools drive it like a website

All three drive the same simulator through the same gesture pipeline; they differ only in who is calling.

Start the app’s existing Metro, Expo, React Native, or One server yourself. Peach does not own that process. Run peach open <port> from the app project root so font, splash-screen, and project-configuration discovery has the same context as the development server.

Verifying

With a sim open:

terminal
peach compat # scan this app's React Native dependencies
peach list # should show at least one connected tab
peach describe # dumps the current screen

If list is empty, start a sim first (peach open <port> or your usual dev flow), then retry.

If the scan or live app exposes a missing Peach compatibility seam, the agent should explain the finding and offer to send it with peach report-issue. Nothing is submitted until you explicitly agree. The command previews its bounded attachment set before sending; see Reporting Issues.

Skills

We ship a handful of skill files that teach agents how to use Peach well: setup, debugging (including accessibility review), performance, visual review, and test authoring. The standalone CLI installs them into the standard agent skill homes:

terminal
peach skill install
peach skill install codex
peach skill install --target .claude/skills peach-debug

Available: peach-setup, peach-debug, peach-perf, peach-visual, peach-test, and contrast. Pick what matches your task, then restart the agent session so it reloads the skill list.

What’s next