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
- Update tool count from 60+ to 80+ (actual catalog has 88 packages)
- Fix macOS preferences count 24→23 to match DefaultPreferences
- Add missing CLI commands (doctor, update, version) and flags to docs
- Add --import flag to snapshot docs
- Fix all bare curl URLs to include https://
- Unify preset descriptions across homepage, docs, and CLI
- Fix non-interactive install docs to require --silent flag
- Correct snapshot dev tools list to match capture.go detection
- Fix 'rust' → 'rustup' in homepage preset example
- Update checksum verification wording in FAQ
|`--shell <mode>`| Shell setup mode: `install` or `skip`|
68
+
|`--macos <mode>`| macOS preferences: `configure` or `skip`|
69
+
|`--dotfiles <mode>`| Dotfiles mode: `clone`, `link`, or `skip`|
70
+
|`--update`| Update Homebrew before installing |
71
+
|`--rollback`| Restore backed-up config files |
72
+
47
73
## Snapshot Commands
48
74
49
75
### `openboot snapshot`
50
76
51
-
Capture your current Mac's development environment. Scans Homebrew packages, macOS preferences, shell config, git config, and installed dev tools.
77
+
Capture your current Mac's development environment. Scans Homebrew packages, npm globals, macOS preferences, shell config, git config, and installed dev tools.
52
78
53
79
```
54
80
openboot snapshot
@@ -74,7 +100,7 @@ Output the snapshot as JSON to stdout. Useful for piping to other tools or inspe
The import flow launches the snapshot editor TUI so you can review and toggle items before installing.
125
+
126
+
### Snapshot Flags
127
+
128
+
| Flag | Description |
129
+
|------|-------------|
130
+
|`--local`| Save snapshot to `~/.openboot/snapshot.json`|
131
+
|`--json`| Output as JSON to stdout |
132
+
|`--dry-run`| Preview without saving, uploading, or installing |
133
+
|`--import <path>`| Restore from a local file or URL |
134
+
135
+
## Utility Commands
136
+
137
+
### `openboot doctor`
138
+
139
+
Run diagnostic checks on your development environment. Checks network connectivity, disk space, Homebrew health, Git configuration, shell setup, and essential tools.
140
+
141
+
```
142
+
openboot doctor
143
+
```
144
+
145
+
Example output:
146
+
147
+
```
148
+
✓ Network connectivity
149
+
✓ Disk space (48 GB free)
150
+
✓ Homebrew installed
151
+
✓ Homebrew health
152
+
✓ Git installed
153
+
✓ Git identity
154
+
✓ Oh-My-Zsh installed
155
+
✓ .zshrc exists
156
+
157
+
All checks passed! Your environment is healthy.
158
+
```
159
+
160
+
### `openboot update`
161
+
162
+
Update Homebrew package definitions and upgrade all installed packages.
163
+
164
+
```
165
+
openboot update
166
+
openboot update --dry-run
167
+
```
168
+
169
+
### `openboot update --self`
170
+
171
+
Update the OpenBoot binary itself to the latest release from GitHub.
172
+
173
+
```
174
+
openboot update --self
175
+
```
176
+
177
+
### `openboot version`
178
+
179
+
Print the current OpenBoot version.
180
+
181
+
```
182
+
openboot version
183
+
```
184
+
88
185
## Environment Variables
89
186
187
+
### Install Script Variables
188
+
189
+
These are used when running the `curl | bash` install command:
190
+
90
191
| Variable | Description | Default |
91
192
|----------|-------------|---------|
92
193
|`OPENBOOT_VERSION`| Override the version of OpenBoot to install | Latest release |
93
194
|`OPENBOOT_INSTALL_DIR`| Override the installation directory for the binary |`~/.openboot/bin`|
195
+
|`OPENBOOT_DRY_RUN`| Set to `true` to preview the install script without changes | — |
196
+
|`OPENBOOT_SKIP_CHECKSUM`| Set to `true` to skip SHA256 checksum verification | — |
197
+
198
+
### CLI Variables
94
199
95
-
### Example
200
+
These are used by the `openboot` binary:
201
+
202
+
| Variable | Description |
203
+
|----------|-------------|
204
+
|`OPENBOOT_GIT_NAME`| Git user name (required in `--silent` mode if not configured) |
205
+
|`OPENBOOT_GIT_EMAIL`| Git user email (required in `--silent` mode if not configured) |
Copy file name to clipboardExpand all lines: src/docs/getting-started.md
+30-5Lines changed: 30 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,22 @@
1
1
# Getting Started
2
2
3
-
OpenBoot is an open-source command-line tool that bootstraps your macOS development environment in minutes. Instead of manually installing Homebrew, CLI tools, GUI apps, configuring your shell, and tweaking macOS settings one by one, OpenBoot handles it all with a single command — through a beautiful interactive TUI that lets you pick exactly what you want.
3
+
OpenBoot is an open-source command-line tool for macOS developers. Whether you're setting up a brand-new Mac or capturing an existing one, OpenBoot has you covered:
4
4
5
-
## System Requirements
5
+
-**New Mac?** Bootstrap your entire dev environment in minutes — Homebrew packages, GUI apps, dotfiles, shell config, and macOS preferences — all through an interactive TUI.
6
+
-**Already set up?** Run `openboot snapshot` to capture what you have. Save it locally or share it as a config URL — your choice.
7
+
8
+
Pick the path that fits:
9
+
10
+
## Path 1: Bootstrap a New Mac
11
+
12
+
### System Requirements
6
13
7
14
-**macOS 12 (Monterey)** or later
8
15
-**Apple Silicon (M1/M2/M3/M4)** and **Intel** Macs are both supported
9
16
- An internet connection (packages are downloaded from Homebrew)
10
17
- Admin privileges (you'll be prompted for your password during install)
Here's exactly what the install script does, in order:
25
32
@@ -33,7 +40,7 @@ Here's exactly what the install script does, in order:
33
40
34
41
5.**Installs your selections** — once you confirm, OpenBoot skips already-installed packages, then installs CLI tools in parallel and GUI apps sequentially (with terminal access for any password prompts). It also configures Oh-My-Zsh (with plugins and a theme), sets up useful shell aliases, and applies macOS preference tweaks.
35
42
36
-
## First Run Experience
43
+
###First Run Experience
37
44
38
45
When the TUI launches, you'll see:
39
46
@@ -44,3 +51,21 @@ When the TUI launches, you'll see:
44
51
The TUI shows which packages are already installed on your system (marked with a check) so you won't reinstall anything unnecessarily.
45
52
46
53
After installation completes, restart your terminal or run `source ~/.zshrc` to pick up the new shell configuration.
54
+
55
+
## Path 2: Snapshot Your Existing Mac
56
+
57
+
Already have your Mac configured just the way you like it? Snapshot captures your current setup — Homebrew packages, macOS preferences, shell config, and git settings — so you can save it locally or share it.
Snapshot walks you through an interactive review of everything it found. You can toggle individual items on or off before deciding to save locally (`--local`) or upload to openboot.dev.
70
+
71
+
For full details, see the [Snapshot](/docs#snapshot) documentation.
A ready-to-code Mac setup with everything you need to start building immediately. Includes all of `minimal` plus languages, Docker, editors, and browsers.
21
+
Ready-to-code Mac setup. Everything you need to start building immediately. Includes all of `minimal` plus languages, Docker, editors, and browsers.
The complete dev environment — every language, DevOps tool, database, and AI utility we recommend. Best for polyglot developers, DevOps engineers, or anyone who wants it all.
33
+
Complete dev environment with languages, DevOps, databases, and AI tools. Best for polyglot developers, DevOps engineers, or anyone who wants it all.
curl -fsSL openboot.dev/install.sh | bash -s -- --preset full
40
+
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset full
41
41
```
42
42
43
43
## Customizing During Install
@@ -53,14 +53,21 @@ This means you can start with `developer` but add `kubectl` from `full`, or remo
53
53
54
54
## Non-Interactive Install
55
55
56
-
If you want to skip the TUI and install a preset exactly as defined (useful for CI or scripting), the`--preset`flag with no TUI will install everything in the preset without prompting:
56
+
If you want to skip the TUI and install a preset exactly as defined (useful for CI or scripting), combine`--preset` with `--silent`:
0 commit comments