peach setup
peach works without project setup. This guided flow saves an API key it finds in PEACH_API_KEY or ~/Downloads/peach-api-key.txt (the welcome dialog on peachsim.com downloads it), or asks for one when a person is at the terminal, so tests and recordings work. It explains and offers the strongly recommended background service, which keeps the bridge and runtime ready so agent inspection, interaction, and test commands start much faster. It also installs the native desktop app where it ships (Windows chooses Browser or its Desktop app), offers to enable bounded diagnostics and crash reports, and can optionally add an exact peachsim dependency plus a peach script when the current directory is inside a Git repository. Declining the service is reversible with peach daemon install.
Options
| flag | description |
|---|---|
--app <dir> | project directory to inspect (default: current directory) |
-y, --yes | accept recommended machine defaults without prompting |
--dry-run | show what setup would offer without changing files |
--ci | never prompt or install a background service |
--json | emit runtime and cache metadata as JSON |
--service | --no-service | enable or decline the background service |
--desktop | --browser | choose the simulator window |
--analytics on|off | turn bounded diagnostics and crash reports on or off |
--repo | --no-repo | add or skip the optional repository install |
Examples
No Project Setup Required
Bare peach works without changing the current project. On the first human run,
the guided flow:
- +explains and offers the strongly recommended background service
- +keeps the current window preference, or uses the native desktop app on Apple silicon macOS and Linux x64 and installs it; Windows offers Browser or its Desktop app
- +opens ConnectRN before asking about diagnostics or repository changes
- +offers to enable bounded diagnostics and crash reports, which are off by default
- +only inside a Git repository with package.json, offers an exact dependency and script for teammates; this final choice defaults to no
Declining the service does not disable peach. It uses an on-demand bridge instead.
Enable the faster service later with peach daemon install. Re-run the optional
choices with peach setup.
On Apple silicon macOS and Linux x64, setup installs the native desktop app and
peach open uses it, since it is faster than the browser. Linux installs a
native .deb with sudo apt-get install and needs a desktop session. Select
a browser window with peach open <port> --driver playwright --headed. The
background service keeps the bridge ready for either window and is a separate
choice.