Detox

https://github.com/wix/detox
Admin
Detox is a gray box end-to-end testing and automation framework for mobile apps, designed to reduce...
Tokens:198,417
Snippets:1,781
Trust Score:9.1
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Set up the documentation site locally

Source: https://github.com/wix/detox/blob/master/docs/contributing/documentation.md

Commands to navigate to the website directory, install dependencies, and start the local development server.

```bash
cd website
npm install
npm start
```

--------------------------------

### Start React Native packager (npm start)

Source: https://github.com/wix/detox/blob/master/docs/introduction/partials/_project-setup-build.mdx

Run this command in a debug configuration to start the React Native packager. The output shows the Metro welcome banner. This must be running before starting Detox tests.

```bash
npm start

> react-native start

#                        #######
#                   ################
#                #########     #########
#            #########             ##########
#        #########        ######        #########
#       ##########################################
#      #####      #####################       #####
#      #####          ##############          #####
#      #####    ###       ######       ###    #####
#      #####    #######            #######    #####
#      #####    ###########    ###########    #####
#      #####    ##########################    #####
#      #####    ##########################    #####
#      #####      ######################     ######
#       ######        #############        #######
#         #########        ####       #########
#              #########          #########
#                  ######### #########
#                       #########
#
#
#                    Welcome to Metro!
#              Fast - Scalable - Integrated
```

--------------------------------

### Example output of emulator -list-avds

Source: https://github.com/wix/detox/blob/master/docs/introduction/partials/_project-setup-devices-android.mdx

Expected output when the AVD is installed. The highlighted line shows the target AVD name.

```plain text
// highlight-next-line
Pixel_3a_API_30_x86
Pixel_API_30
```

--------------------------------

### Spawned command from testRunner args example

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

The command that would be spawned from the example configuration.

```bash
nyc jest --bail --config e2e/jest.config.js e2e/sanity-tests
```

--------------------------------

### Example: Launch App from URL

Source: https://github.com/wix/detox/blob/master/docs/guide/mocking-open-with-url.md

A test example that launches the app with a URL and verifies a label is visible.

```javascript
describe('launch app from URL', () => {
    it('should handle URL successfully', async () => {
      await device.launchApp({
        newInstance: true,
        url: 'scheme://some.url',
        sourceApp: 'com.apple.mobilesafari'
      });
      await expect(element(by.text('a label'))).toBeVisible();
    });
  });
```

--------------------------------

### device.installApp()

Source: https://github.com/wix/detox/blob/master/docs/api/device.md

Installs the app. By default installs the app defined in the current configuration, or a specified app by path.

```APIDOC
## device.installApp()

### Description
Installs the app. By default, installs the app file defined in the current configuration. To install another app, specify its path.

### Method
installApp

### Parameters
#### Optional Parameters
- **path** (string) - Optional - The path to the app to install.

### Request Example
```js
await device.installApp('path/to/other/app');
```

### Response
No response body.
```

--------------------------------

### Install xcpretty

Source: https://github.com/wix/detox/blob/master/docs/contributing/code/setting-up-the-dev-environment.md

Installs xcpretty, a fast and flexible formatter for xcodebuild.

```bash
gem install xcpretty
```

--------------------------------

### Jest Configuration File

Source: https://github.com/wix/detox/blob/master/docs/api/internals.mdx

Example of a jest.config.js file defining global setup, teardown, and reporters.

```js
module.exports = async function () {
  return {
    globalSetup: '/path/to/globalSetup.js',
    globalTeardown: '/path/to/globalTeardown.js',
    reporters: ['/path/to/reporter.js'],
    /* ... jest config ... */
  };
};
```

--------------------------------

### init([options])

Source: https://github.com/wix/detox/blob/master/docs/api/internals.mdx

Initializes the Detox context. This is the phase where a primary Detox context resolves its configuration, starts the logger, IPC server, and more; a secondary Detox context connects to IPC server and registers itself; if workerId is not null, installs the worker.

