Skip to content

Commit c1e8187

Browse files
committed
fix: sync docs and presets with source of truth — correct package counts, fix hallucinated JSON schema, add missing capture categories
1 parent af5c282 commit c1e8187

File tree

8 files changed

+50
-27
lines changed

8 files changed

+50
-27
lines changed

src/docs/config-options.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,14 @@ Every OpenBoot config — whether created from a preset, a snapshot, or the dash
1515
"name": "frontend-team",
1616
"description": "Standard setup for our frontend developers",
1717
"base_preset": "developer",
18-
"packages": {
19-
"formulae": ["node", "pnpm", "ripgrep", "fd", "bat", "gh", "jq"],
20-
"casks": ["visual-studio-code", "arc", "figma", "warp", "raycast"],
21-
"npm": ["typescript", "tsx", "eslint", "prettier"]
22-
},
18+
"packages": [
19+
{ "name": "node", "type": "formula" },
20+
{ "name": "pnpm", "type": "formula" },
21+
{ "name": "ripgrep", "type": "formula" },
22+
{ "name": "visual-studio-code", "type": "cask" },
23+
{ "name": "arc", "type": "cask" },
24+
{ "name": "typescript", "type": "npm" }
25+
],
2326
"custom_script": "mkdir -p ~/projects\ngit clone git@github.com:yourorg/main-repo.git ~/projects/main-repo",
2427
"dotfiles_repo": "https://github.com/yourorg/team-dotfiles.git",
2528
"snapshot": null,
@@ -57,21 +60,21 @@ Which preset to start from. The preset's packages are included unless individual
5760

5861
### `packages`
5962

60-
The tools and apps to install.
63+
The tools and apps to install. Stored as an array of package objects, each with a `name` and `type`.
6164

62-
- **`formulae`** — CLI tools installed via `brew install`
63-
- **`casks`** — GUI apps installed via `brew install --cask`
65+
- **`formula`** — CLI tools installed via `brew install`
66+
- **`cask`** — GUI apps installed via `brew install --cask`
6467
- **`npm`** — Global npm packages installed via `npm install -g`
6568

66-
All three are arrays of package name strings. Names must match Homebrew or npm package names exactly.
69+
Each entry is an object: `{ "name": "package-name", "type": "formula" | "cask" | "npm" }`. Names must match Homebrew or npm package names exactly.
6770

6871
### `custom_script`
6972

7073
Shell commands that run after all packages are installed. Use this for project-specific setup like cloning repos, generating SSH keys, or configuring services.
7174

