Supatest CLI

Command line interface for Supatest AI.

Installation

npm install -g supatest-ai

Commands

Run Test Plan

Run a test plan and show results:

supatest run-plan --plan-id <planId> [options]

Options:

• -p, --plan-id <planId>: Test plan ID (required)
• -e, --env-id <envId>: Environment ID
• -k, --api-key <apiKey>: Supatest API Key
• -t, --wait: Wait for results

Update Environment Variables

Update values of existing environment variables:

supatest update-env --env-id <envId> [options] <variables...>

Options:

• -e, --env-id <envId>: Environment ID (required)
• -k, --api-key <apiKey>: Supatest API Key

Variables should be provided in key=value format. Multiple variables can be updated at once. For values containing spaces, wrap them in quotes:

# Simple values
supatest update-env -e env_123 DATABASE_URL=postgres://localhost PORT=5432

# Values with spaces
supatest update-env -e env_123 API_URL="https://api.example.com/v1" MESSAGE="Hello World"

Notes:

• Only updates existing variables; does not create new ones
• All specified variables must exist in the environment
• Values are always stored as strings
• Values containing spaces must be wrapped in single or double quotes
• API key can also be provided via SUPATEST_API_KEY environment variable

Example responses:

# Success
✓ Environment variables updated successfully

# Missing variables
✗ Error occurred
Variables not found: DATABASE_URL, PORT

# Invalid format
Error: At least one variable in key=value format is required.

# Invalid API key
Error: Unauthorized: Invalid API key. Please check your API key is correct.

Environment Variables

• SUPATEST_API_KEY: Your Supatest API key

Usage

The CLI requires a Supatest API key for authentication. You can provide it either through the command line option or by setting the SUPATEST_API_KEY environment variable.

Run a Test Plan

supatest run-plan -p <plan-id> -k <api-key>

Or using environment variable:

export SUPATEST_API_KEY=your-api-key
supatest run-plan -p <plan-id>

Options

• -p, --plan-id: (Required) The ID of the test plan to run
• -k, --api-key: (Optional) Supatest API key. Can also be set via SUPATEST_API_KEY environment variable
• -e, --env: (Optional) Environment for the test plan
• --wait: (Optional) Wait for test results instead of exiting after triggering the plan
• -v, --version: Show CLI version
• -h, --help: Show help information

Example

supatest run-plan -p plan_123abc -k sk_test_xxx --wait