```APIDOC
## init([options]) [Promise]

### Description
Initializes the Detox context. This is the phase where a primary Detox context resolves its configuration, starts the logger, IPC server, and more; a secondary Detox context connects to IPC server and registers itself; if workerId is not null, installs the worker.

### Method
init

### Parameters
#### Optional Parameters
- **options** (object) - Optional - An options object with the following properties, all optional as well:
  - **cwd** (string) - Optional - Current working directory, used to resolve Detox config.
  - **argv** (key-value map) - Optional - **Internal!** CLI arguments parsed by Detox CLI.
  - **testRunnerArgv** (key-value map) - Optional - CLI arguments to be forwarded to the test runner.
  - **override** (Partial<Detox.DetoxConfig>) - Optional - Ad-hoc adjustments to deep merge with the file-based config.
  - **global** - Optional - Reference to a custom global scope, usually needed when your test runner uses sandboxing.
  - **workerId** (string | null) - Optional - A unique ID, e.g. `worker-1`, `worker-2`. Giving `null` disables installing the worker.

### Returns
Promise
```

--------------------------------

### Example: Launch with push notification

Source: https://github.com/wix/detox/blob/master/docs/guide/mocking-user-notifications.md

A test example that launches the app with a push notification and verifies that the expected text is visible.

```javascript
describe('Launch with push notification', () => {
  it('should handle the notification', async () => {
    await device.launchApp({
      newInstance: true,
      userNotification: userNotificationPushTrigger,
    });
    await expect(element(by.text('From push'))).toBeVisible();
  });
});
```

--------------------------------

### Install iOS Pods

Source: https://github.com/wix/detox/blob/master/examples/demo-react-native/README.md

Installs the necessary CocoaPods for the iOS demo project.

```sh
cd detox
npm run podInstall:ios
```

--------------------------------

### Example: Launch with user activity

Source: https://github.com/wix/detox/blob/master/docs/guide/mocking-user-activity.md

Example test that launches the app with a user activity and expects a text element to be visible.

```javascript
describe('Background user activity', () => {
  it('Launch with user activity', async () => {
    await device.launchApp({userActivity: activity})
    await expect(element(by.text('From user activity'))).toBeVisible();
  });
});
```

--------------------------------

### Start Metro with MY_APP_MODE=mocked

Source: https://github.com/wix/detox/blob/master/docs/guide/mocking.md

Command to start the Metro bundler with the environment variable that triggers the custom sourceExts override from metro.config.js.

```bash
MY_APP_MODE=mocked npx react-native start
```

--------------------------------

### Install package with npm

Source: https://github.com/wix/detox/blob/master/docs/demo.mdx

Installs a dummy package and saves it to the project dependencies.

```bash
npm install "dummy_package" --save
```

--------------------------------

### Build the demo project with Detox

Source: https://github.com/wix/detox/blob/master/examples/demo-native-ios/README.md

Run this command to build the demo project for the iOS simulator in release mode. Requires proper environment setup as described in the contribution guide.

```sh
detox build --configuration ios.sim.release
```

--------------------------------

### Start Metro with --sourceExts override

Source: https://github.com/wix/detox/blob/master/docs/guide/mocking.md

Command to start the Metro bundler with the mock.js extension added to the source extensions. This is sufficient for debug mode.

```bash
npx react-native start --sourceExts mock.js,js,json,ts,tsx
```

--------------------------------

### Expected Java Version Output

Source: https://github.com/wix/detox/blob/master/docs/guide/android-dev-env.md

Example output from 'java -version' showing a Java 17 version. This is the expected format when Java is correctly installed.

```bash
java version "17.x.x"
...
```

--------------------------------

### forwardEnv example

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

Example showing how command-line arguments are passed as environment variables when forwardEnv is enabled.

```bash
detox test -c ios.sim.debug --record-logs all
DETOX_CONFIGURATION=ios.sim.debug DETOX_RECORD_LOGS=all jest …
```

--------------------------------

### Example: Foreground user notifications

