Common Features¶
Features shared across Redis Cloud and Redis Enterprise commands.
The Four Layers¶
redisctl is built around four layers of functionality:
graph TB
subgraph "Layer 4: Workflows"
W[Multi-step orchestration]
end
subgraph "Layer 3: Human Commands"
H[Type-safe wrappers]
end
subgraph "Layer 2: Raw API"
R[Direct REST access]
end
subgraph "Layer 1: Profiles"
P[Credential management]
end
P --> R --> H --> W
style W fill:#61afef,color:#000
style H fill:#98c379,color:#000
style R fill:#e5c07b,color:#000
style P fill:#dc382d,color:#fff
| Layer | When to Use |
|---|---|
| Profiles | Always - manage credentials across environments |
| Raw API | Exploring, debugging, or accessing undocumented endpoints |
| Human Commands | Day-to-day operations with friendly output |
| Workflows | Complex multi-step provisioning tasks |
Destructive Commands¶
Commands that delete, flush, reset, or otherwise make irreversible changes ask for confirmation
when run interactively. Use the long-only --force flag to bypass that prompt in automation:
--force only skips the confirmation prompt; it does not change API validation, permissions, or
error handling. The older --yes and -y spellings remain as hidden compatibility aliases on the
commands that previously exposed them. They are deprecated, will be accepted throughout the 0.x
release series, and are scheduled for removal in 1.0.
Features at a Glance¶
-
Profiles
Manage credentials for multiple Redis deployments
-
Output Formats
JSON, YAML, or human-readable tables
-
JMESPath Queries
Filter and transform output with powerful queries
-
Async Operations
Wait for long-running operations to complete
-
Raw API Access
Direct REST calls to any endpoint