This repository serves as my way to help me setup and maintain my Mac. It takes the effort out of installing everything manually. Everything which is needed to install my preffered setup of macOS is detailed in this readme. Feel free to explore, learn and copy parts for your own dotfiles. Enjoy! 😄
Read the blog post: https://driesvints.com/blog/getting-started-with-dotfiles
These instructions are for when you've already set up your dotfiles. If you want to get started with your own dotfiles you can find instructions below.
First, go through the checklist below to make sure you didn't forget anything before you wipe your hard drive.
- Did you commit and push any changes/branches to your git repositories?
- Did you remember to save all important documents from non-iCloud directories?
- Did you save all of your work from apps which aren't synced through iCloud?
- Did you remember to export important data from your local database?
- Did you update mackup to the latest version and ran
mackup backup?
After going to our checklist above and making sure you backed everything up, we're going to cleanly install macOS with the latest release. Follow this article to cleanly install the latest macOS.
If you did all of the above you may now follow these install instructions to setup a new Mac.
- Update macOS to the latest version with the App Store
- Install Xcode from the App Store, open it and accept the license agreement
- Install macOS Command Line Tools by running
xcode-select --install - Copy your public and private SSH keys to
~/.sshand make sure they're set to600 - Clone this repo to
~/.dotfiles - Append
/usr/local/bin/zshto the end of your/etc/shellsfile - Run
install.shto start the installation - Restore preferences by running
mackup restore - Restart your computer to finalize the process
Your Mac is now ready to use!
Note: you can use a different location than
~/.dotfilesif you want. Just make sure you also update the reference in the.zshrcfile.
If you want to start with your own dotfiles from this setup, it's pretty easy to do so. First of all you'll need to fork this repo. After that you can tweak it the way you want.
Go through the .macos file and adjust the settings to your liking. You can find much more settings at the original script by Mathias Bynens and Kevin Suttle's macOS Defaults project.
Check out the Brewfile file and adjust the apps you want to install for your machine. Use their search page to check if the app you want to install is available.
Check out the aliases.zsh file and add your own aliases. If you need to tweak your $PATH check out the path.zsh file. These files get loaded in because the .zshrc file loads the .dotfiles directory. You can adjust the .zshrc file to your liking to tweak your zplug setup. More info about how to customize zplug can be found here.
When installing these dotfiles for the first time you'll need to backup all of your settings with Mackup. Install Mackup and backup your settings with the commands below. Your settings will be synced to iCloud so you can use them to sync between computers and reinstall them when reinstalling your Mac. If you want to save your settings to a different directory or different storage than iCloud, checkout the documentation.
brew install mackup
mackup backupYou can tweak the shell theme, the zplug settings and much more. Go through the files in this repo and tweak everything to your liking.
Enjoy your own Dotfiles!
I first got the idea for starting this project by visiting the Github does dotfiles project. Both Zach Holman and Mathias Bynens were great sources of inspiration. Sourabh Bajaj's Mac OS X Setup Guide proved to be invaluable. Thanks to @subnixr for his awesome Zsh theme! And lastly, I'd like to thank Maxime Fabre for his excellent presentation on Homebrew which made me migrate a lot to a Brewfile and Mackup.
In general, I'd like to thank every single one who open-sources their dotfiles for their effort to contribute something to the open-source community. Your work means the world! 🌍 ❤️