Skip to content

Commit 604ab32

Browse files
committed
docs: update installation to recommend Homebrew over Cargo
Homebrew is now the recommended installation method. Building from source moved to a separate section for development/power users.
1 parent cea6bac commit 604ab32

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ A lightweight Rust CLI that wraps shell commands and terminals in macOS Seatbelt
1818
## Quick Start
1919

2020
```bash
21-
# Install
22-
cargo install --path .
21+
# Install via Homebrew
22+
brew tap agentic-dev3o/sx
23+
brew install sx
2324

2425
# Run commands in an isolated sandbox (network blocked, credentials protected)
2526
sx -- bun lint
@@ -34,15 +35,24 @@ That's it. Your credentials (`~/.ssh`, `~/.aws`, `~/.gnupg`) and personal files
3435

3536
## Installation
3637

37-
### Using Cargo (Recommended)
38+
### Homebrew (Recommended)
39+
40+
```bash
41+
brew tap agentic-dev3o/sx
42+
brew install sx
43+
```
44+
45+
### From Source
46+
47+
For development or if you want full control over the build:
3848

3949
```bash
4050
git clone https://github.com/agentic-dev3o/sandbox-shell.git
4151
cd sandbox-shell
4252
cargo install --path .
4353
```
4454

45-
### Manual Build
55+
Or build manually:
4656

4757
```bash
4858
cargo build --release
@@ -56,7 +66,7 @@ sx --version
5666
sx --help
5767
```
5868

59-
**Requirements:** macOS (uses Apple's Seatbelt sandbox), Rust 1.70+
69+
**Requirements:** macOS (uses Apple's Seatbelt sandbox). Building from source requires Rust 1.70+.
6070

6171
## Use Cases
6272

0 commit comments

Comments
 (0)