Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quick Start

This guide will get you running your first commands in 5 minutes.

Step 1: Configure Credentials

Choose one method:

Option A: Environment Variables (Quickest)

# For Redis Cloud
export REDIS_CLOUD_API_KEY="your-key"
export REDIS_CLOUD_API_SECRET="your-secret"

# For Redis Enterprise
export REDIS_ENTERPRISE_URL="https://cluster:9443"
export REDIS_ENTERPRISE_USER="admin@cluster.local"
export REDIS_ENTERPRISE_PASSWORD="your-password"

Option B: Configuration File

Create ~/.config/redisctl/config.toml:

[profiles.default]
deployment_type = "cloud"  # or "enterprise"
api_key = "your-key"
api_secret = "your-secret"

Step 2: Test Connection

# For Cloud
redisctl api cloud get /

# For Enterprise
redisctl api enterprise get /v1/cluster

Step 3: Common Commands

List Resources

# List all databases
redisctl cloud database list

# List in table format
redisctl cloud database list -o table

# Filter active databases only
redisctl cloud database list -q "[?status=='active']"

Get Details

# Get database details
redisctl cloud database get 12345

# Get as YAML
redisctl cloud database get 12345 -o yaml

Direct API Access

# Any Cloud API endpoint
redisctl api cloud get /subscriptions
redisctl api cloud get /subscriptions/12345/databases

# Any Enterprise API endpoint
redisctl api enterprise get /v1/bdbs
redisctl api enterprise get /v1/nodes

Step 4: Using Workflows

Initialize Enterprise Cluster

For new Redis Enterprise installations, use the init-cluster workflow:

# Complete cluster setup with one command
redisctl enterprise workflow init-cluster \
  --username "admin@cluster.local" \
  --password "YourSecurePassword"

# This workflow will:
# 1. Bootstrap the cluster
# 2. Set up authentication
# 3. Create a default database
# 4. Verify connectivity

Step 5: Explore More

Cloud Operations

# Cloud-specific commands
redisctl cloud subscription list
redisctl cloud database list --subscription-id 12345

Enterprise Operations

# Enterprise-specific commands
redisctl enterprise cluster info
redisctl enterprise database list
redisctl enterprise node list

Output Options

# JSON (default)
redisctl enterprise database list

# Table format
redisctl enterprise database list -o table

# YAML
redisctl enterprise database list -o yaml

# Filter with JMESPath
redisctl enterprise database list -q "[].{name:name,memory:memory_size}"

What's Next?