[ Documentation ]
peach desktop

peach desktop

Launch or install the native app on macOS arm64 and Linux x64, or Electron on Windows. Profiles keep cookies and app storage isolated.

terminal
peach desktop [--port <number>] [--profile <id>]
peach desktop install [options]
peach desktop uninstall

Options

flagdescription
--port <number>open a local app server through the peach shell, for example Metro on 8081
--profile <id>launch with an isolated persistent storage profile
--ephemerallaunch with a temporary isolated storage profile
-y, --yesfor install: skip confirmation and install immediately
--forcefor install: reinstall even if the companion is present
--electronlaunch or install Electron on Windows; use the native app on Mac and Linux
--nativelaunch or install the native desktop host (default app on macOS arm64; on Linux x64 installs the headless host that headless peach open draws through, see Tests in CI)
--channel <name>for install —native: production (default) or staging

Examples

terminal
peach desktop
peach desktop --port 8081
peach desktop --profile qa
peach desktop install --yes
peach desktop install --native --yes

Desktop Companion Role

The desktop companion is the persistent local host option. It is the right fit when you want:

  • +
    a tray or login-item style workflow
  • +
    a window that stays inspectable over the same bridge host
  • +
    an installed local companion that peach open can prefer automatically

The CLI command here is intentionally thin. Its job is to find or install the companion and launch it with the right URL.