Skip to content

Commit 317874a

Browse files
committed
docs: update macOS preferences whitelist and add tap package type
Sync documentation with current macos-prefs-catalog.ts (23 → 26 preferences, new categories: Trackpad, Desktop, Keyboard, Menu Bar; removed: Safari, TextEdit, Time Machine). Add `tap` as a documented package type across config-options, api-reference, and PresetPackage type definition.
1 parent 4743091 commit 317874a

File tree

5 files changed

+69
-77
lines changed

5 files changed

+69
-77
lines changed

src/docs/api-reference.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,8 @@ POST /api/configs/from-snapshot
163163
"packages": {
164164
"formulae": ["node", "go"],
165165
"casks": ["visual-studio-code"],
166-
"npm": ["typescript"]
166+
"npm": ["typescript"],
167+
"taps": ["homebrew/cask-fonts"]
167168
},
168169
"macos_prefs": [...],
169170
"shell": {...},

src/docs/config-options.md

Lines changed: 52 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Config Options
3-
description: Full config schema — packages, custom scripts, dotfiles repo, visibility, aliases, and the 23 macOS preferences whitelist.
3+
description: Full config schema — packages, custom scripts, dotfiles repo, visibility, aliases, and the 26 macOS preferences whitelist.
44
group: Reference
55
order: 10
66
---
@@ -22,7 +22,8 @@ Every OpenBoot config — whether created from a preset, a snapshot, or the dash
2222
{ "name": "ripgrep", "type": "formula" },
2323
{ "name": "visual-studio-code", "type": "cask" },
2424
{ "name": "arc", "type": "cask" },
25-
{ "name": "typescript", "type": "npm" }
25+
{ "name": "typescript", "type": "npm" },
26+
{ "name": "homebrew/cask-fonts", "type": "tap" }
2627
],
2728
"custom_script": "mkdir -p ~/projects\ngit clone git@github.com:yourorg/main-repo.git ~/projects/main-repo",
2829
"dotfiles_repo": "https://github.com/yourorg/team-dotfiles.git",
@@ -66,8 +67,9 @@ The tools and apps to install. Stored as an array of package objects, each with
6667
- **`formula`** — CLI tools installed via `brew install`
6768
- **`cask`** — GUI apps installed via `brew install --cask`
6869
- **`npm`** — Global npm packages installed via `npm install -g`
70+
- **`tap`** — Third-party Homebrew repositories added via `brew tap`
6971

70-
Each entry is an object: `{ "name": "package-name", "type": "formula" | "cask" | "npm" }`. Names must match Homebrew or npm package names exactly.
72+
Each entry is an object: `{ "name": "package-name", "type": "formula" | "cask" | "npm" | "tap" }`. Names must match Homebrew or npm package names exactly. Taps are added before formulae and casks are installed.
7173

7274
### `custom_script`
7375

@@ -128,62 +130,65 @@ You can export any config as a JSON file from the dashboard. Click the **Export*
128130

129131
## macOS Preferences Whitelist
130132

131-
These are the 23 system settings that OpenBoot can configure. Only these are captured by `openboot snapshot` and applied during install.
133+
These are the 26 system settings that OpenBoot can configure. Only these are captured by `openboot snapshot` and applied during install. In the dashboard, preferences are grouped into collapsible accordion sections by category.
132134

133-
### Global
135+
### Dock
134136

135-
| Setting | Description | Default Value |
136-
|---------|-------------|---------------|
137-
| Show all file extensions | Files show `.txt`, `.js`, etc. in Finder | on |
138-
| Always show scrollbars | No auto-hiding scrollbars | on |
139-
| Disable auto-correct | No automatic text correction | on |
140-
| Disable auto-capitalization | No automatic capitalization | on |
141-
| Fast key repeat | Faster character repeat when holding a key | on |
142-
| Short key repeat delay | Shorter delay before repeat starts | on |
137+
| Setting | Description | Default |
138+
|---------|-------------|---------|
139+
| Auto-hide Dock | Automatically hide and show the Dock | on |
140+
| Auto-hide delay (s) | Delay before Dock appears on hover — 0 for instant | 0 |
141+
| Icon size | Dock icon size in pixels | 48 |
142+
| Show recent apps | Show recently used apps in a separate Dock section | off |
143+
| Position on screen | Which edge the Dock appears on (bottom, left, right) | bottom |
144+
| Minimize animation | Visual effect when minimizing windows (genie or scale) | genie |
145+
| Show only active apps | Hide non-running apps from the Dock | off |
146+
| Animate app launches | Bounce icons when launching an app | on |
143147

144148
### Finder
145149

146-
| Setting | Description | Default Value |
147-
|---------|-------------|---------------|
148-
| Show path bar | Full path shown at bottom of Finder | on |
149-
| Show status bar | Item count and disk space at bottom | on |
150-
| Default to list view | Finder opens in list view | on |
151-
| No extension change warning | No alert when renaming file extensions | on |
152-
| Show hidden files | Dotfiles and hidden folders visible | on |
150+
| Setting | Description | Default |
151+
|---------|-------------|---------|
152+
| Default view style | How files display in new windows (icon, list, column, gallery) | list |
153+
| New window opens | Default location for new Finder windows | Home folder |
154+
| Default search scope | Where Finder searches by default (This Mac, current folder) | Current folder |
155+
| Show path bar | Full folder path at bottom of windows | on |
156+
| Show status bar | Item count and disk space at bottom of windows | on |
157+
| Show hidden files | Show files and folders starting with a dot | off |
158+
| Always show file extensions | Show extensions for all files | on |
159+
| Show full path in title bar | Display POSIX path in window title | off |
153160

154-
### Dock
161+
### Trackpad
155162

156-
| Setting | Description | Default Value |
157-
|---------|-------------|---------------|
158-
| Keep Dock visible | Dock does not auto-hide | on |
159-
| Hide recent applications | No "recent apps" section in Dock | on |
160-
| Icon size | Dock icon size in pixels | 48 |
161-
| Scale minimize effect | Use scale animation instead of genie | on |
163+
| Setting | Description | Default |
164+
|---------|-------------|---------|
165+
| Tap to click | Tap the trackpad to click instead of pressing down | on |
166+
| Natural scrolling | Scroll content in the direction your fingers move | on |
167+
| Three-finger drag | Drag windows and items using three fingers | off |
162168

163-
### Screenshots
169+
### Desktop
164170

165-
| Setting | Description | Default Value |
166-
|---------|-------------|---------------|
167-
| Save location | Where screenshots are saved | `~/Screenshots` |
168-
| PNG format | Save as PNG instead of other formats | on |
169-
| Disable shadow | No drop shadow on window screenshots | on |
171+
| Setting | Description | Default |
172+
|---------|-------------|---------|
173+
| Click desktop to show it | Click wallpaper to hide all windows | off |
170174

171-
### Safari
175+
### Keyboard
172176

173-
| Setting | Description | Default Value |
174-
|---------|-------------|---------------|
175-
| Developer menu | Show Develop menu in menu bar | on |
176-
| WebKit developer extras | Enable Web Inspector and other dev tools | on |
177+
| Setting | Description | Default |
178+
|---------|-------------|---------|
179+
| Key repeat rate | How fast keys repeat when held — lower = faster | 2 |
180+
| Delay until key repeat | How long before a held key starts repeating | 15 |
181+
| Press and hold for accents | Show accent menu when holding a key (disable for faster repeat) | off |
177182

178-
### TextEdit
183+
### Screenshots
179184

180-
| Setting | Description | Default Value |
181-
|---------|-------------|---------------|
182-
| Plain text mode | Default to plain text, not rich text | on |
183-
| UTF-8 encoding | Use UTF-8 for plain text files | on |
185+
| Setting | Description | Default |
186+
|---------|-------------|---------|
187+
| Screenshot format | File format for screenshots (PNG, JPEG, PDF, TIFF) | PNG |
188+
| Disable window shadows | Remove drop shadows from window screenshots | on |
184189

185-
### Time Machine
190+
### Menu Bar
186191

187-
| Setting | Description | Default Value |
188-
|---------|-------------|---------------|
189-
| Don't prompt for new disks | No "use this disk for backup?" popups | on |
192+
| Setting | Description | Default |
193+
|---------|-------------|---------|
194+
| Show Sound in menu bar | Always show volume control in the menu bar | on |

src/docs/dotfiles-shell.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -78,33 +78,19 @@ OpenBoot applies a curated set of developer-friendly macOS settings. These are a
7878

7979
### What Gets Configured
8080

81-
**Global**
82-
- Show all file extensions
83-
- Always show scrollbars
84-
- Disable auto-correct and auto-capitalization
85-
- Fast key repeat rate and short repeat delay
86-
87-
**Finder**
88-
- Show path bar and status bar
89-
- Default to list view
90-
- No warning when changing file extensions
91-
- Show hidden files
92-
93-
**Dock**
94-
- Keep Dock visible (no autohide by default)
95-
- Hide recent applications
96-
- Set icon size
97-
- Use scale effect for minimize
98-
99-
**Screenshots**
100-
- Save to `~/Screenshots`
101-
- PNG format
102-
- Disable shadow
103-
104-
**Other**
105-
- Safari developer menu enabled
106-
- TextEdit defaults to plain text
107-
- Time Machine won't prompt for new backup disks
81+
**Dock** — Auto-hide, hide delay, icon size, show recent apps, position, minimize animation, show only active apps, launch animation
82+
83+
**Finder** — Default view style, new window location, search scope, path bar, status bar, hidden files, file extensions, POSIX path in title bar
84+
85+
**Trackpad** — Tap to click, natural scrolling, three-finger drag
86+
87+
**Desktop** — Click wallpaper to show desktop
88+
89+
**Keyboard** — Key repeat rate, delay until repeat, press-and-hold for accents
90+
91+
**Screenshots** — File format (PNG/JPEG/PDF/TIFF), disable window shadows
92+
93+
**Menu Bar** — Show Sound control
10894

10995
### Skipping macOS Preferences
11096

src/docs/snapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ curl -fsSL https://openboot.dev/install.sh | bash -s -- snapshot
2727
| **Homebrew Casks** | All installed GUI apps | `brew list --cask` |
2828
| **Homebrew Taps** | Third-party repositories | `brew tap` |
2929
| **NPM Global Packages** | Globally installed npm packages | `npm list -g` |
30-
| **macOS Preferences** | 23 whitelisted developer settings | Curated list |
30+
| **macOS Preferences** | 26 whitelisted developer settings | Curated list |
3131
| **Shell Config** | Oh-My-Zsh plugins, theme, aliases | `.zshrc` parsing |
3232
| **Git Config** | user.name, user.email, editor, default branch | `~/.gitconfig` |
3333
| **Dev Tools** | Go, Node.js, Python, Rust, Java, Ruby, Docker | Version detection |

src/lib/presets.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { getPackageDescription } from './package-metadata';
22

33
export interface PresetPackage {
44
name: string;
5-
type: 'formula' | 'cask' | 'npm';
5+
type: 'formula' | 'cask' | 'npm' | 'tap';
66
desc: string;
77
}
88

0 commit comments

Comments
 (0)