Using the CLI

The Test Prism CLI is a high-performance command-line tool written in Rust. Its primary job is to read test reports generated by various testing frameworks and convert them into the standardized JSON format required by the Test Prism Dashboard.

Supported Formats

Format	Status	Notes
JUnit	✅ Supported	The standard XML format produced by most testing tools (Jest, Maven, Gradle, etc.).

Other type support is planned for future releases.

Command Structure

The CLI is invoked using one of the following subcommands: parse or tag

test-prism-cli <COMMAND> [OPTIONS]

(Note: If you are running from source, replace test-prism-cli with cargo run --)

parse command

The parse command accepts the following arguments:

--report-type (Required)

Specifies the format of the input test report.

• Description: Use this flag to tell the cli which strategy to use for reading the input file.

Possible Values:

• junit

--input (Required)

The path to the source test report file or folder

• Example: ./reports/junit.xml

--output (Optional)

The path where the resulting JSON file will be saved.

• Default: output.json
• Example: ./assets/test-results.json
• Description: If not provided, the cli will create a file named output.json in the current working directory.

--tag (Optional)

A key-value pair to tag all the tests in the report. Can be specified multiple times.

• Example: --tag "owner:squad-a"
• Description: This is useful for adding metadata to the tests, such as the team that owns them.

Examples

Basic Usage

Parse a JUnit XML file and save the result to the default output.json:

test-prism-cli parse --report-type junit --input ./build/test-results.xml

Custom Output Path

Parse a report and save it directly to the UI's assets folder (useful for local development):

test-prism-cli parse --report-type junit --input ./results.xml --output ./ui/src/assets/test-results.json

Tagging all tests

Parse a report and tag all tests with owner:squad-a:

test-prism-cli parse --report-type junit --input ./results.xml --tag "owner:squad-a"

tag command

The tag command allows you to add, remove, or update tags for tests in a JSON file.

--input (Required)

The path to the source JSON file.

• Example: ./assets/test-results.json

--output (Optional)

The path where the resulting JSON file will be saved.

• Default: The input file will be overwritten.
• Example: ./assets/test-results-tagged.json

--tag (Required)

A string that specifies the tag to add, remove, or update. The format is expression:operation:tag1,tag2.

• expression: A regular expression to match against the test name.

• operation: Can be add, remove, or update.

• tags: A comma-separated list of tags.

• Example: --tag ".*:add:smoke,regression"

Example

Tagging specific tests

Add the smoke and regression tags to all tests in a JSON file:

test-prism-cli tag --input ./assets/test-results.json --tag ".*:add:smoke,regression"