7275
- **Type:** string (newline-separated commands)
7376
- **Required:** no
74-
- **Runs as:** `bash -e` (stops on first error)
77+
- **Runs as:** `bash` (errors are logged but don't stop the install)
7578

7679
```
7780
mkdir -p ~/projects

src/docs/custom-configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Build your own setup, save it on openboot.dev, and share it as a one-line instal
1010

1111
## Creating a Config
1212

13-
1. **Sign in** with GitHub — click **Login** in the header (no email/password needed)
13+
1. **Sign in** with GitHub or Google — click **Login** in the header (no email/password needed)
1414
2. Go to your **[Dashboard](/dashboard)**
1515
3. Click **Create Config**
1616
4. Pick a **base preset** (`minimal`, `developer`, or `full`) as your starting point

src/docs/dotfiles-shell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Control how OpenBoot handles dotfiles with the `--dotfiles` flag:
4444

4545
| Mode | What it does |
4646
|------|-------------|
47-
| `clone` | Clone the repo (default) |
47+
| `clone` | Clone the repo to `~/.dotfiles` |
4848
| `link` | Clone and symlink with `stow` |
4949
| `skip` | Don't touch dotfiles |
5050

src/docs/presets.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ Three curated starting points. Pick one, then customize it in the TUI before ins
1313
| | minimal | developer | full |
1414
|---|---------|-----------|------|
1515
| **Best for** | Minimalists, servers | Most developers | Polyglot / DevOps |
16-
| **CLI tools** | 18 | 26 | 40 |
17-
| **GUI apps** | 4 | 11 | 20 |
16+
| **CLI tools** | 19 | 29 | 48 |
17+
| **GUI apps** | 5 | 14 | 25 |
1818
| **Includes** | Essentials | Essentials + languages + editors | Everything |
1919

2020
## minimal
2121

2222
CLI essentials. Fast and lightweight.
2323

24-
**CLI tools:** curl, wget, jq, yq, ripgrep, fd, bat, eza, fzf, zoxide, htop, btop, tree, tealdeer, gh, git-delta, lazygit, stow
24+
**CLI tools:** curl, wget, jq, yq, ripgrep, fd, bat, eza, fzf, zoxide, htop, btop, tree, tealdeer, gh, git-delta, git-lfs, lazygit, stow
2525

26-
**GUI apps:** Warp, Raycast, Maccy, Stats
26+
**GUI apps:** Warp, Raycast, Maccy, Stats, Rectangle
2727

2828
```
2929
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset minimal
@@ -34,8 +34,8 @@ curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset minimal
3434
The recommended starting point. Everything you need to start building, nothing you don't.
3535

3636
**Adds over minimal:**
37-
- **CLI:** node, go, pnpm, docker, docker-compose, tmux, neovim, httpie
38-
- **GUI:** VS Code, OrbStack, Chrome, Arc, Postman, Notion, Scroll Reverser
37+
- **CLI:** node, go, pnpm, docker, docker-compose, lazydocker, tmux, neovim, httpie, pre-commit
38+
- **GUI:** VS Code, OrbStack, Chrome, Arc, Postman, Notion, Scroll Reverser, TablePlus, AppCleaner
3939

4040
```
4141
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset developer
@@ -46,8 +46,8 @@ curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset developer
4646
Complete dev environment. Languages, DevOps, databases, AI tools — all of it.
4747

4848
**Adds over developer:**
49-
- **CLI:** python, uv, rustup, deno, bun, kubectl, helm, k9s, terraform, awscli, sqlite, postgresql, redis, duckdb, ollama, llm
50-
- **GUI:** Cursor, Firefox, Proxyman, Obsidian, Figma, IINA, Keka, AlDente, Rectangle
49+
- **CLI:** python, uv, rustup, deno, bun, cmake, kubectl, helm, k9s, terraform, awscli, sqlite, postgresql, redis, duckdb, ollama, llm, tig, dive
50+
- **GUI:** Cursor, Firefox, Proxyman, Obsidian, Figma, IINA, Keka, AlDente, ngrok, Shottr, Miniconda
5151

5252
```
5353
curl -fsSL https://openboot.dev/install.sh | bash -s -- --preset full

src/docs/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ curl -fsSL https://openboot.dev/install.sh | bash
1919
What happens next:
2020

2121
```
22-
✓ Downloaded OpenBoot v0.4.0
22+
✓ Downloaded OpenBoot
2323
✓ Xcode Command Line Tools ready
2424
✓ Homebrew ready
2525
🚀 Launching interactive installer...

src/docs/snapshot.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ curl -fsSL https://openboot.dev/install.sh | bash -s -- snapshot
2424
|----------|---------------|-----|
2525
| **Homebrew Formulae** | Top-level CLI tools (not dependencies) | `brew leaves` |
2626
| **Homebrew Casks** | All installed GUI apps | `brew list --cask` |
27+
| **Homebrew Taps** | Third-party repositories | `brew tap` |
28+
| **NPM Global Packages** | Globally installed npm packages | `npm list -g` |
2729
| **macOS Preferences** | 23 whitelisted developer settings | Curated list |
2830
| **Shell Config** | Oh-My-Zsh plugins, theme, aliases | `.zshrc` parsing |
2931
| **Git Config** | user.name, user.email, editor, default branch | `~/.gitconfig` |
@@ -45,10 +47,10 @@ curl -fsSL https://openboot.dev/install.sh | bash -s -- snapshot
4547

4648
**Step 2 — Review.** A full-screen TUI editor lets you customize what's included:
4749

48-
- **3 tabs**: Formulae, Casks, macOS Preferences
50+
- **Tabs**: Formulae, Casks, NPM Packages, macOS Preferences
4951
- **Space** to toggle individual items on/off
5052
- **`/`** to search, **`a`** to select all in a category
51-
- Shell, Git, and Dev Tools are shown as a read-only summary
53+
- Taps, Shell, Git, and Dev Tools are shown as a read-only summary
5254

5355
**Step 3 — Save.** Choose where it goes:
5456

src/docs/what-is-openboot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ OpenBoot is an open-source CLI that sets up your entire macOS development enviro
1515
- **Packages & Apps** — Install CLI tools (`node`, `go`, `docker`, `ripgrep`...) and GUI apps (`VS Code`, `Chrome`, `Warp`...) from Homebrew, all at once
1616
- **Shell Configuration** — Oh-My-Zsh with plugins, a clean theme, and useful aliases, configured automatically
1717
- **Dotfiles** — Clone and link your dotfiles repo so your personal config follows you to any machine
18-
- **macOS Preferences** — Developer-friendly system settings (fast key repeat, Finder path bar, Dock autohide...) applied in one pass
18+
- **macOS Preferences** — Developer-friendly system settings (fast key repeat, Finder path bar, Dock icon size...) applied in one pass
1919
- **Snapshot** — Capture your current Mac's setup and turn it into a shareable config URL
2020

2121
## How It Works

src/lib/presets.ts

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ export const PRESET_PACKAGES: Record<string, PresetPackages> = {
2323
'tealdeer',
2424
'gh',
2525
'git-delta',
26+
'git-lfs',
2627
'lazygit',
2728
'stow'
2829
],
29-
cask: ['warp', 'raycast', 'maccy', 'stats']
30+
cask: ['warp', 'raycast', 'maccy', 'stats', 'rectangle']
3031
},
3132
developer: {
3233
cli: [
@@ -46,13 +47,16 @@ export const PRESET_PACKAGES: Record<string, PresetPackages> = {
4647
'tealdeer',
4748
'gh',
4849
'git-delta',
50+
'git-lfs',
4951
'lazygit',
52+
'pre-commit',
5053
'stow',
5154
'node',
5255
'go',
5356
'pnpm',
5457
'docker',
5558
'docker-compose',
59+
'lazydocker',
5660
'tmux',
5761
'neovim',
5862
'httpie'
@@ -63,12 +67,15 @@ export const PRESET_PACKAGES: Record<string, PresetPackages> = {
6367
'maccy',
6468
'stats',
6569
'scroll-reverser',
70+
'rectangle',
6671
'visual-studio-code',
6772
'orbstack',
6873
'google-chrome',
6974
'arc',
7075
'postman',
71-
'notion'
76+
'notion',
77+
'tableplus',
78+
'appcleaner'
7279
],
7380
npm: ['typescript', 'tsx', 'eslint', 'prettier', 'nodemon']
7481
},
@@ -90,13 +97,18 @@ export const PRESET_PACKAGES: Record<string, PresetPackages> = {
9097
'tealdeer',
9198
'gh',
9299
'git-delta',
100+
'git-lfs',
93101
'lazygit',
102+
'tig',
103+
'pre-commit',
94104
'stow',
95105
'node',
96106
'go',
97107
'pnpm',
98108
'docker',
99109
'docker-compose',
110+
'lazydocker',
111+
'dive',
100112
'tmux',
101113
'neovim',
102114
'httpie',
@@ -105,6 +117,7 @@ export const PRESET_PACKAGES: Record<string, PresetPackages> = {
105117
'rustup',
106118
'deno',
107119
'bun',
120+
'cmake',
108121
'kubectl',
109122
'helm',
110123
'k9s',
@@ -123,21 +136,26 @@ export const PRESET_PACKAGES: Record<string, PresetPackages> = {
123136
'maccy',
124137
'stats',
125138
'scroll-reverser',
139+
'rectangle',
126140
'visual-studio-code',
127141
'cursor',
128142
'orbstack',
143+
'ngrok',
129144
'google-chrome',
130145
'arc',
131146
'firefox',
132147
'postman',
133148
'proxyman',
149+
'tableplus',
134150
'notion',
135151
'obsidian',
136152
'figma',
137153
'iina',
138154
'keka',
139155
'aldente',
140-
'rectangle'
156+
'appcleaner',
157+
'shottr',
158+
'miniconda'
141159
],
142160
npm: ['typescript', 'tsx', 'eslint', 'prettier', 'nodemon', 'pm2', 'serve', 'vercel', 'wrangler']
143161
}

0 commit comments

Comments
 (0)