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 a command-line tool for managing Redis Cloud and Redis Enterprise deployments.

Features

redisctl provides:

  • 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
  • AI Integration - Built-in MCP server for Claude and other AI assistants

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

# Docker (quick start)
docker run ghcr.io/redis-developer/redisctl:latest --help

# macOS/Linux
brew install redis-developer/homebrew-tap/redisctl

# Or download from GitHub releases

See Installation for all methods, or try the Quick Start with Docker.

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?