Skip to content

Quick Start

Get running in 60 seconds with Docker.

Try It Now

Redis Cloud

# Set your credentials
export REDIS_CLOUD_API_KEY="your-api-key"
export REDIS_CLOUD_SECRET_KEY="your-secret-key"

# Run a command
docker run --rm \
  -e REDIS_CLOUD_API_KEY \
  -e REDIS_CLOUD_SECRET_KEY \
  ghcr.io/redis-developer/redisctl cloud subscription list

Getting API Keys

Get your API keys from the Redis Cloud console under Access Management > API Keys.

Redis Enterprise

# Set your credentials
export REDIS_ENTERPRISE_URL="https://cluster.example.com:9443"
export REDIS_ENTERPRISE_USER="admin@cluster.local"
export REDIS_ENTERPRISE_PASSWORD="your-password"
export REDIS_ENTERPRISE_INSECURE="true"  # for self-signed certs

# Run a command
docker run --rm \
  -e REDIS_ENTERPRISE_URL \
  -e REDIS_ENTERPRISE_USER \
  -e REDIS_ENTERPRISE_PASSWORD \
  -e REDIS_ENTERPRISE_INSECURE \
  ghcr.io/redis-developer/redisctl enterprise cluster get

That's it! You just ran your first redisctl command.

What Just Happened?

  1. Docker pulled the image - Pre-built with everything you need
  2. Environment variables - Passed your credentials securely
  3. Command executed - Called the Redis API and formatted the output

Common First Commands

List Resources

# Cloud: List all subscriptions
redisctl cloud subscription list

# Cloud: List databases in a subscription
redisctl cloud database list --subscription-id 123456

# Enterprise: Get cluster info
redisctl enterprise cluster get

# Enterprise: List all databases
redisctl enterprise database list

Get JSON Output

Add -o json to any command for structured output:

redisctl cloud subscription list -o json

Filter with JMESPath

Use -q to query and filter results:

# Get just subscription names
redisctl cloud subscription list -o json -q '[].name'

# Count databases
redisctl enterprise database list -o json -q 'length(@)'

Next Steps

Choose your path: