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 1d60cdf
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: src/docs/cli-reference.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ order: 9
7
7
8
8
# CLI Commands
9
9
10
-
OpenBoot v1.0 has two real verbs: **`install`**adds things to your Mac, **`snapshot`**captures what's on it. Everything else is auth or bookkeeping.
10
+
OpenBoot's main commands are **`install`**, which adds things to your Mac, and **`snapshot`**, which captures what's on it. Supporting commands handle authentication, diagnostics, and updates.
11
11
12
12
```
13
13
openboot install [source] # install from preset, file, or cloud config
@@ -235,19 +235,19 @@ openboot update # upgrade to the latest release
235
235
openboot update --dry-run # print what would be done, change nothing
236
236
```
237
237
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.
238
+
Both install methods (the one-line installer and `brew install`) put OpenBoot under Homebrew. On these installs, `openboot update`refreshes the `openbootdotdev/tap` repository and runs`brew upgrade openbootdotdev/tap/openboot`. You can also upgrade with Homebrew directly.
239
239
240
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
241
242
242
```
243
-
openboot update --version 1.0.0 # pin to an exact version
243
+
openboot update --version 1.0.5 # pin to an exact version
244
244
openboot update --rollback # restore the most recent backup
245
245
openboot update --list-backups # list backups under ~/.openboot/backup
246
246
```
247
247
248
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
249
250
-
`install` also does a lightweight auto-update check before it runs. Set `OPENBOOT_DISABLE_AUTOUPDATE=1` to skip it.
250
+
`install` also checks for updates before it runs. By default, it only notifies you when a newer version is available. Automatic upgrades are opt-in: set `"autoupdate": "true"` in `~/.openboot/config.json` to enable them, or `"autoupdate": "false"` to disable checks. Set `OPENBOOT_DISABLE_AUTOUPDATE=1` to skip the check regardless of that preference.
@@ -35,7 +35,7 @@ Used by the `openboot` binary at runtime.
35
35
|`OPENBOOT_GIT_EMAIL`| Git user email — **read only in `--silent` mode** (required if Git isn't already configured) |
36
36
|`OPENBOOT_PRESET`| Default preset. Overridden by `-p` / `--preset`|
37
37
|`OPENBOOT_USER`| Default cloud config (alias or `user/slug`). Overridden by `-u` / `--user`|
38
-
|`OPENBOOT_DOTFILES`| Dotfiles repo URL to clone and link. Overrides the config's `dotfiles_repo`|
38
+
|`OPENBOOT_DOTFILES`| Dotfiles repo URL for preset-based installs. Remote configs and snapshots use their own dotfiles settings; this does not override a remote config's `dotfiles_repo`|
39
39
|`OPENBOOT_DISABLE_AUTOUPDATE`| Set to `1` to skip the auto-update check that runs before `install`|
40
40
|`OPENBOOT_API_URL`| Override the openboot.dev API base URL — testing only; must be `https://` or `http://localhost`|
41
41
@@ -63,4 +63,5 @@ Not environment variables, but useful to know.
63
63
|`~/.openboot/snapshot.json`| Local snapshot (when using `--local`) |
64
64
|`~/.openboot/install_state.json`| What was installed on this machine, and when |
65
65
|`~/.openboot/sync_source.json`| The cloud config this machine is synced to |
66
+
|`~/.openboot/config.json`| Update preference: `"autoupdate": "notify"` (default), `"true"` (automatic upgrades), or `"false"` (no checks) |
Copy file name to clipboardExpand all lines: src/docs/faq.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@ An account (GitHub or Google OAuth) is needed to:
95
95
brew upgrade openboot
96
96
```
97
97
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.
98
+
You can also run `openboot update`. On a Homebrew install, it refreshes the OpenBoot tap before upgrading the formula. When you run `install`, OpenBoot checks for newer releases and notifies you by default; automatic upgrades are opt-in. Set `OPENBOOT_DISABLE_AUTOUPDATE=1` to skip the check. See [CLI Commands — Update](/docs/cli-reference#openboot-update) for update preferences and options for manually installed binaries.
99
99
100
100
Your configs, snapshots, and auth tokens are unaffected by upgrades.
Copy file name to clipboardExpand all lines: src/docs/quick-start.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ The interactive TUI opens and you pick what to install.
32
32
openboot install
33
33
```
34
34
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.
35
+
The TUI checks your environment and asks you to choose a preset (`minimal`, `developer`, or `full`). Review the selected packages and setup options, then confirm the plan. Homebrew starts installing — usually 10–30 minutes depending on what you picked.
0 commit comments