Scout CLI

Command-line interface for Scout QA automation platform.

Installation

npm install -g @scoutqa/cli

Authentication

The CLI supports multiple authentication methods (in priority order):

1. Environment variable (highest priority)
2. OAuth login (via browser)
3. API key (stored in config file)

Environment Variables

• SCOUT_API_KEY: API key for authentication
• SCOUT_SERVER_URL: Scout server URL (default: https://app.scoutqa.ai)

Example:

export SCOUT_API_KEY=sk-scout-xxx
export SCOUT_SERVER_URL=https://custom-scout-instance.com

OAuth Login

scoutqa auth login

Opens your browser for authentication. Stores access and refresh tokens locally.

API Key

Set an API key manually:

scoutqa auth set-api-key <your-api-key>

Or create a new API key:

scoutqa auth create-api-key --name "My CLI Key" --expires-in 90d

Commands

Authentication

• scoutqa auth status - Show authentication status
• scoutqa auth login - Login via browser (OAuth)
• scoutqa auth set-api-key - Set API key manually
• scoutqa auth create-api-key - Create a new API key
• scoutqa auth logout - Clear stored credentials

Executions

• scoutqa create-execution --url <url> --prompt <prompt> - Create a new test execution
• scoutqa list-executions - List your executions
• scoutqa send-message --execution-id <id> --prompt <prompt> - Send a message to an execution

Configuration

Configuration is stored in ~/.config/scoutqa/config.json (or platform-specific config directory).

Priority order for settings:

1. Environment variables (SCOUT_API_KEY, SCOUT_SERVER_URL)
2. Config file
3. Defaults

Examples

Create and run a test

scoutqa create-execution \
  --url https://example.com \
  --prompt "Test the login functionality"

Continue an existing execution

scoutqa send-message \
  --execution-id exec_123 \
  --prompt "Now test the logout button"

Use with custom server

export SCOUT_SERVER_URL=https://staging.scoutqa.ai
scoutqa auth login