Prerequisites
This setup script is designed exclusively for macOS. The script includes a check that will exit if run on other operating systems.
- macOS: Any recent version of macOS (the script checks with
uname -s) - Internet Connection: Required for downloading Homebrew, packages, and the config repository
- Admin Access: Needed for installing Xcode Command Line Tools and enabling Touch ID for sudo
Installation Methods
Method 1: Clone and Run (Recommended)
This method gives you the most control and allows you to inspect the setup script before running it.Method 2: One-Line Installation
For a quick installation, you can run the setup script directly:What Gets Installed
The setup script performs the following operations in sequence:1. Xcode Command Line Tools
setup.sh:52-62
2. Config Repository Setup
The script clones the config repository to~/.config and creates symbolic links for all dotfiles:
setup.sh:39-49
.zshrc- Shell configuration.gitconfig- Git settings.vimrc- Vim configuration.gitignore- Global gitignore patterns
3. Touch ID for sudo
Enables Touch ID authentication for sudo commands by configuring/etc/pam.d/sudo_local:
setup.sh:65-86
4. Homebrew Installation
Installs Homebrew package manager if not already present:setup.sh:89-97
5. Homebrew Bundle
Installs all packages defined in the Brewfile:View complete Brewfile
View complete Brewfile
Brewfile
deno- Modern JavaScript/TypeScript runtimefswatch- File system monitoringgh- GitHub CLImas- Mac App Store CLImosh- Mobile shellstarship- Shell prompt
- Zed, Claude Code, Codex (Development)
- CrossOver (Compatibility)
- SF Mono Nerd Font (Typography)
- Steam (Gaming)
- Professional suite: Final Cut Pro, Logic Pro, Motion, Compressor, Mainstage
- Productivity: Keynote, Pages, Numbers
- Development: Xcode
- Utilities: Wipr 2, Pixelmator Pro
Verification
After installation completes, verify your setup:Troubleshooting
Xcode Command Line Tools installation fails
Xcode Command Line Tools installation fails
If the GUI prompt doesn’t appear or installation fails:Then re-run the setup script after installation completes.
Homebrew installation hangs
Homebrew installation hangs
Check your internet connection and ensure you have admin privileges. You can also install Homebrew manually:
Script fails with permission errors
Script fails with permission errors
Ensure you’re not running the script with sudo. The script will request elevated privileges only when needed:
Config directory already exists
Config directory already exists
If
~/.config already exists and isn’t a git repository, the script will exit with an error. Either:-
Backup and remove the existing directory:
- Or clone to a different location and manually merge configurations
Next Steps
Once installation is complete:- Restart your terminal to load the new shell configuration
- Check out the Quick Start guide for next steps
- Customize the configuration files to match your preferences
- Explore the Configuration documentation to learn about customization options