Source: https://github.com/wix/detox/blob/master/docs/guide/mocking-user-notifications.md

A test example that launches the app, sends a local notification, and verifies that the expected text is visible.

```javascript
describe('Foreground user notifications', () => {
  it('should handle the local notification from inside the app', async () => {
    await device.launchApp();
    await device.sendUserNotification(localNotification);
    await expect(element(by.text('from local notification'))).toBeVisible();
   });
});
```

--------------------------------

### Test folder structure example

Source: https://github.com/wix/detox/blob/master/docs/config/artifacts.mdx

Example of folder names created inside the root artifacts directory for individual tests.

```plain text
✗ Assertions should assert an element has (accessibility)
✓ Network Synchronization Sync with short network requests - 100ms
```

--------------------------------

### Artifacts files example

Source: https://github.com/wix/detox/blob/master/docs/config/artifacts.mdx

Example of artifact files that may be contained within a test folder.

```plain text
test.log
test.mp4
test.dtxrec/
beforeEach.png
afterEach.png
```

--------------------------------

### Start Metro Server

Source: https://github.com/wix/detox/blob/master/examples/demo-react-native/README.md

Starts the metro server for bundling JavaScript on-the-fly, required for Debug mode.

```sh
npm start
```

--------------------------------

### Launch the app in beforeAll

Source: https://github.com/wix/detox/blob/master/docs/introduction/your-first-test.mdx

Calls device.launchApp() in the beforeAll hook to start the app before tests run. The app is not running when the test starts.

```javascript
describe('Example', () => {
  beforeAll(async () => {
    await device.launchApp();
  });

  // …
});
```

--------------------------------

### Report test suite start with onRunDescribeStart

Source: https://github.com/wix/detox/blob/master/docs/api/internals.mdx

Reports that the test runner has started executing a test suite. Requires an installed worker.

```js
await onRunDescribeStart({
  name: 'Suite name'
});
```

--------------------------------

### device.installApp() with path

Source: https://github.com/wix/detox/blob/master/docs/api/device.md

Installs an application from a specified file path.

```js
await device.installApp('path/to/other/app');
```

--------------------------------

### Conventional Commits examples for commit messages

Source: https://github.com/wix/detox/blob/master/docs/contributing/code/submitting-pull-requests.md

Example commit messages following the Conventional Commits format, specifying type, scope, and description. Use these as a guide for writing descriptive commit messages for Detox contributions.

```plaintext
fix(ios): resolve crash on scrolling in iOS 17.0
feat(android): add new API for setting the device locale
test: update unit tests for new utility function
```

--------------------------------

### Travis CI configuration for Detox

Source: https://github.com/wix/detox/blob/master/docs/introduction/preparing-for-ci.md

Example .travis.yml configuration for running Detox tests on macOS, including environment setup and cleanup.

```yaml
language: objective-c
osx_image: xcode8.3

branches:
  only:
  - master

env:
  global:
  - NODE_VERSION=stable

install:
- brew tap wix/brew
- brew install applesimutils
- curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash
- export NVM_DIR="$HOME/.nvm" && [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
- nvm install $NODE_VERSION
- nvm use $NODE_VERSION
- nvm alias default $NODE_VERSION

- npm install react-native-cli --global
- npm install detox-cli --global

script:
- detox build --configuration ios.sim.release
- detox test --configuration ios.sim.release --cleanup
```

--------------------------------

### onTestStart(event)

Source: https://github.com/wix/detox/blob/master/docs/api/internals.mdx

Reports that the test runner started executing a specific test. Use invocations when a test is being re-run after a failure. Requires an installed worker.

```APIDOC
## onTestStart(event) [Promise]

### Description
Reports that the test runner started executing a specific test. Use `invocations` when a test is being re-run after a failure. Requires an installed worker.

### Method
onTestStart

### Parameters
#### Argument
- **event** (Object) - Required - An object with the following properties:
  - `title` (string) - The title of the test.
  - `fullName` (string) - The full name of the test, including the suite name.
  - `invocations` (number) - The invocation count (e.g., 1 for first run, 2 for re-run).
  - `status` (string) - The status of the test, e.g., 'running'.

### Request Example
```js
await onTestStart({
  title: 'should do something expected',
  fullName: 'Suite name should do something expected',
  invocations: 1,
  status: 'running',
});
```

### Response
Returns a Promise.
```

