You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: src/docs/snapshot.md
+34-8Lines changed: 34 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,19 +82,45 @@ Save locally for later:
82
82
openboot snapshot --local
83
83
```
84
84
85
-
## Upload Flow
85
+
## Interactive Flow
86
86
87
-
When you run `openboot snapshot` without flags, after scanning your system it will:
87
+
When you run `openboot snapshot` without flags:
88
88
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
+
```
90
96
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
92
103
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.
94
105
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.
96
107
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".
0 commit comments