redisctl¶
The CLI for Redis Cloud and Redis Enterprise
-
Get Started in 60 Seconds
Install with Homebrew or Docker and run your first command
-
Redis Cloud
Manage subscriptions, databases, networking, and access control
-
Redis Enterprise
Control clusters, nodes, databases, and generate support packages
-
Cookbook
Step-by-step guides for common tasks and workflows
What is redisctl?¶
redisctl is the first command-line tool for managing Redis Cloud and Redis Enterprise deployments. Before redisctl, operators had to use web UIs or write fragile bash scripts with curl and polling loops.
# Before redisctl
curl -s -X POST "https://api.redislabs.com/v1/subscriptions/123/databases" \
-H "x-api-key: $KEY" -H "x-api-secret-key: $SECRET" \
-d '{"name": "mydb", ...}'
# Then poll for status... parse JSON... hope nothing changes...
# With redisctl
redisctl cloud database create --subscription 123 --name mydb --wait
Key Features¶
- Type-Safe API Clients
- Catch errors at compile time, not at 3am
- Async Operation Handling
- No more polling loops - just add
--wait - Support Package Automation
- 10+ minutes of manual work in 30 seconds
- Profile Management
- Secure credential storage with OS keyring support
- Structured Output
- JSON, YAML, or tables with JMESPath queries
- Library-First Architecture
- Reusable
redis-cloudandredis-enterprisecrates
The Four Layers¶
redisctl provides four layers of functionality:
graph LR
A[Profiles] --> B[Raw API]
B --> C[Human Commands]
C --> D[Workflows]
style A fill:#dc382d,color:#fff
style B fill:#e5c07b,color:#000
style C fill:#98c379,color:#000
style D fill:#61afef,color:#000
| Layer | Purpose | Example |
|---|---|---|
| Profiles | Credential management | redisctl profile set prod --api-key $KEY |
| Raw API | Direct REST access | redisctl api cloud get /subscriptions |
| Human Commands | Type-safe wrappers | redisctl cloud database list |
| Workflows | Multi-step operations | redisctl cloud workflow subscription-setup |
Quick Install¶
Who Uses redisctl?¶
Support Engineers
Generate and upload support packages in seconds instead of minutes
DevOps / SRE
Automate database provisioning in CI/CD pipelines
Platform Engineers
Build self-service portals on top of redisctl libraries
Solutions Architects
Quickly spin up demo environments and PoCs
-
Open Source
MIT licensed. Contributions welcome.
-
API Docs
Rust library documentation on docs.rs