--------------------------------

### Boot emulator with GUI

Source: https://github.com/wix/detox/blob/master/docs/guide/android-dev-env.md

Command to launch a verbose, visible emulator instance for systems supporting a graphical user interface.

```bash
$ANDROID_HOME/emulator/emulator -verbose @Pixel_API_28_AOSP &
```

--------------------------------

### onRunDescribeStart(event)

Source: https://github.com/wix/detox/blob/master/docs/api/internals.mdx

Reports that the test runner started executing a test suite, e.g. a beforeAll hook or a first test. Requires an installed worker.

```APIDOC
## onRunDescribeStart(event) [Promise]

### Description
Reports that the test runner started executing a test suite, e.g. a `beforeAll` hook or a first test. Requires an installed worker.

### Method
onRunDescribeStart

### Parameters
#### Argument
- **event** (Object) - Required - An object with the following properties:
  - `name` (string) - The name of the test suite.

### Request Example
```js
await onRunDescribeStart({
  name: 'Suite name'
});
```

### Response
Returns a Promise.
```

--------------------------------

### Bitrise workflow configuration for Detox

Source: https://github.com/wix/detox/blob/master/docs/introduction/preparing-for-ci.md

Example bitrise.yml configuration defining a 'tests' workflow that installs dependencies and executes Detox build and test commands.

```yaml
---
format_version: 1.1.0
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
trigger_map:
- push_branch: "*"
  workflow: tests
workflows:
  _tests_setup:
    steps:
    - activate-ssh-key: {}
    - git-clone:
        inputs:
        - clone_depth: ''
        title: Git Clone Repo
    - script:
        inputs:
        - content: |-
            #!/bin/bash

            npm cache verify

            npm install
        title: Install NPM Packages
    before_run:
    after_run:
  _detox_tests:
    before_run: []
    after_run: []
    steps:
    - npm:
        inputs:
        - command: install -g detox-cli
        title: Install Detox CLI
    - npm:
        inputs:
        - command: install -g react-native-cli
        title: Install React Native CLI
    - script:
        inputs:
        - content: |-
            #!/bin/bash

            brew tap wix/brew
            brew install applesimutils
        title: Install Detox Utils
    - script:
        inputs:
        - content: |-
            #!/bin/bash

            detox build --configuration ios.sim.release
        title: Detox - Build Release App
    - script:
        inputs:
        - content: |-
            #!/bin/bash

            detox test --configuration ios.sim.release --cleanup
        title: Detox - Run E2E Tests
  tests:
    before_run:
    - _tests_setup
    - _detox_tests
    after_run: []
```

--------------------------------

### Example log output when testRunner.jest.reportSpecs is enabled

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

Shows the log messages printed by Detox when reportSpecs is enabled, indicating test start and end with status.

```plain text
18:03:36.258 detox[40125] i Sanity: should have welcome screen
18:03:37.495 detox[40125] i Sanity: should have welcome screen [OK]
18:03:37.496 detox[40125] i Sanity: should show hello screen after tap
18:03:38.928 detox[40125] i Sanity: should show hello screen after tap [OK]
18:03:38.929 detox[40125] i Sanity: should show world screen after tap
18:03:40.351 detox[40125] i Sanity: should show world screen after tap [OK]
```

--------------------------------

### Device Allocation Flow

Source: https://github.com/wix/detox/blob/master/docs/architecture/devices.md

Text diagram showing the steps of device allocation, from test start to device free, including querying, locking, setup, and release.

