@testplanit/cli

Command-line interface for TestPlanIt - import test results and manage test data.

Supported Formats

The CLI supports importing test results from 7 different formats:

| Format | Description | File Extensions |
|--------|-------------|-----------------|
| junit | JUnit XML | .xml |
| testng | TestNG XML | .xml |
| xunit | xUnit XML | .xml |
| nunit | NUnit XML | .xml |
| mstest | MSTest TRX | .trx, .xml |
| mocha | Mocha JSON | .json |
| cucumber | Cucumber JSON | .json |

The CLI can auto-detect the format based on file content, or you can specify it explicitly.

Installation

$3

Download the appropriate binary for your platform from the CLI releases:

| Platform | Binary |
|----------|--------|
| Linux (x64) | testplanit-linux-x64 |
| macOS (Apple Silicon) | testplanit-macos-arm64 |
| macOS (Intel) | testplanit-macos-x64 |
| Windows (x64) | testplanit-windows-x64.exe |

Linux / macOS:

``bash


Download (replace URL with actual release URL)


curl -L -o testplanit https://github.com/testplanit/testplanit/releases/latest/download/testplanit-linux-x64
chmod +x testplanit
sudo mv testplanit /usr/local/bin/
`

Windows (PowerShell):

`powershell
Invoke-WebRequest -Uri "https://github.com/testplanit/testplanit/releases/latest/download/testplanit-windows-x64.exe" -OutFile "testplanit.exe"
`

Configuration

Before using the CLI, configure your TestPlanIt instance URL and API token:

`bash


Set URL and token

testplanit config set --url https://your-testplanit-instance.com --token tpi_your_token

View current configuration

testplanit config show

Clear stored configuration

testplanit config clear
`

$3

You can also use environment variables (they take precedence over stored config):

- TESTPLANIT_URL - TestPlanIt instance URL
- TESTPLANIT_TOKEN - API token

`bash
TESTPLANIT_URL=https://testplanit.example.com TESTPLANIT_TOKEN=tpi_xxx testplanit import ...
`

Commands

$3

Import test results from various formats to create a test run:

`bash
testplanit import --project --name [options]
`

Required:

- - Test result files or glob patterns (e.g., ./results/*.xml)
- -p, --project - Project (ID or exact name)
- -n, --name - Test run name

Optional:

- -F, --format - File format: auto, junit, testng, xunit, nunit, mstest, mocha, cucumber (default: auto-detect)
- -s, --state - Workflow state (ID or exact name)
- -c, --config - Configuration (ID or exact name)
- -m, --milestone - Milestone (ID or exact name)
- -f, --folder - Parent folder for test cases (ID or exact name)
- -t, --tags - Tags (comma-separated IDs or names; use quotes for names with commas)
- -r, --test-run - Existing test run to append results (ID or exact name)

Note: For project, state, config, milestone, folder, and test run options, the CLI looks up entities by exact name match. If no match is found, an error is returned. For tags, if a tag name doesn't exist, it will be created automatically.

Examples:

`bash


Import a single JUnit file (auto-detected)

testplanit import results.xml -p 1 -n "Build 123"

Import with explicit format

testplanit import results.xml -p 1 -n "Build 123" -F junit

Import TestNG results

testplanit import testng-results.xml -p 1 -n "TestNG Suite" -F testng

Import Mocha JSON results

testplanit import mocha-report.json -p 1 -n "Mocha Tests" -F mocha

Import Cucumber JSON results

testplanit import cucumber-report.json -p 1 -n "BDD Tests" -F cucumber

Import multiple files with glob pattern

testplanit import "./test-results/*.xml" -p 1 -n "CI Build"

Import with IDs

testplanit import results.xml \
--project 1 \
--name "Nightly Build" \
--format junit \
--state 5 \
--config 2 \
--milestone 3 \
--folder 10 \
--tags 1,2,3

Import with names (exact match required)

testplanit import results.xml \
--project "My Project" \
--name "Nightly Build" \
--state "In Progress" \
--config "Chrome on Windows" \
--milestone "Sprint 5" \
--folder "API Tests" \
--tags "regression,smoke,critical"

Mix IDs and names

testplanit import results.xml -p 1 -n "Build 123" \
--state "Completed" \
--tags '1,"new tag",smoke'
`

CI/CD Integration

$3

`yaml
- name: Download TestPlanIt CLI
run: |
curl -L -o testplanit https://github.com/testplanit/testplanit/releases/latest/download/testplanit-linux-x64
chmod +x testplanit

- name: Import Test Results
env:
TESTPLANIT_URL: ${{ secrets.TESTPLANIT_URL }}
TESTPLANIT_TOKEN: ${{ secrets.TESTPLANIT_TOKEN }}
run: |
./testplanit import ./test-results/*.xml \
--project-id 1 \
--name "Build ${{ github.run_number }}"
`

$3

`yaml
import-results:
script:
- curl -L -o testplanit https://github.com/testplanit/testplanit/releases/latest/download/testplanit-linux-x64
- chmod +x testplanit
- ./testplanit import ./test-results/*.xml -p 1 -n "Pipeline $CI_PIPELINE_ID"
variables:
TESTPLANIT_URL: $TESTPLANIT_URL
TESTPLANIT_TOKEN: $TESTPLANIT_TOKEN
`

$3

`groovy
withCredentials([
string(credentialsId: 'testplanit-url', variable: 'TESTPLANIT_URL'),
string(credentialsId: 'testplanit-token', variable: 'TESTPLANIT_TOKEN')
]) {
sh '''
curl -L -o testplanit https://github.com/testplanit/testplanit/releases/latest/download/testplanit-linux-x64
chmod +x testplanit
./testplanit import ./target/surefire-reports/*.xml -p 1 -n "Build ${BUILD_NUMBER}"
'''
}
`

Building from Source

Requires Bun to build standalone binaries:

`bash


Install dependencies

bun install

Build for all platforms

bun run build:binaries

Or build for specific platform

bun run build:linux
bun run build:macos-arm64
bun run build:macos-x64
bun run build:windows
`

Binaries will be output to the releases/` directory.

License

Apache-2.0