Skip to content

Commit a81909a

Browse files
committed
docs: bring site copy in line with the v1.0.0 CLI
- 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.
1 parent 259a062 commit a81909a

6 files changed

Lines changed: 36 additions & 21 deletions

File tree

‎src/docs/cli-reference.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ OpenBoot v1.0 has two real verbs: **`install`** adds things to your Mac, **`snap
1313
openboot install [source] # install from preset, file, or cloud config
1414
openboot snapshot # capture your environment
1515
openboot doctor # check system health and diagnose issues
16+
openboot update # upgrade the openboot binary itself
1617
openboot login / logout # openboot.dev auth
1718
openboot version # print version
1819
```
1920

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.
2122
2223
## `openboot install`
2324

@@ -84,7 +85,7 @@ For private configs, run `openboot login` first.
8485
| `--dotfiles <mode>` | `clone`, `link`, or `skip` |
8586
| `--post-install <mode>` | `skip` to skip post-install scripts |
8687
| `--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 |
8889
| `--verbose` | Debug logging to stderr |
8990

9091
`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.
@@ -218,22 +219,35 @@ Checks performed:
218219
| Oh-My-Zsh | Installed at `~/.oh-my-zsh` |
219220
| Brew shellenv | `~/.zshrc` sources `brew shellenv` (Apple Silicon only) |
220221
| OpenBoot dir | `~/.openboot/` exists |
221-
| 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) |
223224

224225
All checks are read-only — `doctor` never modifies your system.
225226

226227
---
227228

228-
## Upgrading OpenBoot
229+
## `openboot update`
229230

230-
OpenBoot no longer has a self-update command. It's installed via Homebrew — use Homebrew to upgrade:
231+
Upgrade the `openboot` binary itself.
231232

232233
```
233-
brew upgrade openboot
234+
openboot update # upgrade to the latest release
235+
openboot update --dry-run # print what would be done, change nothing
234236
```
235237

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

238252
---
239253

‎src/docs/env-vars.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ Used when you run `curl -fsSL openboot.dev/install.sh | bash`. The script instal
1515

1616
| Variable | Description | Default |
1717
|----------|-------------|---------|
18-
| `OPENBOOT_VERSION` | Install a specific version instead of latest | `latest` |
1918
| `OPENBOOT_DRY_RUN` | Set to `true` to preview without changes | — |
2019

20+
The script always installs the latest release published in the tap; there is no version pin.
21+
2122
Preview the install script without making changes:
2223

2324
```
@@ -34,6 +35,9 @@ Used by the `openboot` binary at runtime.
3435
| `OPENBOOT_GIT_EMAIL` | Git user email — **read only in `--silent` mode** (required if Git isn't already configured) |
3536
| `OPENBOOT_PRESET` | Default preset. Overridden by `-p` / `--preset` |
3637
| `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` |
39+
| `OPENBOOT_DISABLE_AUTOUPDATE` | Set to `1` to skip the auto-update check that runs before `install` |
40+
| `OPENBOOT_API_URL` | Override the openboot.dev API base URL — testing only; must be `https://` or `http://localhost` |
3741

3842
Silent install with Git identity:
3943

‎src/docs/faq.md‎

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

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

102100
Your configs, snapshots, and auth tokens are unaffected by upgrades.
103101

‎src/docs/quick-start.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ Installs Xcode Command Line Tools and Homebrew if they're missing, downloads Ope
2121

2222
```bash
2323
brew install openbootdotdev/tap/openboot
24-
openboot
24+
openboot install
2525
```
2626

2727
The interactive TUI opens and you pick what to install.
2828

2929
## First run
3030

3131
```bash
32-
openboot
32+
openboot install
3333
```
3434

3535
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.
5151

5252
## Running again later
5353

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

5656
```
5757
→ Syncing with @alice/dev-setup (last synced 2 days ago)

‎src/docs/what-is-openboot.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ OpenBoot is an open-source CLI that automates the boring part of setting up a ne
3131
curl -fsSL https://openboot.dev/install.sh | bash
3232
```
3333

34-
This installs Xcode Command Line Tools and Homebrew if you don't have them yet, downloads the `openboot` binary, and launches the TUI.
34+
This installs Xcode Command Line Tools and Homebrew if you don't have them yet, installs `openboot` through Homebrew, and launches the TUI.
3535

3636
**Already have Homebrew?**
3737

3838
```bash
3939
brew install openbootdotdev/tap/openboot
40-
openboot
40+
openboot install
4141
```
4242

4343
Either way, from there:

‎src/routes/+page.svelte‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,9 @@
141141
<div class="t-mt13"><span class="t-accent">✓</span> Xcode Command Line Tools ready</div>
142142
<div><span class="t-accent">✓</span> Homebrew ready</div>
143143
<div class="t-mt13 t-muted">Detected: darwin/arm64</div>
144-
<div class="t-strong">Downloading OpenBoot v0.44.0...</div>
145-
<div><span class="t-accent">✓</span> Downloaded to ~/.openboot/bin/openboot</div>
146-
<div><span class="t-accent">✓</span> Checksum verified</div>
147-
<div><span class="t-accent">✓</span> Added to PATH</div>
144+
<div class="t-strong">Installing OpenBoot via Homebrew...</div>
145+
<div><span class="t-accent">✓</span> OpenBoot installed!</div>
146+
<div>Starting OpenBoot setup...</div>
148147
<div class="t-mt10"><span class="t-caret"></span></div>
149148
</div>
150149

0 commit comments

Comments
 (0)