Paladin Setup Check

Comprehensive environment validation to ensure your Paladin installation is correctly configured.

Overview

The paladin setup-check command validates your entire Paladin environment:

  • System requirements (CLI version, Rust toolchain)
  • Environment configuration (.env file, API keys)
  • LLM provider connectivity (OpenAI, Anthropic, DeepSeek)
  • Optional services (Redis, Qdrant, MinIO)

Quick Start

# Basic validation
paladin setup-check

# Detailed output with timing
paladin setup-check --verbose

# Minimal output (CI-friendly)
paladin setup-check --quiet

Command Options

Build the binary with the cli feature before capturing this output yourself: cargo build --release --features cli --bin paladin-cli (the binary carries required-features = ["cli"] and is not produced by a default cargo build).

$ paladin-cli setup-check --help
Check environment setup and configuration

Usage: paladin-cli setup-check [OPTIONS]

Options:
      --verbose  Show detailed diagnostic information
      --quiet    Enable quiet mode (minimal output)
  -h, --help     Print help

setup-check exposes one flag of its own, --verbose ("Show detailed diagnostic information"); --quiet is the global flag shared by every subcommand. There is no short alias for either flag, and output is always the human-readable format shown below — there is no machine-readable output option.

Check Categories

1. System Checks

Validates core system requirements:

System:
  ✓ Paladin CLI: v0.1.0
  ✓ Rust Toolchain: 1.88.0 (stable)

What's checked:

  • Paladin CLI version (from Cargo.toml)
  • Rust compiler version (rustc --version)
  • Binary build date and features

Verbose output:

System:
  ✓ Paladin CLI: v0.1.0
    Build: 2026-02-09 10:30:00 UTC
    Features: redis-queue, s3-storage, qdrant-vector
  ✓ Rust Toolchain: rustc 1.88.0 (6b00bc388 2025-06-23)
    Host: x86_64-unknown-linux-gnu

2. Environment Checks

Validates configuration files and environment variables:

Environment:
  ✓ .env file: Found (12 variables loaded)
  ✓ OPENAI_API_KEY: Configured (sk-...xyz)
  ⚠ ANTHROPIC_API_KEY: Not configured
  ⚠ DEEPSEEK_API_KEY: Not configured

What's checked:

  • .env file existence and parsability
  • Required environment variables
  • API key format validation (prefix, length)
  • Configuration completeness

Status Indicators:

  • ✓ Pass: Configured and valid format
  • ⚠ Warn: Not configured (optional)
  • ✗ Fail: Configured but invalid format

3. Provider Checks

Tests connectivity to configured LLM providers:

Providers:
  ✓ OpenAI: Connected [342ms]
    Models: gpt-4, gpt-3.5-turbo, gpt-4-32k
  ✗ Anthropic: Authentication failed
    Error: Invalid API key format
  - DeepSeek: Not configured (skipped)

What's checked:

  • OpenAI (GET /v1/models)

    • Authentication
    • Available models
    • Response time

  • Anthropic (POST /v1/messages minimal request)

    • Authentication
    • API version compatibility
    • Response time

  • DeepSeek (GET /models)

    • Authentication
    • Available models
    • Response time

Verbose output includes:

  • Full model lists
  • API endpoint URLs
  • Request/response times
  • Quota/rate limit info (if available)

4. Service Checks (Optional)

Tests connectivity to optional external services:

Services (Optional):
  ✓ Redis: Connected [15ms]
    Version: 7.0.11
    Memory: 1.2MB / 512MB used
  ✓ Qdrant: Connected [28ms]
    Version: 1.7.4
    Collections: 2 (paladin_memory, documents)
  - MinIO: Not configured (skipped)

What's checked:

Redis (if REDIS_URL configured):

  • Connection test
  • PING command
  • Server version
  • Memory usage stats

Qdrant (if QDRANT_URL configured):

  • Connection test
  • Version check
  • Collection list
  • Health status

MinIO (if MINIO_ENDPOINT configured):

  • Connection test
  • Bucket list
  • Credentials validation

Status Indicators:

  • ✓ Pass: Connected and operational
  • ⚠ Warn: Connected but issues detected
  • ✗ Fail: Cannot connect or authentication failed
    • Skip: Not configured (not an error)

Exit Codes

The command returns different exit codes based on results:

Exit CodeMeaningDescription
0SuccessAll checks passed
1Critical FailureOne or more critical checks failed
2WarningsAll critical checks passed, but warnings present

