CLI

The spectest command runs suites and manages the test environment. All options correspond to configuration fields and may be supplied via the config file or the command line. CLI flags take precedence over spectest.config.js, which takes precedence over the built-in defaults.

npx spectest [suiteFile] [options]

Options

Provide a file path without a flag to run just that suite. Options that accept a list of enum-like values (recording, runningServer, testOutput, missingRecordingBehavior) are validated whether they come from the CLI or from spectest.config.js.

See Test Suite and Test Case for details on the file format, and OpenAPI Testing, HTTP Recording, and Outbound Throttling for the larger features above.

outboundThrottle (rate-limiting the SUT server’s outbound calls) is config-file only — see Outbound Throttling.

Examples

# Run every suite discovered in testDir
npx spectest

# Only run a specific file
npx spectest auth.spectest.js

# Run with mobile user agent and write a snapshot
npx spectest --user-agent=chrome_android --snapshot=snap.json

# Load and run tests directly from an OpenAPI document
npx spectest --openapi ./openapi.yaml --base-url=https://api.example.com

# Print contract coverage after running an OpenAPI-backed suite
npx spectest --openapi ./openapi.yaml --coverage-report

# Generate negative/fuzz cases from the spec and report their coverage too
npx spectest --openapi ./openapi.yaml --negative-tests --coverage-report

generate openapi-tests

Scaffolds an editable .spectest.js file containing the same tests Spectest would generate in-memory from an OpenAPI document:

npx spectest generate openapi-tests --openapi <path> --output <dir> [--dir <projectRoot>] [--config <file>]

This is a convenience for suites that will grow real beforeSend/postTest logic by hand — everything it writes is already expressible via direct --openapi loading.