Skip to content

Commit 503babf

Browse files
committed
docs: update installation instructions and usage examples across multiple documents
1 parent 90200cf commit 503babf

File tree

7 files changed

+165
-48
lines changed

7 files changed

+165
-48
lines changed

src/docs/faq.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,21 @@ Homebrew installs packages. OpenBoot sets up your **entire** environment — pac
1616

1717
If you're happy managing each of those separately, you don't need OpenBoot. If you'd rather do it in 5 minutes instead of an hour, give it a try.
1818

19-
## Is it safe to pipe curl to bash?
19+
## Should I use Homebrew or the one-line installer?
20+
21+
**Use Homebrew** (`brew install openboot`) if you:
22+
- Already have Homebrew installed
23+
- Want cleaner updates (`brew upgrade openboot`)
24+
- Prefer package managers over `curl | bash`
25+
26+
**Use the one-line installer** if you:
27+
- Don't have Homebrew yet (it installs Homebrew for you)
28+
- Want the absolute fastest setup on a fresh Mac
29+
- Are running in CI/automation environments
30+
31+
Both methods install the exact same binary.
32+
33+
## Is the one-line installer safe?
2034

2135
Fair question. Here's how OpenBoot handles it:
2236

@@ -26,10 +40,12 @@ Fair question. Here's how OpenBoot handles it:
2640
- The binary is downloaded from GitHub Releases with **SHA256 checksum verification**
2741
- You can inspect the script before running it:
2842

29-
```
43+
```bash
3044
curl -fsSL https://openboot.dev/install.sh > install.sh && cat install.sh
3145
```
3246

47+
If you prefer, install via Homebrew instead (see above).
48+
3349
## What if I already have Homebrew?
3450

3551
OpenBoot detects existing Homebrew installs and skips the setup. It also skips already-installed packages — only new ones get installed. Re-running is fast and safe.
@@ -49,11 +65,21 @@ An account (GitHub or Google OAuth) is needed to:
4965

5066
## How do I update OpenBoot?
5167

68+
**If installed via Homebrew:**
69+
70+
```bash
71+
brew upgrade openboot
5272
```
73+
74+
**If installed via the one-line installer:**
75+
76+
```bash
5377
openboot update --self
5478
```
5579

56-
Or re-run the install script — it downloads the latest binary and replaces the old one. Your configs, snapshots, and auth tokens are unaffected.
80+
Or re-run the install script — it downloads the latest binary and replaces the old one.
81+
82+
Your configs, snapshots, and auth tokens are unaffected by updates.
5783

5884
## Where is my data stored?
5985

src/docs/personal.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,26 @@ New Mac, unboxed to coding in 5 minutes. Here's the typical flow for individual
1010

1111
## New Mac: Start from Scratch
1212

13-
Open Terminal, one command:
13+
**Install OpenBoot:**
1414

15+
```bash
16+
brew tap openbootdotdev/tap && brew install openboot
1517
```
16-
curl -fsSL https://openboot.dev/install.sh | bash
18+
19+
Or use the one-line installer: `curl -fsSL https://openboot.dev/install.sh | bash`
20+
21+
**Run setup:**
22+
23+
```bash
24+
openboot
1725
```
1826

1927
The TUI pops up — pick the packages you want, hit Enter to confirm. After installation, restart your terminal and start coding.
2028

2129
If you already know what you need, use a preset to skip the picker:
2230

23-
```
24-
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset developer
31+
```bash
32+
openboot --preset developer
2533
```
2634

2735
See [Presets](/docs/presets) for what's in each. Not sure which one? Go with `developer`.
@@ -62,10 +70,10 @@ Next time you reinstall or switch machines, one command restores everything.
6270

6371
## Day-to-Day Maintenance
6472

65-
```
73+
```bash
6674
openboot doctor # check environment health
6775
openboot update # update all Homebrew packages
68-
openboot update --self # update OpenBoot itself
76+
brew upgrade openboot # update OpenBoot itself (if installed via Homebrew)
6977
```
7078

7179
## Typical Flow

src/docs/presets.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,17 @@ CLI essentials. Fast and lightweight.
2525

2626
**GUI apps:** Warp, Raycast, Maccy, Stats, Rectangle
2727

28+
```bash
29+
openboot --preset minimal
2830
```
31+
32+
<details>
33+
<summary>Or use the one-line installer</summary>
34+
35+
```bash
2936
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset minimal
3037
```
38+
</details>
3139

3240
## developer
3341

@@ -37,9 +45,17 @@ The recommended starting point. Everything you need to start building, nothing y
3745
- **CLI:** node, go, pnpm, docker, docker-compose, lazydocker, tmux, neovim, httpie, pre-commit
3846
- **GUI:** VS Code, OrbStack, Chrome, Arc, Postman, Notion, Scroll Reverser, TablePlus, AppCleaner
3947

48+
```bash
49+
openboot --preset developer
4050
```
51+
52+
<details>
53+
<summary>Or use the one-line installer</summary>
54+
55+
```bash
4156
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset developer
4257
```
58+
</details>
4359

4460
## full
4561

@@ -49,9 +65,17 @@ Complete dev environment. Languages, DevOps, databases, AI tools — all of it.
4965
- **CLI:** python, uv, rustup, deno, bun, cmake, kubectl, helm, k9s, terraform, awscli, sqlite, postgresql, redis, duckdb, ollama, llm, tig, dive
5066
- **GUI:** Cursor, Firefox, Proxyman, Obsidian, Figma, IINA, Keka, AlDente, ngrok, Shottr, Miniconda
5167

68+
```bash
69+
openboot --preset full
5270
```
71+
72+
<details>
73+
<summary>Or use the one-line installer</summary>
74+
75+
```bash
5376
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset full
5477
```
78+
</details>
5579

5680
## Customizing During Install
5781

@@ -68,14 +92,14 @@ Want `developer` but with `kubectl`? Select `developer`, then toggle `kubectl` o
6892

6993
For scripted installs, use `--silent` to install a preset exactly as defined:
7094

71-
```
72-
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset developer --silent
95+
```bash
96+
openboot --preset developer --silent
7397
```
7498

7599
Preview what would be installed first with `--dry-run`:
76100

77-
```
78-
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset developer --dry-run
101+
```bash
102+
openboot --preset developer --dry-run
79103
```
80104

81105
See [CLI Reference](/docs/cli-reference) for automation details.

src/docs/quick-start.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,53 @@ order: 2
88

99
Pick the path that fits your situation.
1010

11-
## New Mac? Bootstrap It
11+
## Installation
12+
13+
### Homebrew (Recommended)
1214

13-
Open Terminal and run:
15+
If you already have Homebrew installed:
1416

17+
```bash
18+
brew tap openbootdotdev/tap
19+
brew install openboot
1520
```
21+
22+
Then run `openboot` to start the interactive setup.
23+
24+
### One-Line Installer
25+
26+
If you don't have Homebrew yet, or prefer the all-in-one installer:
27+
28+
```bash
1629
curl -fsSL https://openboot.dev/install.sh | bash
1730
```
1831

32+
This installer will:
33+
- Install Xcode Command Line Tools (if needed)
34+
- Install Homebrew (if needed)
35+
- Download and run OpenBoot
36+
37+
## New Mac? Bootstrap It
38+
39+
After installing OpenBoot using either method above, run:
40+
41+
```bash
42+
openboot
43+
```
44+
1945
What happens next:
2046

2147
```
22-
✓ Downloaded OpenBoot
23-
✓ Xcode Command Line Tools ready
24-
✓ Homebrew ready
2548
🚀 Launching interactive installer...
2649
```
2750

2851
The TUI opens with the `developer` preset pre-selected. Use **arrow keys** to navigate, **Space** to toggle packages, **Enter** to confirm. After installation, restart your terminal or run `source ~/.zshrc`.
2952

3053
Want a different starting point? Use `--preset`:
3154

