testzeus-installation#

Install and configure TestZeus CLI and SDK, or troubleshoot installation issues.

Category: infrastructure · Version: 1.0.0

Triggers: install testzeus, setup testzeus, get started with testzeus, how to install testzeus, testzeus not installed, command not found, no module named, how do i use testzeus, setup guide

Overview#

This skill guides you through installing and configuring the TestZeus CLI and SDK. Use this when setting up TestZeus for the first time or troubleshooting installation issues.

Quick Installation#

Step 1: Install CLI#

# Via pip (recommended)
pip install testzeus-cli

# Verify installation
testzeus --version

Step 2: Install SDK (Optional, for programmatic access)#

# Via pip
pip install testzeus-sdk

# Via poetry
poetry add testzeus-sdk

Step 3: Authenticate#

# Interactive login
testzeus auth login

# You'll be prompted for:
# - Email: [email protected]
# - Password: (hidden input)

# Login with custom profile
testzeus auth login --profile dev

Step 4: Verify Setup#

# Check authentication status
testzeus auth whoami

# List tests to verify connection
testzeus tests list

Detailed Setup Options#

CLI Installation Methods#

Via pip#

pip install testzeus-cli

Via poetry#

poetry add testzeus-cli

Via pipx (isolated environment)#

pipx install testzeus-cli

Development installation#

git clone https://github.com/testzeus/testzeus-cli.git
cd testzeus-cli
pip install -e ".[dev]"

SDK Installation#

Via pip#

pip install testzeus-sdk

Via poetry#

poetry add testzeus-sdk

Authentication Options#

Interactive Login#

testzeus auth login

Programmatic Login (for CI/CD)#

# Set environment variables
export TESTZEUS_EMAIL="[email protected]"
export TESTZEUS_PASSWORD="your-password"

# Or use API key (if configured)
export TESTZEUS_API_KEY="your-api-key"

Profile Management#

# Create named profile
testzeus auth login --profile work

# Use specific profile
testzeus --profile work tests list

# List profiles
cat ~/.testzeus/config.yaml

Environment Variables#

Variable

Description

Required

TESTZEUS_EMAIL

User email

For SDK

TESTZEUS_PASSWORD

User password

For SDK

TESTZEUS_BASE_URL

API URL

No (has default)

TESTZEUS_API_KEY

API key

Alternative to password

Configuration Files#

Default Config Location#

  • Linux/Mac: ~/.testzeus/config.yaml

  • Windows: %APPDATA%\testzeus\config.yaml

Sample Config#

default:
  base_url: https://prod.testzeus.app/api
  timeout: 300

profiles:
  dev:
    base_url: https://prod.testzeus.app/api
  staging:
    base_url: https://prod.testzeus.app/api

Troubleshooting#

Common Issues#

“command not found” / “testzeus: command not found”#

Cause: CLI not installed or PATH not configured

Solution:

# Install CLI
pip install testzeus-cli

# If installed but not found, check pip path
which pip
pip show testzeus-cli

# Try running with python module
python -m testzeus_cli --version

“No module named testzeus”#

Cause: SDK not installed or wrong Python environment

Solution:

# Install SDK
pip install testzeus-sdk

# Check Python environment
which python
python --version

# Install in specific environment
pip install --target=/path/to/env testzeus-sdk

Authentication Failed#

Cause: Invalid credentials or expired session

Solution:

# Logout and login again
testzeus auth logout
testzeus auth login

# Check credentials
testzeus auth whoami

Network/Connection Errors#

Cause: Firewall, proxy, or wrong API URL

Solution:

# Check base URL
testzeus --api-url https://prod.testzeus.app/api tests list

# Use verbose mode for debugging
testzeus --verbose tests list

# Check proxy settings
export HTTP_PROXY=http://proxy:8080
export HTTPS_PROXY=http://proxy:8080

Timeout Errors#

Cause: Long-running operations or slow network

Solution:

# Use verbose mode
testzeus --verbose test-runs watch run_id

# Increase timeout (if supported)
# Edit ~/.testzeus/config.yaml
timeout: 600

Verification Commands#

After installation, verify everything works:

# 1. Check CLI version
testzeus --version

# 2. Check auth status
testzeus auth whoami

# 3. List tests (should not error)
testzeus tests list --limit 5

# 4. List environments
testzeus environments list

SDK Usage#

Python Quick Start#

import asyncio
from testzeus_sdk import TestZeusClient

async def main():
    # Create client (uses env vars or interactive login)
    async with TestZeusClient() as client:
        # List tests
        tests = await client.tests.get_list(limit=10)
        print(f"Found {tests['total']} tests")
        
        # Run tests
        result = await client.test_run_groups.create_and_execute(
            name="my-test-run",
            test_ids=["test_id_1", "test_id_2"]
        )
        print(f"Run created: {result.id}")

asyncio.run(main())

SDK Authentication#

from testzeus_sdk import TestZeusClient

# Method 1: Email/password
client = TestZeusClient(
    email="[email protected]",
    password="password"
)

# Method 2: Environment variables
# TESTZEUS_EMAIL, TESTZEUS_PASSWORD
client = TestZeusClient()

# Method 3: Custom base URL
client = TestZeusClient(
    base_url="https://prod.testzeus.app/api"
)

Requirements Summary#

Component

Minimum

Recommended

Python

3.9+

3.11+

pip

Latest

Latest

Network

HTTPS

HTTPS

Next Steps#

After installation, you may want to:

  1. Create your first test → Use testzeus-test-authoring skill

  2. Run tests → Use testzeus-test-operations skill

  3. Create a suite → Use testzeus-test-suites skill

  4. View reports → Use testzeus-reports skill

Getting Help#

  • Documentation: https://docs.testzeus.ai

  • GitHub Issues: https://github.com/testzeus/testzeus-cli/issues

  • Discord: https://discord.gg/testzeus

Installation Status Check#

Use this checklist to verify your setup:

☐ testzeus-cli installed     → Run: testzeus --version
☐ testzeus-sdk installed     → Run: python -c "import testzeus_sdk"
☐ Authenticated             → Run: testzeus auth whoami
☐ Can list tests            → Run: testzeus tests list
☐ Can list environments     → Run: testzeus environments list

Component Schema#

Use the InstallationStatus component to display setup status:

{
  "component": "InstallationStatus",
  "props": {
    "cli_installed": true,
    "sdk_installed": true,
    "authenticated": true,
    "version": "1.0.0"
  }
}