detox-cli

library20.51.0jsnpmunverified

Optional global CLI wrapper for Detox, a gray-box end-to-end testing library for React Native and native mobile apps. This package (v20.51.0) provides the `detox` command-line tool for running tests on simulators/emulators. It is updated alongside the main `detox` package with frequent releases (multiple per month) and supports React Native 0.84 and iOS 26. Key differentiator: lightweight wrapper that can be installed globally, delegating to the local `detox` package to avoid version mismatches.

testing devops

npm install detox-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DETOX-CLI

detox-cli

testingjavascriptv20.51.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

detox-cli

✓ npx detox-cli <command>

As a CLI tool, it is typically invoked via npx or global install, not imported in code.

Shows global install of detox-cli and basic test command, assuming local detox setup.

npm install -g detox-cli # Then run tests in a React Native project with local detox installed: detox test --configuration ios.sim.release

detox --version

Debug

Known issues

gotchaAlways install detox-cli globally but keep the 'detox' package as a local devDependency to ensure version alignment.

fix

npm install --save-dev detox and npm install -g detox-cli

affects: >=0.0.0

breakingDetox CLI may require Node.js >= 18. Check your Node version before installing.

fix

Use Node.js 18 or later.

affects: >=20.0.0

deprecatedOlder versions of detox-cli (pre-v20) used a different API for starting the test runner.

fix

Upgrade to detox-cli v20 and refer to current docs.

affects: <20.0.0

Errors

Common errors & fixes

detox: command not found

detox-cli not installed globally or not in PATH.

fix

Run npm install -g detox-cli or use npx detox-cli.

Error: Cannot find module 'detox'

'detox' package is not installed in the local project.

fix

Add 'detox' as a devDependency: npm install --save-dev detox

detox-cli requires a local detox installation but none was found

The CLI wrapper cannot find the 'detox' package in the current project.

fix

Ensure 'detox' is installed locally: npm install --save-dev detox

Upgrade

Version history

20.51.0latest on npm

Audit

Dependencies

detoxrequiredThis package wraps the local detox installation; the actual test logic and API are in the 'detox' package.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/wix/detox ↗

packagehttps://www.npmjs.com/package/detox-cli ↗

homepagehttps://wix.github.io/Detox/ ↗