```text
1. Test starts
   │
   ▼
2. DeviceAllocator.allocate(deviceConfig)
   │
   ├── Query available devices
   │   └── SimulatorQuery / FreeDeviceFinder
   │
   ├── Acquire lock
   │   └── DeviceRegistry.allocateDevice()
   │
   └── Return DeviceCookie

3. DeviceAllocator.postAllocate(cookie, configs)
   │
   ├── Platform-specific device setup
   │   ├── iOS: Boot simulator, clean app cache
   │   └── Android: Wait for boot, disable animations,
   │       unlock screen, configure System UI
   │
   └── Return enriched DeviceCookie

4. RuntimeDevice created with cookie
   │
   ▼
5. Tests execute
   │
   ▼
6. DeviceAllocator.free(cookie)
   │
   ├── Shutdown (if configured)
   │
   └── Release lock
```

--------------------------------

### Configure testRunner args with $0, bail, config, and positional arguments

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

Example configuration showing how to set the test runner command, bail flag, config file, and default positional arguments.

```json
{
  "testRunner": {
    "args": {
      "$0": "nyc jest",
      "bail": true,
      "config": "e2e/jest.config.js",
      "_": ["e2e/sanity-tests"]
    }
  }
}
```

--------------------------------

### swipe(direction[, speed, normalizedOffset, normalizedStartingPointX, normalizedStartingPointY])

Source: https://github.com/wix/detox/blob/master/docs/api/actions.md

Simulates a swipe on an element. `direction` is required; `speed` defaults to `"fast"`; `normalizedOffset` and starting point coordinates default to `NaN` (auto). Examples show setting speed, swipe amount, and starting point X/Y.

```javascript
await element(by.id('scrollView')).swipe('down');
await element(by.id('scrollView')).swipe('down', 'slow'); // set swipe speed
await element(by.id('scrollView')).swipe('down', 'fast', 0.75); // set swipe amount
await element(by.id('scrollView')).swipe('down', 'fast', NaN, 0.8); // set starting point X
await element(by.id('scrollView')).swipe('down', 'fast', NaN, NaN, 0.25); // set starting point Y
```

--------------------------------

### Enable session.autoStart with a diff snippet

Source: https://github.com/wix/detox/blob/master/docs/config/session.mdx

Shows how to set autoStart to true in a diff format. This is needed when you define a server URL, because autoStart defaults to false in that case.

```diff
   "session": {
+    "autoStart": true,
     "server": "ws://localhost:8099",
     "sessionId": "YourProjectSessionId"
```

--------------------------------

### Custom test environment extending DetoxCircusEnvironment

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

Example of extending `DetoxCircusEnvironment` to add custom behavior to the test environment. Override methods like `setup`, `handleTestEvent`, and `teardown`.

```javascript
const { DetoxCircusEnvironment } = require('detox/runners/jest');

class CustomDetoxEnvironment extends DetoxCircusEnvironment {
  constructor(config, context) {
    super(config, context);
    // custom code
  }

  async setup(config, context) {
    await super.setup(config, context);
    // custom code
  }

  async handleTestEvent(event, state) {
    await super.handleTestEvent(event, state);
    // custom code
  }

  async teardown(config, context) {
    try {
      // custom code
    } finally {
      await super.teardown(config, context);
    }
  }
}

module.exports = CustomDetoxEnvironment;
```

--------------------------------

### Example timeout error for testRunner.jest.setupTimeout

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

Shows the error message displayed when the environment setup exceeds the configured setupTimeout (default 120000ms). The test suite is considered failed.

```plain text
 FAIL  e2e/starter.test.js
  ● Test suite failed to run

    Exceeded timeout of 120000ms while setting up Detox environment
```

--------------------------------

### Configure arbitrary testRunner args

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

Example showing how to set arbitrary arguments like color, bail, testTimeout, and config.

```json
{
  "args": {
    "$0": "jest",
// highlight-start
    "color": false,
    "bail": true,
    "testTimeout": 60000,
    "config": "e2e/jest.ci.config.js"
// highlight-end
  }
}
```

--------------------------------

### Write step-by-step tests with pilot.perform

Source: https://github.com/wix/detox/blob/master/docs/pilot/testing-with-pilot.md

