Awesome Open Source
Awesome Open Source

Mac Bootstrap

mac-bootstrap screenshot

This script will provision a new machine running a fresh install of macOS Catalina (10.15). It installs and configures the software, dotfiles, and general preferences I use for web development — primarily Rails, React, and Vue. The command line environment is based on Fish (or Zsh), Neovim, and Tmux running in iTerm2 or Alacritty.

The bootstrap script is very specific to the Mac platform. Version 5.x has been successfully tested on the following versions of macOS:

  • Catalina (10.15)

Previous versions of Mac Bootstrap have been successfully tested on the following versions of macOS:

  • Mojave (10.14)
  • High Sierra (10.13)
  • Sierra (10.12)
  • El Capitan (10.11)

Looking for dotfiles only? Check out My Dotfiles for macOS

Prerequisites

  1. Make sure your software is up to date:

     sudo softwareupdate -i -a --restart
    
  2. Install Apple's command line tools:

     xcode-select --install
    
  3. Reboot, check for additional updates, then reinstall and reboot as needed.

Installation

To install with a one-liner, run this:

curl --remote-name https://raw.githubusercontent.com/joshukraine/mac-bootstrap/master/bootstrap && sh bootstrap 2>&1 | tee ~/bootstrap.log

Want to read through the script first?

curl --remote-name https://raw.githubusercontent.com/joshukraine/mac-bootstrap/master/bootstrap
less bootstrap
sh bootstrap 2>&1 | tee ~/bootstrap.log

WARNING: This script will ask for your sudo password multiple times. You'll need to babysit it for a while. 😉

What does it do?

When you invoke bootstrap, here's what it does:

NOTE: Previously, I used the bootstrap script to set up many of the standard directories I use in my work. But since I now have Dropbox Plus, all those directories are downloaded automatically after Dropbox is installed. Once they've synced, I symlink them into place in $HOME.

Post-install Tasks

After running bootstrap there are still a few things that need to be done.

  • Restart your machine in order for some changes to take effect.
  • Complete post-install tasks from dotfiles README.
  • Set up desired macOS keyboard shortcuts (see list below)

macOS Keyboard Shortcuts

These are my (current) primary macOS keyboard shortcuts:

  • Alfred: ⌘Space
  • Clipboard (Alfred) ⌥⌘C
  • Spotlight search: ⌘⇧Space
  • Switch input source: ⌃⇧Space
  • Fantastical: ⌥⌘Space
  • iTerm2 hotkey window: ⌥Space
  • Remap Caps Lock to CTRL (anyone know a way to automate this?)

How to personalize Mac Bootstrap for your own use.

No one else's development setup will ever be a perfect match for you. That said, if your needs are close enough to mine, you might benefit from using the same shell scripts and overall structure, and just swapping out the particulars with your own. Here's my recommended approach to doing that:

  1. Fork this repo and clone your new fork to your local machine.

  2. Review the VARIABLE DECLARATIONS section and customize as desired.

  3. Review the 7 steps in bootstrap and make your own customizations. Here's an overview of what's going on:

  • Step 1 (required): Take a look at Laptop and see what you might want to tweak. One of the biggest things to review is the brew bundle list of packages and casks that will be installed. Customize as needed. Laptop also sets up some basics that are required by the bootstrap script later on.
  • Step 2 (recommended): Use Oh My Zsh?
  • Step 3 (required): Review general macOS settings in install/macos-defaults and adjust as needed. This script also sets things like HostName which are needed later for the dotfiles installation.
  • Step 4 (recommended): Install scripts to ~/bin?
  • Step 5 (recommended): Set up Tmuxinator profile?
  • Step 6 (optional): Install Ukrainian language utilities? Maybe you're interested in some other language extensions?
  • Step 7 (required): The dotfiles. Update the $DOTFILES_* variables (see bootstrap under "VARIABLE DECLARATIONS") to reference your dotfiles. As a starting point, you can fork mine and then point to your fork.
  1. Create ~/dotfiles/local/config.fish.local or ~/.zshrc.local, ~/.gitconfig.local, and ~/.vimrc.local and add in your personal information. These files are sourced in ~/.config/fish/config.fish or ~/.zshrc, ~/.gitconfig, and ~/.vimrc respectively.

  2. Update the README with your own info, instructions/reminders so you don't forget what you did, and especially the correct install URL:

curl --remote-name https://raw.githubusercontent.com/YOUR-GITHUB-USERNAME/mac-bootstrap/master/bootstrap && sh bootstrap 2>&1 | tee ~/boostrap.log
  1. Run the script on your machine and wait for the first error. 😇 Then fix, commit, push, and repeat.

Some of my favorite dotfile repos

Helpful web resources on dotfiles, et al.

License

Copyright © 2020 Joshua Steele. MIT License


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
shell (10,559
macos (1,812
neovim (389
zsh (322
dotfiles (318
tmux (145
fish (96
iterm2 (63
preferences (35