Skip to content

Commit 5dd6789

Browse files
committed
docs: update snapshot docs for interactive editor flow
- Document the new 6-step interactive flow with scan progress and TUI editor - Add details on editor keybindings (Space, Tab, /, a) - Update privacy section to mention full control via editor - Update cli-reference with interactive flow summary
1 parent 42ac3a5 commit 5dd6789

File tree

2 files changed

+39
-9
lines changed

2 files changed

+39
-9
lines changed

src/docs/cli-reference.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,11 @@ Capture your current Mac's development environment. Scans Homebrew packages, mac
5454
openboot snapshot
5555
```
5656

57-
By default, this scans your system and then walks you through uploading the result to openboot.dev as a shareable config.
57+
The interactive flow:
58+
1. **Scan** — progress animation shows each component being captured
59+
2. **Edit** — full-screen TUI to review and toggle items (Space to toggle, Tab to switch categories, `/` to search)
60+
3. **Confirm** — choose to upload or save locally
61+
4. **Upload** — authenticate (if needed), name your config, and get a shareable URL
5862

5963
### `openboot snapshot --dry-run`
6064

src/docs/snapshot.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,19 +82,45 @@ Save locally for later:
8282
openboot snapshot --local
8383
```
8484

85-
## Upload Flow
85+
## Interactive Flow
8686

87-
When you run `openboot snapshot` without flags, after scanning your system it will:
87+
When you run `openboot snapshot` without flags:
8888

89-
1. **Prompt for authentication** — opens your browser to authorize OpenBoot via a device code flow (similar to `gh auth login`). You see a code in the terminal, confirm it in the browser, and the CLI receives an auth token.
89+
1. **Scan with progress** — each component is scanned with real-time feedback:
90+
```
91+
✓ Homebrew Formulae 28 found
92+
✓ Homebrew Casks 12 found
93+
✓ macOS Preferences 9 found
94+
⠋ Shell Environment scanning...
95+
```
9096

91-
2. **Name your config** — you'll be asked to provide a name (e.g., "my-setup" or "team-baseline").
97+
2. **Review in the editor** — a full-screen TUI lets you review and customize what's included:
98+
- **3 tabs**: Formulae, Casks, macOS Preferences
99+
- **Toggle items** with Space to include/exclude individual packages or settings
100+
- **Search** with `/` to find specific items
101+
- **Select all** with `a` to quickly toggle an entire category
102+
- Shell, Git, and Dev Tools are shown as a read-only summary
92103

93-
3. **Upload**the snapshot is pushed to openboot.dev as a new config under your account.
104+
3. **Confirm upload**choose to upload to openboot.dev or save locally as a fallback.
94105

95-
4. **Get your URL** — the CLI prints your shareable install URL: `openboot.dev/<username>/<slug>/install`
106+
4. **Authenticate** (if needed) — opens your browser to authorize via a device code flow (similar to `gh auth login`). If you're already authenticated, this step is skipped.
96107

97-
If you're already authenticated (token stored at `~/.openboot/auth.json`), step 1 is skipped.
108+
5. **Name your config** — provide a name like "my-setup" or "team-baseline".
109+
110+
6. **Success screen** — after upload, you'll see:
111+
```
112+
✓ Config uploaded successfully!
113+
114+
View your config:
115+
https://openboot.dev/username/my-setup
116+
117+
Share with others:
118+
curl -fsSL https://openboot.dev/username/my-setup/install | bash
119+
120+
Opening in browser...
121+
```
122+
123+
The browser automatically opens to your new config page.
98124

99125
## Privacy
100126

@@ -103,4 +129,4 @@ Snapshot is designed to be safe to share:
103129
- **Paths are sanitized** — any references to your home directory are replaced with `~/`
104130
- **Only whitelisted macOS preferences** — no arbitrary system data is read
105131
- **No secrets** — SSH keys, API tokens, `.env` files, and credentials are never captured
106-
- **You review before uploading** — the snapshot is shown in the terminal before upload so you can verify what's being shared
132+
- **Full control before uploading** — the interactive editor lets you review every item and deselect anything you don't want to share

0 commit comments

Comments
 (0)