Use pilot.perform with a list of natural language instructions, each representing a single action or assertion. Steps execute sequentially.

```javascript
it('should verify element sizes and button states', async () => {
  await pilot.perform(
    'Launch the app with notification permissions enabled',
    'Navigate to the "Settings" page',
    'Verify that the "Save" button is disabled',
    'Locate the profile picture element',
    'Verify that the profile picture size is 100 x 100 pixels and that the image is available and rendered',
    'Tap on the "Edit Profile" button',
    'Verify that the "Save" button is now enabled',
    'Verify that the "Username" field text is bold'
  );
});
```

--------------------------------

### Starting duration events with log.info.begin

Source: https://github.com/wix/detox/blob/master/docs/api/logger.mdx

Demonstrates how to begin duration events using log.info.begin. Shows that events can be stacked by calling begin multiple times. The console output is shown in comments.

```javascript
log.info.begin({ data: { email } }, 'Login Flow');
// detox[2020] B Login Flow
//   data: { email: 'tester@example.com' }
log.info.begin('Nested sub-flow');
// detox[2020] B Nested sub-flow
```

--------------------------------

### scrollTo(edge[, startPositionX, startPositionY])

Source: https://github.com/wix/detox/blob/master/docs/api/actions.md

Simulates a scroll to the specified edge. `edge` is required; `startPositionX` and `startPositionY` default to `NaN` (auto). Examples show scrolling to bottom and top with a custom start position.

```javascript
await element(by.id('scrollView')).scrollTo('bottom');
await element(by.id('scrollView')).scrollTo('top', NaN, 0.2);
```

--------------------------------

### scroll(offset, direction[, startPositionX, startPositionY])

Source: https://github.com/wix/detox/blob/master/docs/api/actions.md

Simulates a scroll on the element. `offset` is in points; `direction` is required; `startPositionX` and `startPositionY` default to `NaN` (auto). Examples show scrolling up and down with a custom start position.

```javascript
await element(by.id('scrollView')).scroll(100, 'up');
await element(by.id('scrollView')).scroll(100, 'down', NaN, 0.85);
```

--------------------------------

### Select Xcode with xcode-select

Source: https://github.com/wix/detox/blob/master/docs/troubleshooting/building-the-app.md

Run this command to ensure Xcode is properly selected before building.

```bash
sudo xcode-select --switch /Applications/Xcode.app
```

--------------------------------

### longPressAndDrag(...) example

Source: https://github.com/wix/detox/blob/master/docs/api/actions.md

Simulates a long press on an element and then drags it to a position of another element. Required parameters include duration, normalized starting point, and target element. Optional normalized target positions, speed, and hold duration.

```js
await element(by.id('elementToDrag')).longPressAndDrag(2000, NaN, NaN, element(by.id('targetElement')), NaN, NaN);
await element(by.id('cellId_1')).longPressAndDrag(2000, 0.9, NaN, element(by.id('cellId_6')), 0.9, NaN, 'slow', 0);

```

--------------------------------

### Wrap globalSetup with custom logic

Source: https://github.com/wix/detox/blob/master/docs/config/testRunner.mdx

Shows how to wrap the Detox globalSetup function to add custom setup logic. The Detox globalSetup is essential for integration.

```javascript
module.exports = async () => {
   await require('detox/runners/jest').globalSetup();
   await yourGlobalSetupFunction();
};
```

--------------------------------

### Error message: command not found: tsc

Source: https://github.com/wix/detox/blob/master/docs/guide/typescript.md

Example error output when tsc is not found. The guide suggests solutions like adding node_modules/.bin to PATH, using npx tsc --init, or other ways to run executables from node_modules/.bin.

```plain text
command not found: tsc
```

--------------------------------

### Run detox start with a single configuration

Source: https://github.com/wix/detox/blob/master/docs/cli/start.md

Use this command when your project contains only one configuration.

```bash
detox start
```

--------------------------------

### Install detox-cli globally