32-
```
33-
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset minimal
34-
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset full
55+
```bash
56+
openboot --preset minimal
57+
openboot --preset full
3558
```
3659

3760
See [Presets](/docs/presets) for what's included in each.
@@ -40,16 +63,12 @@ See [Presets](/docs/presets) for what's included in each.
4063

4164
Capture your current Mac's dev environment and save it:
4265

43-
```
44-
curl -fsSL https://openboot.dev/install.sh | bash -s -- snapshot
45-
```
46-
47-
Or if `openboot` is already installed:
48-
49-
```
66+
```bash
5067
openboot snapshot
5168
```
5269

70+
(Or if you haven't installed OpenBoot yet, use the one-line installer: `curl -fsSL https://openboot.dev/install.sh | bash -s -- snapshot`)
71+
5372
Snapshot scans your Homebrew packages, macOS preferences, shell config, and git settings. You'll review everything in a TUI editor before uploading or saving locally.
5473

5574
```
@@ -74,13 +93,20 @@ See [Snapshot](/docs/snapshot) for the full walkthrough.
7493
If you're setting up a team's standard environment:
7594

7695
1. **Create a config** on the [dashboard](/dashboard) — pick a base preset, add/remove packages, set up custom scripts
77-
2. **Share the install URL** in your README or onboarding docs:
96+
2. **Share installation instructions** in your README or onboarding docs:
7897

98+
```bash
99+
brew tap openbootdotdev/tap && brew install openboot
100+
openboot --user yourteam/frontend
79101
```
102+
103+
Or use the one-line installer as an alternative:
104+
105+
```bash
80106
curl -fsSL https://openboot.dev/yourteam/frontend/install.sh | bash
81107
```
82108

83-
3. **New team members** run one command and get your exact setup
109+
3. **New team members** run the commands and get your exact setup
84110

85111
See [For Teams](/docs/teams) for the complete workflow.
86112

src/docs/teams.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,21 +46,28 @@ In the dashboard, refine the config:
4646

4747
### 3. Share
4848

49-
Every config gets a one-line install command:
49+
Every config gets installation instructions. Recommend Homebrew + CLI flag:
5050

51+
```bash
52+
brew tap openbootdotdev/tap && brew install openboot
53+
openboot --user yourteam/frontend
5154
```
55+
56+
Or provide the one-line installer as an alternative:
57+
58+
```bash
5259
curl -fsSL https://openboot.dev/yourteam/frontend/install.sh | bash
5360
```
5461

55-
Put this in your:
62+
Put these in your:
5663

5764
- **README.md** — under "Getting Started" or "Development Setup"
5865
- **Onboarding checklist** — as the first step
5966
- **Slack / Teams channel** — pinned for easy access
6067

6168
### 4. New Developer Joins
6269

63-
They open Terminal on their new Mac and run your command. That's it.
70+
They run the install command. That's it.
6471

6572
OpenBoot handles Homebrew, installs all packages, sets up their shell, clones dotfiles, and applies macOS preferences. They're ready to code in minutes, not hours.
6673

@@ -80,6 +87,6 @@ openboot.dev/yourteam/devops
8087

8188
**Preview before installing.** New team members can preview what they'd get:
8289

83-
```
84-
curl -fsSL https://openboot.dev/yourteam/frontend/install.sh | bash -s -- --dry-run
90+
```bash
91+
openboot --user yourteam/frontend --dry-run
8592
```

src/docs/what-is-openboot.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,24 @@ OpenBoot is an open-source CLI that sets up your entire macOS development enviro
2020

2121
## How It Works
2222

23+
**Install via Homebrew (recommended):**
24+
25+
```bash
26+
brew tap openbootdotdev/tap
27+
brew install openboot
28+
openboot
2329
```
30+
31+
**Or use the one-line installer:**
32+
33+
```bash
2434
curl -fsSL https://openboot.dev/install.sh | bash
2535
```
2636

27-
This one command:
37+
The installer:
2838

29-
1. Downloads the `openboot` binary
30-
2. Installs Xcode Command Line Tools and Homebrew (if needed)
39+
1. Installs Xcode Command Line Tools and Homebrew (if needed)
40+
2. Downloads the `openboot` binary
3141
3. Launches an interactive TUI where you pick your packages
3242
4. Installs everything, configures your shell, and applies macOS preferences
3343

0 commit comments

Comments
 (0)