Usage in scripts:

#!/bin/bash

paladin setup-check --quiet
status=$?

case $status in
  0)
    echo "✓ Environment ready"
    ./run-deployment.sh
    ;;
  1)
    echo "✗ Critical failures detected"
    exit 1
    ;;
  2)
    echo "⚠ Warnings present, proceeding anyway"
    ./run-deployment.sh
    ;;
esac

Output Formats

Standard Format (Human-Readable)

Default terminal-friendly output with colors and Unicode symbols:

=== Paladin Setup Check ===

System:
  ✓ Paladin CLI: v0.1.0
  ✓ Rust Toolchain: 1.88.0

Environment:
  ✓ .env file: Found
  ✓ OPENAI_API_KEY: Configured

Providers:
  ✓ OpenAI: Connected [342ms]

Services (Optional):
  ✓ Redis: Connected [15ms]
  - Qdrant: Not configured

=== Summary ===
✓ 5 passed
⚠ 1 warning
✗ 0 failed

All critical checks passed!

Verbose Format

Includes additional diagnostic information:

paladin setup-check --verbose

=== Paladin Setup Check (Verbose) ===

System:
  ✓ Paladin CLI
    Version: v0.1.0
    Build Date: 2026-02-09 10:30:00 UTC
    Git Commit: abc123f
    Features: redis-queue, s3-storage, qdrant-vector

  ✓ Rust Toolchain
    Version: rustc 1.88.0 (6b00bc388 2025-06-23)
    Host: x86_64-unknown-linux-gnu
    LLVM: 17.0.6

Environment:
  ✓ .env file
    Path: /home/user/project/.env
    Size: 438 bytes
    Variables: 12
    Last Modified: 2026-02-09 09:15:23

  ✓ OPENAI_API_KEY
    Format: Valid (sk-...xyz)
    Length: 51 characters
    Status: Configured

Providers:
  ✓ OpenAI
    Endpoint: https://api.openai.com/v1
    Status: Connected
    Response Time: 342ms
    Models: 8 available
      - gpt-4 (context: 8192)
      - gpt-3.5-turbo (context: 4096)
      - gpt-4-32k (context: 32768)
    Organization: org-...

[... continues ...]

Troubleshooting

System Checks Fail

Problem: CLI version check fails

System:
  ✗ Paladin CLI: Version not found

Solutions:

  1. Verify installation:

    which paladin
paladin --version

  2. Rebuild if needed:

    cargo build --release --features cli --bin paladin-cli

  3. Check PATH:

    echo $PATH
export PATH="$PATH:/path/to/paladin/target/release"

Provider Checks Fail

Problem: OpenAI authentication fails

Providers:
  ✗ OpenAI: Authentication failed (401)
    Error: Incorrect API key provided

Solutions:

  1. Verify API key:

    echo $OPENAI_API_KEY
# Should start with sk- and be 51+ characters

  2. Test directly:

    curl https://api.openai.com/v1/models \
  -H "Authorization: Bearer $OPENAI_API_KEY"

  3. Re-run onboarding:

    paladin onboarding

Problem: Connection timeout

Providers:
  ✗ Anthropic: Connection timeout (5000ms)

Solutions:

  1. Check network connectivity:

    ping api.anthropic.com
curl -I https://api.anthropic.com

  2. Check proxy settings:

    env | grep -i proxy

  3. Increase timeout:

    PALADIN_REQUEST_TIMEOUT=10000 paladin setup-check

Service Checks Fail

Problem: Redis connection fails

Services (Optional):
  ✗ Redis: Connection refused
    Error: ECONNREFUSED 127.0.0.1:6379

Solutions:

  1. Start Redis:

    # Docker
docker run -d -p 6379:6379 redis:7-alpine

# System service
sudo systemctl start redis

  2. Check configuration:

    echo $REDIS_URL
# Should be: redis://localhost:6379

  3. Test connection:

    redis-cli ping
# Should return: PONG

Continuous Integration

Use in CI/CD pipelines:

# GitHub Actions
- name: Validate Paladin Environment
  run: |
    paladin setup-check --quiet
  env:
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

// Jenkins
stage('Validate Environment') {
  steps {
    sh '''
      paladin setup-check --quiet
      if [ $? -ne 0 ]; then
        echo "Environment validation failed"
        exit 1
      fi
    '''
  }
}

See Also