Skip to content

Commit 48b4b78

Browse files
authored
Merge pull request #1822 from entireio/docs/quick-start-per-os
docs: split Quick Start install instructions by operating system
2 parents d777af9 + ba4bb2a commit 48b4b78

1 file changed

Lines changed: 24 additions & 13 deletions

File tree

README.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,34 +43,45 @@ With Entire, you can:
4343

4444
## Quick Start
4545

46+
### macOS and Linux
47+
48+
Install with Homebrew:
49+
4650
```bash
47-
# To use Homebrew, first tap:
4851
brew tap entireio/tap
4952
brew trust entireio/tap
53+
brew install --cask entire # stable
54+
# brew install --cask entire@nightly # or nightly
55+
```
5056

51-
# Install stable via Homebrew
52-
brew install --cask entire
57+
Or with the install script:
5358

54-
# Or install nightly via Homebrew
55-
brew install --cask entire@nightly
59+
```bash
60+
curl -fsSL https://entire.io/install.sh | bash # stable
61+
# curl -fsSL https://entire.io/install.sh | bash -s -- --channel nightly # or nightly
62+
```
5663

57-
# Or install stable via install.sh
58-
curl -fsSL https://entire.io/install.sh | bash
64+
### Windows
5965

60-
# Or install nightly via install.sh
61-
curl -fsSL https://entire.io/install.sh | bash -s -- --channel nightly
66+
Install with Scoop:
6267

63-
# Or install stable via Scoop (Windows)
68+
```powershell
6469
scoop bucket add entire https://github.com/entireio/scoop-bucket.git
6570
scoop install entire/cli
71+
```
6672

67-
# Or install via Go (development/manual setup)
73+
### Go (development/manual setup)
74+
75+
```bash
6876
go install github.com/entireio/cli/cmd/entire@latest
6977

70-
# Linux: Add Go binaries to PATH (add to ~/.zshrc or ~/.bashrc if not already configured)
78+
# Add Go binaries to PATH (add to ~/.zshrc or ~/.bashrc if not already configured)
7179
export PATH="$HOME/go/bin:$PATH"
80+
```
7281

73-
# Enable in your project
82+
### Enable in your project
83+
84+
```bash
7485
cd your-project && entire enable
7586

7687
# Check status

0 commit comments

Comments
 (0)