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

Introduction

redisctl is the first command-line tool for managing Redis Cloud and Redis Enterprise deployments.

The Problem

Before redisctl existed, managing Redis deployments meant:

  • Manual UI clicking with no scriptability
  • Writing fragile bash scripts with curl and jq
  • Manual polling loops to wait for operations
  • Credential exposure on command lines
  • Every operator reinventing the same scripts

The Solution

redisctl provides a first-class CLI experience with:

  • Type-Safe API Clients - Catch errors at compile time
  • Async Operation Handling - Automatic polling with --wait
  • Support Package Automation - 10+ minutes → 30 seconds
  • Profile Management - Secure credential storage
  • Structured Output - JSON, YAML, or Table with JMESPath
  • Library-First Architecture - Reusable components

Quick Example

# Configure once
redisctl profile set prod --api-key $KEY --api-secret $SECRET

# Create subscription and wait
redisctl cloud subscription create \
  --name prod \
  --cloud-provider AWS \
  --region us-east-1 \
  --wait

# Everything just works
redisctl cloud database create --subscription $SUB --name mydb --wait

Installation

# macOS/Linux
brew install joshrotenberg/brew/redisctl

# Or download from GitHub releases
# Or use Docker
docker run ghcr.io/joshrotenberg/redisctl:latest --help

See Installation for all methods.

Quick Start Paths

Architecture

redisctl is built as reusable libraries:

  • redisctl-config - Profile and credential management
  • redis-cloud - Cloud API client (21 handlers, 95%+ coverage)
  • redis-enterprise - Enterprise API client (29 handlers, 100% coverage)
  • redisctl - CLI binary (thin orchestration layer)

This enables Terraform providers, backup tools, monitoring dashboards, and more.

Next Steps

  1. Install redisctl
  2. Configure profiles
  3. Try the quickstart
  4. Explore the cookbook

Need Help?