Run detox test options.
Options can be configured in
project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
Artifacts (logs, screenshots, etc) root directory.
Custom arguments to pass (through) onto the app every time it is launched.
Target which builds the application.
Specify Detox config file path. If not supplied, detox searches for
detox section in package.json.
[iOS Only] Capture
*.uihierarchy snapshots on view action errors and
Shutdown simulator when test is over, useful for CI scripts, to make sure detox exists cleanly with no residue
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it.
Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.
Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete.
A list of passthrough-arguments to use when (if) devices (Android emulator / iOS simulator) are launched by Detox.
Due to problems with the adb install command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of
adb install, instead.
[Android Only] Launch Emulator with the specific
-gpu [gpu mode] parameter.
Android Only] Launch Emulator in headless mode. Useful when running on CI.
--inspect-brk flag to let users debug the jest/mocha test runner
[Jest Only] Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.
Disable colors in log output
Test runner config file, defaults to
e2e/mocha.opts for mocha and
e2e/config.json for Jest.
Save logs during each test to artifacts directory. Pass
failing to save logs of failing tests only.
Save screen recordings of each test to artifacts directory. Pass
failing to save recordings of failing tests only.
[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.
[Jest Only] Record tests and events timeline, for visual display on the
[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or
<N> times at least.
Reuse existing installed app (do not delete + reinstall) for a faster run.
Save screenshots before and after each test to artifacts directory. Pass
failing to save screenshots of failing tests only.
Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to Node.js / test-runner's implementation (e.g. Jest / Mocha).
Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest).