CLI - Testorim

npm install -g @testorim/cli

Requires Node 20 or later.

Signing in

testorim login

The key is written to ~/.testorim/config.json with 0600 permissions. In CI, set TESTORIM_API_KEY in the environment instead. It takes precedence over the stored file. Mint a key from Team settings.

Commands

testorim run <procedure-id>

testorim run <procedure-id> --base-url https://preview-42.staging.example.com

testorim run \
  --project <project-id> \
  --description "Sign in with test@example.com and verify the dashboard loads"

testorim run \
  --project <project-id> \
  --description "Try to log in with the wrong password and verify the error" \
  --expectation fail

testorim list                    # projects
testorim list --project <id>     # that project's saved tests

testorim init                    # writes .testorim.json in this directory

testorim init creates a .testorim.json so you can give saved tests short aliases and run them by name: testorim run checkout.

Flags

Flag	Meaning
`--api-key <key>`	Override the stored key
`--api-url <url>`	Override the API base URL (default `https://app.testorim.com`)
`--project <id>`	Project id, required for ad-hoc tests
`--description "…"`	The plain-English instruction for an ad-hoc test
`--base-url <url>`	Override the project’s address for this run only
`--expectation <pass\|fail\|unknown>`	Test intent (default `pass`)
`--json`	Machine-readable output
`--quiet`	Suppress progress lines
`--help`	Usage

Exit codes

Code	Meaning
`0`	The run passed
`1`	The run failed
`2`	It could not run: auth error, bad input, server error, timeout

That is what makes the CLI a pipeline step: a failing test fails the build, and an infrastructure problem is distinguishable from a real failure.

In GitHub Actions

- name: Smoke test
  env:
    TESTORIM_API_KEY: ${{ secrets.TESTORIM_API_KEY }}
  run: npx @testorim/cli run <procedure-id>

To test a pull-request preview, pass its URL:

- name: Smoke test the preview
  env:
    TESTORIM_API_KEY: ${{ secrets.TESTORIM_API_KEY }}
  run: npx @testorim/cli run <procedure-id> --base-url "${{ steps.deploy.outputs.url }}"

For a repository whose pull requests should always be tested, the GitHub integration is less work, because it resolves the preview URL itself and reports in the PR.

Configuration precedence

CLI flags
TESTORIM_API_KEY / TESTORIM_API_URL in the environment
~/.testorim/config.json

​Signing in

​Commands

​Flags

​Exit codes

​In GitHub Actions

​Configuration precedence

Signing in

Commands

Flags

Exit codes

In GitHub Actions

Configuration precedence