Skip to content

setup - Cloud Credentials

Interactive setup and management for cloud platform credentials.

Basic Syntax

Terminal window
benchbox setup --platform <name> [OPTIONS]

Supported Platforms

PlatformRequired Credentials
databricksserver_hostname, http_path, access_token
snowflakeaccount, user, password, warehouse
bigqueryproject_id, credentials_file
redshifthost, port, database, user, password
athenas3_staging_dir, region

Options

  • --platform [databricks|snowflake|bigquery|redshift|athena]: Platform to configure (required unless using --list-platforms or --status alone). Case-insensitive.
  • --validate-only: Validate existing credentials without modifying them
  • --list-platforms: List all platforms with their configuration status
  • --status: Show credential status for all configured platforms
  • --remove: Remove stored credentials for the specified platform
  • --diagnose: Run connectivity diagnostics (Redshift only)

Usage Examples

Terminal window
benchbox setup --platform databricks
benchbox setup --list-platforms
benchbox setup --status
benchbox setup --platform snowflake --validate-only
benchbox setup --platform redshift --diagnose
benchbox setup --platform databricks --remove

The commands, in order, run interactive credential setup, list all platforms and their status, check credential status across all platforms, validate credentials without modifying them, run connectivity diagnostics (Redshift only), and remove stored credentials.

Notes

  • Credentials are stored securely via the CredentialManager. The --status command shows when credentials were last updated and validated.
  • Platform dependencies are checked before setup. If required packages are missing, the command provides installation instructions.
  • The --diagnose flag is currently only supported for Redshift, where it tests TCP connectivity and checks AWS API-level cluster accessibility.
  • run - Run benchmarks on cloud platforms
  • configuration - General configuration and environment variables