Joaquim’s dotfiles

This is a fork of Mathias Bynens dotfiles repository. Before anything else I recommend looking into his repository for inspiration. To a large extent, this is a subset of the configuration in the original repository. The main relevant difference is that I use zsh and not bash.

Installation

Warning: If you want to give these dotfiles a try, you should first fork this repository, review the code, and remove things you don’t want or need. Don’t blindly use my settings unless you know what that entails. Use at your own risk!

You can clone the repository wherever you want (I like to keep it in ~/dotfiles). The bootstrapper script will pull in the latest version and copy the files to your home folder.

Setting up a new Mac

Before anything else, generate an SSH key and set up SSH accesss to GitHub:

curl -O https://raw.githubusercontent.com/quimrstorres/dotfiles/master/ssh.sh && chmod +x ssh.sh && ./ssh.sh

This script will ask the user for some data and assumes 2FA is set up for GitHub.

Clone the repository and move inside:

git clone --recursive -j8 git@github.com:quimrstorres/dotfiles.git
cd dotfiles

Install Homebrew formulae and casks:

./brew.sh

Some of the functionality of these dotfiles depends on formulae installed by brew.sh. If you don’t plan to run brew.sh, you should look carefully through the script and manually install any particularly important ones. A good example is Bash/Git completion: the dotfiles use a special version from Homebrew.

Install some things that are not available through Homebrew

# Install the Rust language server (requires rustup)
rustup component add rls rust-analysis rust-src

Next, set some sensible macOS defaults:

./macos.sh`

Finally, bootstrap dotfiles:

source bootstrap.zsh

Configure/update existing Mac

git clone --recursive -j8 git@github.com:quimrstorres/dotfiles.git && cd dotfiles && source bootstrap.zsh

To update, cd into your local dotfiles repository and then:

source bootstrap.zsh

Alternatively, to update while avoiding the confirmation prompt:

set -- -f; source bootstrap.zsh

Additional steps

Specify the $PATH

If ~/.path.zsh exists, it will be sourced along with the other files.

Here’s an example ~/.path.zsh file that adds /usr/local/bin to the $PATH:

export PATH="/usr/local/bin:$PATH"

Add custom commands without creating a new fork

If ~/.extra.zsh exists, it will be sourced along with the other files. You can use this to add a few custom commands without the need to fork this entire repository, or to add commands you don’t want to commit to a public repository.

My ~/.extra.zsh looks something like this:

# Git credentials
# Not in the repository, to prevent people from accidentally committing under my name
GIT_AUTHOR_NAME="Mathias Bynens"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
git config --global user.name "$GIT_AUTHOR_NAME"
GIT_AUTHOR_EMAIL="mathias@mailinator.com"
GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
git config --global user.email "$GIT_AUTHOR_EMAIL"

You could also use ~/.extra.zsh to override settings, functions and aliases from my dotfiles repository. It’s probably better to fork this repository instead, though.

Original author

Mathias Bynens

The original author thanks to…

• @ptb and his macOS Setup repository
• Ben Alman and his dotfiles repository
• Cătălin Mariș and his dotfiles repository
• Gianni Chiappetta for sharing his amazing collection of dotfiles
• Jan Moesen and his ancient .bash_profile + shiny tilde repository
• Lauri ‘Lri’ Ranta for sharing loads of hidden preferences
• Matijs Brinkhuis and his dotfiles repository
• Nicolas Gallagher and his dotfiles repository
• Sindre Sorhus
• Tom Ryder and his dotfiles repository
• Kevin Suttle and his dotfiles repository and macOS-Defaults project, which aims to provide better documentation for ~/.macos
• Haralan Dobrev
• Anyone who contributed a patch or made a helpful suggestion