Skip to content

Commit 517c464

Browse files
committed
fix(docs): correct CLI flags, help text, and docs to match implementation
- Update install command Use string to show username/slug format - Document default slug fallback behavior in install help text - Add missing commands to README: install, login, logout, init - Add --packages-only and --post-install to README CLI Options - Update comparison table to use install subcommand syntax - Remove stale adoption claims from README - Fix snapshot AGENTS.md: brew list --formula → brew leaves
1 parent 4097911 commit 517c464

3 files changed

Lines changed: 31 additions & 23 deletions

File tree

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ No tracking. No telemetry. Just works.
4242

4343
## Why OpenBoot?
4444

45-
**Fresh project, proven demand** — 2 weeks old, already trending on Reddit (100K+ views) and growing fast.
46-
4745
Brewfiles are manual YAML editing. Nix has a brutal learning curve. Shell scripts break silently. Dotfile repos become unmaintainable after six months.
4846

4947
OpenBoot is the first tool that handles **everything** — packages, dotfiles, shell config, macOS preferences, git identity — in an interactive TUI you can actually navigate. No config files to learn. No YAML to write. Just pick what you need and go.
@@ -70,7 +68,7 @@ curl -fsSL openboot.dev/install.sh | bash
7068
|---|:---:|:---:|:---:|:---:|
7169
| Interactive package picker | **TUI** | manual edit |||
7270
| Web dashboard | **[openboot.dev](https://openboot.dev)** ||||
73-
| Shareable install URL | `openboot -u you` ||||
71+
| Shareable install URL | `openboot install you/setup` ||||
7472
| Snapshot & restore | full environment || dotfiles only | full (steep curve) |
7573
| Learning curve | **Low** | Low | High | Very High |
7674

@@ -166,13 +164,17 @@ curl -fsSL openboot.dev/install.sh | bash -s -- --preset developer --silent
166164
<summary><strong>All Commands</strong></summary>
167165

168166
```bash
169-
openboot # Interactive setup
170-
openboot snapshot # Capture your current setup
171-
openboot clean # Remove packages not in your config
172-
openboot doctor # Check system health
173-
openboot update # Update Homebrew and packages
174-
openboot update --dry-run # Preview updates
175-
openboot version # Print version
167+
openboot # Interactive setup
168+
openboot install user/config # Install from a cloud config
169+
openboot snapshot # Capture your current setup
170+
openboot clean # Remove packages not in your config
171+
openboot init # Set up project from .openboot.yml
172+
openboot doctor # Check system health
173+
openboot update # Update Homebrew and packages
174+
openboot update --self # Update OpenBoot itself
175+
openboot login # Authenticate with openboot.dev
176+
openboot logout # Remove auth token
177+
openboot version # Print version
176178
```
177179

178180
</details>
@@ -181,14 +183,16 @@ openboot version # Print version
181183
<summary><strong>CLI Options</strong></summary>
182184

183185
```
184-
-p, --preset NAME Set preset (minimal, developer, full)
185-
-u, --user NAME Use remote config from openboot.dev
186-
-s, --silent Non-interactive mode (requires env vars)
187-
--dry-run Preview what would be installed
188-
--update Update Homebrew and packages
189-
--shell MODE Shell setup: install, skip
190-
--macos MODE macOS prefs: configure, skip
191-
--dotfiles MODE Dotfiles: clone, link, skip
186+
-p, --preset NAME Set preset (minimal, developer, full)
187+
-u, --user NAME Use remote config from openboot.dev
188+
-s, --silent Non-interactive mode (requires env vars)
189+
--dry-run Preview what would be installed
190+
--packages-only Install packages only, skip system config
191+
--update Update Homebrew before installing
192+
--shell MODE Shell setup: install, skip
193+
--macos MODE macOS prefs: configure, skip
194+
--dotfiles MODE Dotfiles: clone, link, skip
195+
--post-install MODE Post-install script: skip
192196
```
193197

194198
</details>

internal/cli/install.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,21 @@ import (
1111
)
1212

1313
var installCmd = &cobra.Command{
14-
Use: "install [username]",
14+
Use: "install [username/slug]",
1515
Short: "Set up your Mac dev environment",
1616
Long: `Install and configure your Mac development environment.
1717
18-
You can provide a username to install from that user's openboot.dev config,
19-
or run it interactively without arguments.`,
18+
You can provide a username/slug to install from that user's openboot.dev config,
19+
or run it interactively without arguments. If only a username is provided
20+
without a slug, it defaults to the "default" config.`,
2021
Example: ` # Interactive setup with package selection
2122
openboot install
2223
2324
# Install from a user's cloud config
24-
openboot install githubusername
25+
openboot install yourname/my-setup
26+
27+
# Install default config for a user
28+
openboot install yourname
2529
2630
# Quick setup with a preset
2731
openboot install -p developer

internal/snapshot/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Environment capture, matching, and restoration. 8 files (4 source + 4 test), 1,7
1515

1616
`CaptureWithProgress()` runs 8 sequential steps, each reporting via callback:
1717

18-
1. Homebrew Formulae → `brew list --formula`
18+
1. Homebrew Formulae → `brew leaves` (top-level only, excludes dependencies)
1919
2. Homebrew Casks → `brew list --cask`
2020
3. Homebrew Taps → `brew tap`
2121
4. npm Packages → `npm list -g --json`

0 commit comments

Comments
 (0)