You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you prefer, install via Homebrew instead (see above).
48
+
33
49
## What if I already have Homebrew?
34
50
35
51
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:
49
65
50
66
## How do I update OpenBoot?
51
67
68
+
**If installed via Homebrew:**
69
+
70
+
```bash
71
+
brew upgrade openboot
52
72
```
73
+
74
+
**If installed via the one-line installer:**
75
+
76
+
```bash
53
77
openboot update --self
54
78
```
55
79
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.
Copy file name to clipboardExpand all lines: src/docs/quick-start.md
+43-17Lines changed: 43 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,30 +8,53 @@ order: 2
8
8
9
9
Pick the path that fits your situation.
10
10
11
-
## New Mac? Bootstrap It
11
+
## Installation
12
+
13
+
### Homebrew (Recommended)
12
14
13
-
Open Terminal and run:
15
+
If you already have Homebrew installed:
14
16
17
+
```bash
18
+
brew tap openbootdotdev/tap
19
+
brew install openboot
15
20
```
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
16
29
curl -fsSL https://openboot.dev/install.sh | bash
17
30
```
18
31
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
+
19
45
What happens next:
20
46
21
47
```
22
-
✓ Downloaded OpenBoot
23
-
✓ Xcode Command Line Tools ready
24
-
✓ Homebrew ready
25
48
🚀 Launching interactive installer...
26
49
```
27
50
28
51
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`.
(Or if you haven't installed OpenBoot yet, use the one-line installer: `curl -fsSL https://openboot.dev/install.sh | bash -s -- snapshot`)
71
+
53
72
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.
54
73
55
74
```
@@ -74,13 +93,20 @@ See [Snapshot](/docs/snapshot) for the full walkthrough.
74
93
If you're setting up a team's standard environment:
75
94
76
95
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:
78
97
98
+
```bash
99
+
brew tap openbootdotdev/tap && brew install openboot
-**README.md** — under "Getting Started" or "Development Setup"
58
65
-**Onboarding checklist** — as the first step
59
66
-**Slack / Teams channel** — pinned for easy access
60
67
61
68
### 4. New Developer Joins
62
69
63
-
They open Terminal on their new Mac and run your command. That's it.
70
+
They run the install command. That's it.
64
71
65
72
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.
66
73
@@ -80,6 +87,6 @@ openboot.dev/yourteam/devops
80
87
81
88
**Preview before installing.** New team members can preview what they'd get:
0 commit comments