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
{{ message }}
Repository navigation
Commit a81909a
Browse filesBrowse the repository at this point in the historyBrowse files
- Landing page mock terminal showed a hardcoded 'Downloading OpenBoot
v0.44.0' direct-download flow; install.sh now installs through
Homebrew, so mirror its actual output and drop the version string.
- cli-reference: 'openboot update' still exists in v1.0 (brew upgrade
wrapper on Homebrew installs, pin/rollback on direct installs); it
was wrongly listed as removed. Fix the --update flag meaning (update
Homebrew and exit) and the doctor table (state file and PATH checks).
- faq: drop the claim that 'update --self' was removed.
- env-vars: OPENBOOT_VERSION is a dead variable in install.sh; add
OPENBOOT_DOTFILES, OPENBOOT_DISABLE_AUTOUPDATE, OPENBOOT_API_URL
which the CLI reads but the page omitted.
- quick-start / what-is-openboot: bare 'openboot' prints help; the
wizard is 'openboot install'. Presets never become a sync source.
Copy file name to clipboardExpand all lines: src/docs/cli-reference.md
+22-8Lines changed: 22 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,11 +13,12 @@ OpenBoot v1.0 has two real verbs: **`install`** adds things to your Mac, **`snap
13
13
openboot install [source] # install from preset, file, or cloud config
14
14
openboot snapshot # capture your environment
15
15
openboot doctor # check system health and diagnose issues
16
+
openboot update # upgrade the openboot binary itself
16
17
openboot login / logout # openboot.dev auth
17
18
openboot version # print version
18
19
```
19
20
20
-
> **v1.0 removed these commands:**`pull`, `push`, `diff`, `clean`, `log`, `restore`, `init`, `setup-agent`, `update`, `list`, `edit`, `delete`. OpenBoot no longer uninstalls packages or tracks revision history — `install` is add-only, and `snapshot --publish` overwrites. Manage configs on the [dashboard](/dashboard). See the project [CHANGELOG](https://github.com/openbootdotdev/openboot/blob/main/CHANGELOG.md) for migration.
21
+
> **v1.0 removed these commands:**`pull`, `push`, `diff`, `clean`, `log`, `restore`, `init`, `setup-agent`, `list`, `edit`, `delete`. OpenBoot no longer uninstalls packages or tracks revision history — `install` is add-only, and `snapshot --publish` overwrites. Manage configs on the [dashboard](/dashboard). See the project [CHANGELOG](https://github.com/openbootdotdev/openboot/blob/main/CHANGELOG.md) for migration.
21
22
22
23
## `openboot install`
23
24
@@ -84,7 +85,7 @@ For private configs, run `openboot login` first.
84
85
|`--dotfiles <mode>`|`clone`, `link`, or `skip`|
85
86
|`--post-install <mode>`|`skip` to skip post-install scripts |
86
87
|`--allow-post-install`| Allow post-install scripts in silent mode |
87
-
|`--update`| Update Homebrew before installing|
88
+
|`--update`| Update Homebrew and exit — nothing is installed|
88
89
|`--verbose`| Debug logging to stderr |
89
90
90
91
`install` is **add-only**. It never uninstalls packages or removes settings — if a package is in your local system but not in the config, it stays. To remove packages, run `brew uninstall` directly.
| OpenBoot state |`install_state.json`is valid JSON|
222
-
| PATH |`/usr/local/bin`and/or Homebrew prefix on PATH|
222
+
| OpenBoot state |`~/.openboot/sync_source.json`or `state.json` exists (a previous install)|
223
+
| PATH |`/opt/homebrew/bin`on PATH (Apple Silicon only; skipped on Intel)|
223
224
224
225
All checks are read-only — `doctor` never modifies your system.
225
226
226
227
---
227
228
228
-
## Upgrading OpenBoot
229
+
## `openboot update`
229
230
230
-
OpenBoot no longer has a self-update command. It's installed via Homebrew — use Homebrew to upgrade:
231
+
Upgrade the `openboot` binary itself.
231
232
232
233
```
233
-
brew upgrade openboot
234
+
openboot update # upgrade to the latest release
235
+
openboot update --dry-run # print what would be done, change nothing
234
236
```
235
237
236
-
OpenBoot also does a lightweight auto-update check when you run `install`.
238
+
Both install methods (the one-line installer and `brew install`) put OpenBoot under Homebrew, so `openboot update` simply runs `brew upgrade openboot` for you. Running `brew upgrade openboot` yourself does the same thing.
239
+
240
+
If you installed a release binary by hand instead of through Homebrew, `update` downloads from GitHub and keeps a backup of the previous binary:
241
+
242
+
```
243
+
openboot update --version 1.0.0 # pin to an exact version
244
+
openboot update --rollback # restore the most recent backup
245
+
openboot update --list-backups # list backups under ~/.openboot/backup
246
+
```
247
+
248
+
Backups live in `~/.openboot/backup/`; the 5 most recent are kept. `--version` and `--rollback` are refused on Homebrew-managed installs — use `brew` for those.
249
+
250
+
`install` also does a lightweight auto-update check before it runs. Set `OPENBOOT_DISABLE_AUTOUPDATE=1` to skip it.
Copy file name to clipboardExpand all lines: src/docs/faq.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,9 +95,7 @@ An account (GitHub or Google OAuth) is needed to:
95
95
brew upgrade openboot
96
96
```
97
97
98
-
OpenBoot also does a lightweight auto-update check when you run `install`.
99
-
100
-
The old `openboot update --self` command was removed in v1.0 — use `brew upgrade` instead.
98
+
`openboot update` does the same thing — on a Homebrew install it just runs `brew upgrade openboot` for you. OpenBoot also does a lightweight auto-update check when you run `install`; set `OPENBOOT_DISABLE_AUTOUPDATE=1` to skip it.
101
99
102
100
Your configs, snapshots, and auth tokens are unaffected by upgrades.
Copy file name to clipboardExpand all lines: src/docs/quick-start.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,15 @@ Installs Xcode Command Line Tools and Homebrew if they're missing, downloads Ope
21
21
22
22
```bash
23
23
brew install openbootdotdev/tap/openboot
24
-
openboot
24
+
openboot install
25
25
```
26
26
27
27
The interactive TUI opens and you pick what to install.
28
28
29
29
## First run
30
30
31
31
```bash
32
-
openboot
32
+
openboot install
33
33
```
34
34
35
35
The TUI opens with the `developer` preset selected. **Arrow keys** navigate, **Space** toggles packages, **Enter** confirms. Homebrew starts installing — usually 10–30 minutes depending on what you picked.
@@ -51,7 +51,7 @@ See [Presets](/docs/presets) for what's in each one.
51
51
52
52
## Running again later
53
53
54
-
Just type `openboot`. If the machine is already synced to a config (or a preset), OpenBoot fetches the latest version, shows what's missing, and asks to apply it. Nothing gets uninstalled — `install` only adds.
54
+
Run `openboot install` again. If the machine is already synced to a config, OpenBoot fetches the latest version, shows what's missing, and asks to apply it. Nothing gets uninstalled — `install` only adds.
55
55
56
56
```
57
57
→ Syncing with @alice/dev-setup (last synced 2 days ago)
0 commit comments