# x-test-cli

**Repository Path**: mirrors_netflix/x-test-cli

## Basic Information

- **Project Name**: x-test-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-26
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @netflix/x-test-cli

a simple cli for `x-test`

## Installation

```bash
npm install --save-dev @netflix/x-test-cli
```

## Command Line Usage

The `x-test-cli` provides a unified CLI for running browser tests with
different automation tools.

### Basic Usage

```bash
x-test --client=puppeteer --url=http://localhost:8080/test/ --coverage=true
```

### Arguments

- `--client` - Test automation client to use (required)
  - `puppeteer` - Use Puppeteer with Chrome
- `--url` - URL to the test page (required)
- `--coverage` - Enable coverage collection (`true` or `false`)
- `--test-name` - Filter tests by name using regex pattern (optional)

### Examples

Run all tests with coverage:
```bash
x-test --client=puppeteer --url=http://localhost:8080/test/ --coverage=true
```

Run specific tests by name:
```bash
x-test --client=puppeteer --url=http://localhost:8080/test/ --coverage=false --test-name="should validate"
```

### Test Filtering

The `--test-name` argument accepts a regex pattern that matches against the full
test name, including any parent `describe` block names joined with spaces.

### TAP Output

The client outputs TAP Version 14 compliant results and validates the TAP
stream internally. If any tests fail, the process will exit with code 1.

## Browser vs CLI Packages

- `@netflix/x-test` - Browser-side test runner and utilities
- `@netflix/x-test-cli` - Node.js automation via CLI

For browser usage and test writing, see the main
[@netflix/x-test](https://github.com/Netflix/x-test) documentation.