Justin’s dotfiles

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!

Using Git and the modern bootstrap system

You can clone the repository wherever you want (I like to keep it in ~/.dotfiles). The modern bootstrapper uses JavaScript and will automatically handle Node.js installation, symlink creation, and backup of existing files.

macOS/Linux

git clone https://github.com/murrayju/dotfiles.git ~/.dotfiles && cd ~/.dotfiles && ./bs

To update, just run the bootstrap script again

cd ~/.dotfiles && ./bs

The new bootstrap system will:

• Automatically install Node.js if needed using build-strap-cli
• Create symlinks from the repository to your home directory
• Back up any existing files that differ from the repository versions
• Install Oh My Zsh, Powerlevel10k theme, and Tmux Plugin Manager
• Set up the modern Neovim configuration

Git-free install

To install these dotfiles without Git:

cd; curl -#L https://github.com/murrayju/dotfiles/tarball/master | tar -xzv --strip-components 1 --exclude={README.md,bootstrap.js,.macos,LICENSE-MIT.txt} && ./bs

To update later on, just run that command again.

Specify the $PATH

If ~/.path exists, it will be sourced along with the other files, before any feature testing (such as detecting which version of ls is being used) takes place.

Here’s an example ~/.path 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 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 looks something like this:

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

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

Sensible macOS defaults

When setting up a new Mac, you may want to set some sensible macOS defaults:

./.macos

Install Homebrew formulae

When setting up a new Mac, you may want to install some common Homebrew formulae (after installing Homebrew, of course):

./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.

Feedback

Suggestions/improvements welcome!

Original Author

Mathias Bynens

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