Source: https://github.com/wix/detox/blob/master/docs/cli/overview.md

Installs the Detox CLI globally via npm. Requires npm to be installed.

```bash
npm install detox-cli --global
```

--------------------------------

### Install Detox with npm install detox --save-dev

Source: https://github.com/wix/detox/blob/master/docs/introduction/partials/_project-setup-bootstrap-other.mdx

Installs Detox as a dev dependency. Run this after creating package.json.

```bash
npm install detox --save-dev
```

--------------------------------

### installWorker([options])

Source: https://github.com/wix/detox/blob/master/docs/api/internals.mdx

Installs the worker. This is the phase where Detox loads its expectation library and boots a device. You don't need to call it separately unless you use init({ workerId: null }) override.

```APIDOC
## installWorker([options]) [Promise]

### Description
Installs the worker. This is the phase where Detox loads its expectation library and boots a device. You don't need to call it separately unless you use init({ workerId: null }) override.

### Method
installWorker

### Parameters
#### Optional Parameters
- **options** (object) - Optional - An options object with the following properties, all optional as well:
  - **global** - Optional - Reference to a custom global scope, usually needed when your test runner uses sandboxing.
  - **workerId** (string | null) - Optional - A unique ID, e.g. `worker-1`, `worker-2`. Giving `null` disables installing the worker.

### Returns
Promise
```

--------------------------------

### Install Jest with npm install jest --save-dev

Source: https://github.com/wix/detox/blob/master/docs/introduction/partials/_project-setup-bootstrap-other.mdx

Installs Jest as the test runner for Detox. Detox offers first-class integration with Jest.

```bash
npm install jest --save-dev
```

--------------------------------

### Install Jest and Detox

Source: https://github.com/wix/detox/blob/master/docs/introduction/partials/_project-setup-bootstrap-rn.mdx

Install the latest supported Jest version (with the @^29 override to avoid outdated versions from lock files) and then install Detox as a dev dependency.

```bash
npm install "jest@^29" --save-dev
```

```bash
npm install detox --save-dev
```

--------------------------------

### Build with specific configuration

Source: https://github.com/wix/detox/blob/master/docs/cli/build.md

Selects a named configuration with the `--configuration` option and runs its build command.

```bash
detox build --configuration yourConfiguration
```

--------------------------------

### Initialize package.json with npm init -y

Source: https://github.com/wix/detox/blob/master/docs/introduction/partials/_project-setup-bootstrap-other.mdx

Run this command in your project's root to create a package.json file. Remember to add the node_modules folder to your .gitignore.

```bash
npm init -y
```

--------------------------------

### Install Dependencies

Source: https://github.com/wix/detox/blob/master/docs/contributing/code/setting-up-the-dev-environment.md

Installs all dependencies for the monorepo using Yarn workspaces.

```bash
yarn install
```

--------------------------------

### YAML actions configuration

Source: https://github.com/wix/detox/blob/master/docs/demo.mdx

A YAML configuration defining installation actions with dummy text parameters.

```yaml
actions:
  - dummy install example
    - push_dummytext: "*"

  - dummy install example --save global
  # Lorem ipsum dolor sit amet, consectetur SampleCo is using ($DUMMY/lorem-text)
```

--------------------------------

### Deprecated --device-launch-args replaced by --device-boot-args

Source: https://github.com/wix/detox/blob/master/docs/guide/migration.md

The new CLI parameter --device-boot-args to replace the deprecated --device-launch-args.

```bash
detox test ... --device-boot-args="arg1 arg2"
```

--------------------------------

### Install Watchman

Source: https://github.com/wix/detox/blob/master/docs/contributing/code/setting-up-the-dev-environment.md

Installs Watchman, a tool by Facebook for watching filesystem changes.

```bash
brew install watchman
```

--------------------------------

### Install React Native CLI

Source: https://github.com/wix/detox/blob/master/docs/contributing/code/setting-up-the-dev-environment.md

Installs the React Native CLI globally.

```bash
npm install react-native-cli --global
```
Tokens:
Raw