@testorim/cli

Testorim CLI

Trigger AI browser QA tests from your terminal or CI pipeline.

Monorepo: Repository README · Backend / API: packages/backend

npm install -g @testorim/cli
testorim login
testorim list
testorim run <procedure-id>

Quick start

• Generate an API key at https://app.testorim.com/settings/team.

• Sign in:

  testorim login
  

  The key is saved to ~/.testorim/config.json with 0600 perms. You can also pass it via the TESTORIM_API_KEY env var (preferred for CI).

• Run a saved procedure:

  testorim run <procedure-id>
  

  Exits 0 on pass, 1 on fail, 2 on error — perfect for CI.

Ad-hoc tests

testorim run \
  --project <project-id> \
  --description "Sign in with [e-mail] and verify the dashboard loads"

Override the project's base URL for a single run (e.g. point at a PR preview):

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

Negative tests

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

The --expectation flag frames the report — fail means the run "passes" when the app correctly rejects.

CI usage (GitHub Actions example)

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

Flags

Flag	What
--api-key <key>	Override stored key
--api-url <url>	Override API base URL (default https://app.testorim.com)
--project <id>	Project id (required for ad-hoc tests, optional otherwise)
--description "..."	Plain-English test prompt for ad-hoc runs
--base-url <url>	Override the project's base URL for this run only
--expectation <pass|fail|unknown>	Test intent (default pass)
--json	Machine-readable output
--quiet	Suppress progress lines

Exit codes

Code	Meaning
0	Run passed (overallStatus = "passed")
1	Run failed (overallStatus = "failed")
2	Couldn't run (auth error, bad input, server error, timeout)

Configuration

Precedence (highest first):

• CLI flags
• Environment variables: TESTORIM_API_KEY, TESTORIM_API_URL
• ~/.testorim/config.json