[ Documentation ]
peach setup

peach setup

peach works without project setup. This guided flow 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 chooses Browser or the packaged Desktop app, keeps diagnostics private unless explicitly enabled, 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.

terminal
peach setup [options]

Options

flagdescription
--app <dir>project directory to inspect (default: current directory)
-y, --yesaccept recommended machine defaults without prompting
--dry-runshow what setup would offer without changing files
--service | --no-serviceenable or decline the background service
--desktop | --browserchoose the simulator window
--analytics on|offconfigure bounded diagnostics
--repo | --no-repoadd or skip the optional repository install

Examples

terminal
peach setup
peach setup --app ./apps/mobile
peach setup --dry-run
peach setup --yes

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
  • +
    offers Browser or the packaged Desktop app, with platform download progress
  • +
    opens ConnectRN before asking about diagnostics or repository changes
  • +
    keeps diagnostics off unless the human explicitly opts in
  • +
    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.