Running Tests

Command Syntax 

jetclient run [PROJECT_DIR] [OPTIONS]

If PROJECT_DIR is omitted, the current directory is used.

Options

Option Description
-e, --env <ENV> Environment to activate (repeatable for multiple groups)
-i, --item <ITEM> ID or path of request, folder, or test suite to run (repeatable)
-V, --var <KEY=VALUE> Set runtime variable (repeatable, overrides all other sources)
--proxy <URL> HTTP/HTTPS/SOCKS proxy URL (e.g., http://proxy:8080)
--no-proxy <HOSTS> Comma-separated hosts to bypass proxy
-k, --insecure Disable SSL certificate verification
--no-color Disable colored output
-r, --reporter <TYPE> Output reporter: cli, json, html, junit (repeatable)
--reporter-out <TYPE=PATH> Reporter output path (e.g., json=./report.json)
-n, --iterations <N> Number of times to run (default: 1)
--delay <MS> Delay between iterations in milliseconds

Environment Variables

Variable Description
JETCLIENT_ENV Comma-separated environments to activate
JETCLIENT_ITEMS Comma-separated item IDs or paths to run
JETCLIENT_VAR_* Runtime variables (e.g., JETCLIENT_VAR_apiKey=secret). Overridden by --var
JETCLIENT_INSECURE Set to true to disable SSL verification
JETCLIENT_PROXY Proxy URL (e.g., http://proxy:8080). Overridden by --proxy
JETCLIENT_NO_COLOR Disable colored output (any value)
NO_COLOR Standard no-color convention
NO_PROXY Comma-separated hosts to bypass proxy. Overridden by --no-proxy
HTTPS_PROXY / HTTP_PROXY Standard proxy env vars (lower priority than JETCLIENT_PROXY)

Item Selection

Select what to run using -i or --item:

# By path (folder/request name)
jetclient run . -i "Authentication/Login"

# By ID
jetclient run . -i "abc-123-def"

# Multiple items
jetclient run . -i "api/auth" -i "api/users"

# Entire folder (runs all descendants)
jetclient run . -i "api/v1"

Reporters

Multiple reporters can be used simultaneously:

Reporter Description
cli Real-time console output (always active)
json Structured JSON report
junit JUnit XML format for CI/CD tools
html Human-readable HTML report 
# Generate multiple reports
jetclient run . \
  -r json --reporter-out json=./report.json \
  -r junit --reporter-out junit=./results.xml \
  -r html --reporter-out html=./report.html

Default output paths (when --reporter-out is not specified):

  • JSON: ./jetclient-report.json
  • JUnit: ./jetclient-report.xml
  • HTML: ./jetclient-report.html

Exit Codes

Code Description
0 All tests passed
1 One or more tests failed
2 Configuration or input error
3 Runtime error

Examples

Run all requests in a project:

jetclient run ./my-api-project

Run with specific environment:

jetclient run . -e production

Run with runtime variables:

jetclient run . -V "baseUrl=https://api.example.com" -V "apiKey=secret"

Run multiple iterations with delay:

jetclient run . -n 5 --delay 1000

Run with multiple environments (one per group):

jetclient run . -e production -e admin
Getting StartedCI/CD Integration