Introduction

redisctl is a unified command-line tool for managing Redis Cloud and Redis Enterprise deployments through their REST APIs.

Why redisctl?

• Single Tool - One CLI for both Cloud and Enterprise deployments
• Smart Routing - Automatically uses the right API based on your configuration
• Multiple Interfaces - Raw API access, human-friendly commands, and orchestrated workflows
• Flexible Output - JSON, YAML, or formatted tables with JMESPath filtering

Command Layers

The CLI provides three layers of interaction:

1. Raw API Access - Direct REST calls to any endpoint
2. Human-Friendly Commands - Typed wrappers around common operations
3. Workflows - Multi-step orchestrated operations (coming soon)

Quick Example

# Configure your profile
export REDIS_CLOUD_API_KEY="your-key"
export REDIS_CLOUD_API_SECRET="your-secret"

# List all databases
redisctl database list

# Get specific database details
redisctl database get 12345

# Direct API call
redisctl api cloud get /subscriptions

Next Steps

• Installation - Get redisctl installed
• Configuration - Set up your profiles
• Quick Start - Your first commands