Skip to content

Commit 1d60cdf

Browse files
committed
docs: align install and update guidance with current CLI
1 parent 939e7cb commit 1d60cdf

4 files changed

Lines changed: 11 additions & 10 deletions

File tree

‎src/docs/cli-reference.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ order: 9
77

88
# CLI Commands
99

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.
1111

1212
```
1313
openboot install [source] # install from preset, file, or cloud config
@@ -235,19 +235,19 @@ openboot update # upgrade to the latest release
235235
openboot update --dry-run # print what would be done, change nothing
236236
```
237237

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.
239239

240240
If you installed a release binary by hand instead of through Homebrew, `update` downloads from GitHub and keeps a backup of the previous binary:
241241

242242
```
243-
openboot update --version 1.0.0 # pin to an exact version
243+
openboot update --version 1.0.5 # pin to an exact version
244244
openboot update --rollback # restore the most recent backup
245245
openboot update --list-backups # list backups under ~/.openboot/backup
246246
```
247247

248248
Backups live in `~/.openboot/backup/`; the 5 most recent are kept. `--version` and `--rollback` are refused on Homebrew-managed installs — use `brew` for those.
249249

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.
251251

252252
---
253253

‎src/docs/env-vars.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Environment Variables
3-
description: All environment variables the install script and openboot CLI understand.
3+
description: Environment settings for the install script and openboot CLI.
44
group: Reference
55
order: 12
66
---
77

88
# Environment Variables
99

10-
Every environment variable OpenBoot reads. Short list — v1.0 kept things minimal.
10+
Environment settings for the install script and CLI.
1111

1212
## Install script (`install.sh`)
1313

@@ -22,7 +22,7 @@ The script always installs the latest release published in the tap; there is no
2222
Preview the install script without making changes:
2323

2424
```
25-
OPENBOOT_DRY_RUN=true curl -fsSL https://openboot.dev/install.sh | bash
25+
curl -fsSL https://openboot.dev/install.sh | OPENBOOT_DRY_RUN=true bash
2626
```
2727

2828
## CLI (`openboot`)
@@ -35,7 +35,7 @@ Used by the `openboot` binary at runtime.
3535
| `OPENBOOT_GIT_EMAIL` | Git user email — **read only in `--silent` mode** (required if Git isn't already configured) |
3636
| `OPENBOOT_PRESET` | Default preset. Overridden by `-p` / `--preset` |
3737
| `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` |
3939
| `OPENBOOT_DISABLE_AUTOUPDATE` | Set to `1` to skip the auto-update check that runs before `install` |
4040
| `OPENBOOT_API_URL` | Override the openboot.dev API base URL — testing only; must be `https://` or `http://localhost` |
4141

@@ -63,4 +63,5 @@ Not environment variables, but useful to know.
6363
| `~/.openboot/snapshot.json` | Local snapshot (when using `--local`) |
6464
| `~/.openboot/install_state.json` | What was installed on this machine, and when |
6565
| `~/.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) |
6667
| `~/.dotfiles/` | Cloned dotfiles repo (when configured) |

‎src/docs/faq.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ An account (GitHub or Google OAuth) is needed to:
9595
brew upgrade openboot
9696
```
9797

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.
9999

100100
Your configs, snapshots, and auth tokens are unaffected by upgrades.
101101

‎src/docs/quick-start.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The interactive TUI opens and you pick what to install.
3232
openboot install
3333
```
3434

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.
3636

3737
When it finishes, restart your terminal or run:
3838

0 commit comments

Comments
 (0)