Skip to content

docs: repair application-specific release installation recipes #1184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshrotenberg wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: repair application-specific release installation recipes #1184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3877e0c
chore: start release installation docs repair (#1183)
joshrotenberg Oct 6, 2026
fc69f83
docs: repair application-specific release installation recipes (#1183)
joshrotenberg Oct 6, 2026
19376e6
docs: clarify ARM64 container alternative
joshrotenberg Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 27 additions & 14 deletions docs/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,50 +48,63 @@ cargo install redisctl --features secure-storage

## Binary Downloads

Download pre-built binaries from [GitHub Releases](https://github.com/redis/redisctl/releases/latest).
The examples below install **redisctl 0.12.1** from its
[CLI release](https://github.com/redis/redisctl/releases/tag/redisctl-v0.12.1).
For another version, choose its `redisctl-v<VERSION>` release and matching assets.
Avoid the repository-wide "latest" link: this workspace releases the CLI and MCP
server separately, so "latest" may point to the other application.

Archives contain a top-level platform directory. These commands extract it into
a temporary directory before installing the binary.

=== "Linux (x86_64)"

``` bash
curl -L https://github.com/redis/redisctl/releases/latest/download/redisctl-x86_64-unknown-linux-gnu.tar.xz | tar xJ
sudo mv redisctl /usr/local/bin/
install_dir="$(mktemp -d)"
curl -fL https://github.com/redis/redisctl/releases/download/redisctl-v0.12.1/redisctl-x86_64-unknown-linux-gnu.tar.xz -o "$install_dir/redisctl.tar.xz"
tar -xJf "$install_dir/redisctl.tar.xz" --strip-components=1 -C "$install_dir"
sudo install -m 755 "$install_dir/redisctl" /usr/local/bin/redisctl
```

=== "Linux (ARM64)"

``` bash
curl -L https://github.com/redis/redisctl/releases/latest/download/redisctl-aarch64-unknown-linux-gnu.tar.xz | tar xJ
sudo mv redisctl /usr/local/bin/
```
Version 0.12.1 does not provide a pre-built Linux ARM64 archive. Build from
source with [Cargo](#cargo-from-source), or see the [Docker guide](docker.md)
for container-based installation.

=== "macOS (Intel)"

``` bash
curl -L https://github.com/redis/redisctl/releases/latest/download/redisctl-x86_64-apple-darwin.tar.xz | tar xJ
sudo mv redisctl /usr/local/bin/
install_dir="$(mktemp -d)"
curl -fL https://github.com/redis/redisctl/releases/download/redisctl-v0.12.1/redisctl-x86_64-apple-darwin.tar.xz -o "$install_dir/redisctl.tar.xz"
tar -xJf "$install_dir/redisctl.tar.xz" --strip-components=1 -C "$install_dir"
sudo install -m 755 "$install_dir/redisctl" /usr/local/bin/redisctl
```

=== "macOS (Apple Silicon)"

``` bash
curl -L https://github.com/redis/redisctl/releases/latest/download/redisctl-aarch64-apple-darwin.tar.xz | tar xJ
sudo mv redisctl /usr/local/bin/
install_dir="$(mktemp -d)"
curl -fL https://github.com/redis/redisctl/releases/download/redisctl-v0.12.1/redisctl-aarch64-apple-darwin.tar.xz -o "$install_dir/redisctl.tar.xz"
tar -xJf "$install_dir/redisctl.tar.xz" --strip-components=1 -C "$install_dir"
sudo install -m 755 "$install_dir/redisctl" /usr/local/bin/redisctl
```

=== "Windows"

Download the `.zip` file from releases and extract to a directory in your PATH.
Download the [Windows x86_64 archive](https://github.com/redis/redisctl/releases/download/redisctl-v0.12.1/redisctl-x86_64-pc-windows-msvc.zip),
extract it, and add the directory containing `redisctl.exe` to your PATH.

## Verify Installation

```bash
redisctl --version
```

Expected output:
For the 0.12.1 binary download examples above, the expected output is:

```
redisctl 0.11.1
redisctl 0.12.1
```

## Shell Completions
Expand Down
15 changes: 12 additions & 3 deletions docs/docs/mcp/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,20 @@ The MCP server is a separate binary called `redisctl-mcp`. Install it using one

### Installer Script (Recommended)

These examples install **redisctl-mcp 0.12.1** from its
[MCP release](https://github.com/redis/redisctl/releases/tag/redisctl-mcp-v0.12.1).
For another version, choose its `redisctl-mcp-v<VERSION>` release and matching
installer. Avoid the repository-wide "latest" link: the CLI and MCP server are
released separately, so "latest" may contain only CLI assets.

```bash
# macOS / Linux
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/redis/redisctl/releases/latest/download/redisctl-mcp-installer.sh | sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/redis/redisctl/releases/download/redisctl-mcp-v0.12.1/redisctl-mcp-installer.sh | sh
```

```powershell
# Windows
powershell -ExecutionPolicy Bypass -c "irm https://github.com/redis/redisctl/releases/latest/download/redisctl-mcp-installer.ps1 | iex"
powershell -ExecutionPolicy Bypass -c "irm https://github.com/redis/redisctl/releases/download/redisctl-mcp-v0.12.1/redisctl-mcp-installer.ps1 | iex"
```

### Cargo
Expand All @@ -26,7 +32,10 @@ cargo install redisctl-mcp

### Binary Downloads

Download pre-built binaries from [GitHub Releases](https://github.com/redis/redisctl/releases/latest).
Download pre-built binaries from the
[MCP release](https://github.com/redis/redisctl/releases/tag/redisctl-mcp-v0.12.1),
not the CLI release. Use the archive for your platform and add the extracted
directory containing `redisctl-mcp` (or `redisctl-mcp.exe` on Windows) to your PATH.

### Docker (Zero-Install)

Expand Down
Loading