detox

Detox CLI lets you operate Detox from command line.

Installation

Install detox-cli globally via npm:

npm

npm install detox-cli --global

Yarn

yarn global add detox-cli

pnpm

pnpm add detox-cli --global

Usage

detox <command> [options]

Commands

Command	Description
init	Create initial E2E tests folder for Detox.
build	Run the command defined in 'build' property of the specified configuration.
test	Initiating your test suite.
recorder	Starts a Detox Recorder recording.
build-framework-cache	MacOS only. Builds or rebuilds a cached Detox framework and/or XCUITest-runner in ~/Library/Detox. The cache is specific for each combination of Xcode and Detox versions.
clean-framework-cache	MacOS only. Deletes all compiled framework and XCUITest-runner binaries from ~/Library/Detox, they will be rebuilt on 'npm install' or when running 'build-framework-cache'.
rebuild-framework-cache	MacOS only. Cleans and builds a cached Detox framework and XCUITest-runner in ~/Library/Detox. The cache is specific for each combination of Xcode and Detox versions.
reset-lock-file	Resets Detox lock file completely - all devices are marked as available after that.
run-server	Starts a standalone Detox server.

Options

Options	Description
--version	Show version number
--help	Show help