[ Documentation ]
peach detox

peach detox

Drop-in Detox runner. Existing import from 'detox' suites run unchanged via a Jest moduleNameMapper rewrite: no code edits, no config churn. Auto-launches a peach shell if none is running.

terminal
peach detox [options] [-- <jest args>]

Options

flagdescription
--config <path>use a specific jest config instead of the default
--watchjest watch mode
--headedkeep the peach shell window visible
-t <pattern>pass a Jest —testNamePattern
--no-launchskip auto-launching a peach shell (manage it yourself)

Examples

terminal
peach detox
peach detox --watch
peach detox -t "login flow"
peach detox --headed

Drop-in Detox

peach detox runs your existing Detox test suite against peach with no code changes. It auto-launches a peach shell, sets up the Jest module mapping (^detox$ → peachsim/detox), and runs your tests.

terminal
peach detox # discover e2e/ and run
peach detox init # scaffold config + sample test
peach detox --watch # jest watch mode
peach detox -t "login" # filter by name

Users can also add preset: 'peachsim/detox' to their own Jest config to run tests via plain npx jest.