Skip to content

Commit 4445b31

Browse files
committed
fix(docs): correct documentation to match CLI implementation
- Remove phantom --resume and --rollback flags from CLI reference - Add --post-install flag to CLI reference - Remove non-existent OPENBOOT_INSTALL_DIR and OPENBOOT_SKIP_CHECKSUM env vars - Update install script description to reflect brew install behavior - Replace SHA256 checksum claim with accurate Homebrew description - Unify uninstall and update instructions (both use Homebrew) - Fix macOS preference: Dock auto-hide → Dock stays visible - Unify Homebrew install to single-line format in quick-start
1 parent b783ec7 commit 4445b31

File tree

5 files changed

+8
-35
lines changed

5 files changed

+8
-35
lines changed

src/docs/cli-reference.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,12 @@ For private configs, run `openboot login` first — the CLI sends your auth toke
4949
| `-u, --user <username/slug>` | Install from a config hosted on openboot.dev |
5050
| `-s, --silent` | Non-interactive mode — no TUI, no prompts |
5151
| `--dry-run` | Preview what would be installed without installing |
52-
| `--resume` | Resume an interrupted installation |
5352
| `--packages-only` | Install packages only, skip shell/macOS/dotfiles config |
5453
| `--shell <mode>` | `install` or `skip` |
5554
| `--macos <mode>` | `configure` or `skip` |
5655
| `--dotfiles <mode>` | `clone`, `link`, or `skip` |
56+
| `--post-install <mode>` | `skip` to skip post-install scripts |
5757
| `--update` | Update Homebrew before installing |
58-
| `--rollback` | Restore backed-up config files |
5958

6059
## Capture Your Environment
6160

src/docs/env-vars.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,15 @@ All environment variables that control the install script and the `openboot` CLI
1111

1212
## Install Script Variables
1313

14-
These are used when running the `curl | bash` install command.
14+
These are used when running the `curl | bash` install command. The install script installs OpenBoot via Homebrew (`brew install openbootdotdev/tap/openboot`).
1515

1616
| Variable | Description | Default |
1717
|----------|-------------|---------|
1818
| `OPENBOOT_VERSION` | Install a specific version instead of latest | Latest release |
19-
| `OPENBOOT_INSTALL_DIR` | Where to put the binary | `~/.openboot/bin` |
2019
| `OPENBOOT_DRY_RUN` | Set to `true` to preview without changes ||
21-
| `OPENBOOT_SKIP_CHECKSUM` | Set to `true` to skip SHA256 verification ||
2220

2321
### Examples
2422

25-
Install a specific version:
26-
27-
```
28-
OPENBOOT_VERSION=0.3.1 curl -fsSL https://openboot.dev/install.sh | bash
29-
```
30-
31-
Install to a custom directory:
32-
33-
```
34-
OPENBOOT_INSTALL_DIR=~/.local/bin curl -fsSL https://openboot.dev/install.sh | bash
35-
```
36-
3723
Preview the install script without making changes:
3824

3925
```
@@ -76,7 +62,6 @@ These aren't environment variables, but useful to know:
7662

7763
| Path | What's There |
7864
|------|-------------|
79-
| `~/.openboot/bin/openboot` | The OpenBoot binary (one-line installer only) |
8065
| `~/.openboot/auth.json` | Auth token (after `openboot login` or snapshot upload) |
8166
| `~/.openboot/snapshot.json` | Local snapshot (when using `--local`) |
8267
| `~/.openboot/config.json` | Auto-update settings |

src/docs/faq.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Fair question. Here's how it works:
3838
- Install script is open source—review it at [github.com/openbootdotdev/openboot](https://github.com/openbootdotdev/openboot)
3939
- Hosted on openboot.dev (Cloudflare Workers), served over HTTPS
4040
- Zero telemetry—no analytics, no tracking, nothing phones home
41-
- Binary downloaded from GitHub Releases with SHA256 checksum verification
41+
- Installs OpenBoot via Homebrew (`brew install openbootdotdev/tap/openboot`), which handles integrity verification
4242
- You can inspect the script before running it:
4343

4444
```bash
@@ -81,39 +81,29 @@ An account (GitHub or Google OAuth) is needed to:
8181

8282
## How do I update OpenBoot?
8383

84-
**If installed via Homebrew:**
85-
8684
```bash
8785
brew upgrade openboot
8886
```
8987

90-
**If installed via the one-line installer:**
88+
Or use the built-in self-update:
9189

9290
```bash
9391
openboot update --self
9492
```
9593

96-
Or re-run the install script — it downloads the latest binary and replaces the old one.
97-
9894
Your configs, snapshots, and auth tokens are unaffected by updates.
9995

10096
## How do I uninstall OpenBoot?
10197

10298
### 1. Remove the binary
10399

104-
**If installed via Homebrew:**
100+
Both installation methods use Homebrew, so the uninstall is the same:
105101

106102
```bash
107103
brew uninstall openboot
108104
brew untap openbootdotdev/tap
109105
```
110106

111-
**If installed via the one-line installer:**
112-
113-
```bash
114-
rm -f ~/.openboot/bin/openboot
115-
```
116-
117107
### 2. Remove OpenBoot data
118108

119109
```bash
@@ -144,7 +134,7 @@ OpenBoot doesn't remove Homebrew packages or casks when you uninstall it — the
144134
| Configs & user data | Cloudflare D1 on openboot.dev |
145135
| Auth token | `~/.openboot/auth.json` (local) |
146136
| Local snapshots | `~/.openboot/snapshot.json` (local) |
147-
| OpenBoot binary | `~/.openboot/bin/openboot` (local) |
137+
| OpenBoot binary | Managed by Homebrew (run `which openboot` to find it) |
148138

149139
Configs are **unlisted** by default — not listed on your profile, but the install URL works if shared. You can set them to **public** (listed on profile) or **private** (requires authentication to install). See [Custom Configs — Visibility](/docs/custom-configs#visibility) for details.
150140

src/docs/quick-start.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ order: 2
1414
If you have Homebrew:
1515

1616
```bash
17-
brew tap openbootdotdev/tap
18-
brew install openboot
17+
brew install openbootdotdev/tap/openboot
1918
openboot
2019
```
2120

src/docs/what-is-openboot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ OpenBoot is an open-source CLI that automates the boring part of setting up a ne
1919

2020
**Dotfiles** — Clones your dotfiles repo and links it with GNU Stow. Your `.zshrc`, `.gitconfig`, and other configs follow you to any machine.
2121

22-
**macOS Preferences** — Applies developer-friendly settings: fast key repeat, Finder path bar visible, Dock auto-hide, screenshots saved as PNG, etc.
22+
**macOS Preferences** — Applies developer-friendly settings: fast key repeat, Finder path bar visible, Dock stays visible, screenshots saved as PNG, etc.
2323

2424
**Snapshot** — Run `openboot snapshot` to capture your current setup. Upload it to openboot.dev and share as a one-line install URL, or save locally as JSON.
2525

0 commit comments

Comments
 (0)