Skip to content

Commit df168f6

Browse files
committed
docs: add Homebrew installation to docs
1 parent 235bd6a commit df168f6

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/src/getting-started/installation.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
11
# Installation
22

3+
## Homebrew (macOS/Linux)
4+
5+
The easiest way to install on macOS or Linux:
6+
7+
```bash
8+
# Install directly (automatically taps the repository)
9+
brew install joshrotenberg/brew/redisctl
10+
11+
# Or tap first, then install
12+
brew tap joshrotenberg/brew
13+
brew install redisctl
14+
```
15+
16+
This will:
17+
- Install the latest stable version
18+
- Set up the binary in your PATH
19+
- Enable automatic updates via `brew upgrade`
20+
21+
To upgrade to the latest version:
22+
```bash
23+
brew upgrade redisctl
24+
```
25+
326
## Binary Releases
427

528
Download the latest release for your platform from the [GitHub releases page](https://github.com/joshrotenberg/redisctl/releases).

docs/src/introduction.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@ The CLI provides three layers of interaction:
1717
2. **Human-Friendly Commands** - Typed wrappers around common operations
1818
3. **Workflows** - Multi-step orchestrated operations (coming soon)
1919

20+
## Installation
21+
22+
Get started quickly with Homebrew:
23+
24+
```bash
25+
brew install joshrotenberg/brew/redisctl
26+
```
27+
28+
Or see [Installation](./getting-started/installation.md) for other methods.
29+
2030
## Quick Example
2131

2232
```bash

0 commit comments

Comments
 (0)