My OS X dotfiles.

The installation step requires the XCode Command Line Tools and may overwrite existing dotfiles in your HOME directory.

$ bash -c "$(curl -fsSL raw.github.com/sbknk/dotfiles/master/bin/dotfiles)"

N.B. If you wish to fork this project and maintain your own dotfiles, you must substitute my username for your own in the above command and the 2 variables found at the top of the bin/dotfiles script.

You should run the update when:

• You make a change to ~/.dotfiles/git/gitconfig (the only file that is copied rather than symlinked).
• You want to pull changes from the remote repository.
• You want to update Homebrew formulae and Node packages.

Run the dotfiles command:

$ dotfiles

Options:

Homebrew formulae:

• GNU core utilities
• git
• ack
• bash (latest version)
• bash-completion
• ffmpeg
• graphicsmagick
• jpeg
• node
• rsync (latest version, rather than the out-dated OS X installation)
• tree
• wget

Node packages:

• gify
• jshint
• yo

Custom OS X settings can be applied during the dotfiles process. They can also be applied independently by running the following command:

$ osxdefaults

I use a custom bash prompt based on the Solarized color palette and influenced by @gf3's and @cowboy's custom prompts. For best results, you should install iTerm2 and import Solarized Dark.itermcolors.

When your current working directory is a Git repository, the prompt will display the checked-out branch's name (and failing that, the commit SHA that HEAD is pointing to). The state of the working tree is reflected in the following way:

Further details are in the bash_prompt file.

Screenshot:

Any private and custom Bash commands and configuration should be placed in a ~/.bash_profile.local file. This file will not be under version control or committed to a public repository. If ~/.bash_profile.local exists, it will be sourced for inclusion in bash_profile.

Here is an example ~/.bash_profile.local:

# PATH exports
PATH=$PATH:~/.gem/ruby/1.8/bin
export PATH

# Git credentials
# Not under version control to prevent people from
# accidentally committing with your details
GIT_AUTHOR_NAME="Nicolas Gallagher"
GIT_AUTHOR_EMAIL="[email protected]"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
# Set the credentials (modifies ~/.gitconfig)
git config --global user.name "$GIT_AUTHOR_NAME"
git config --global user.email "$GIT_AUTHOR_EMAIL"

# Aliases
alias code="cd ~/Code"

N.B. Because the git/gitconfig file is copied to ~/.gitconfig, any private git configuration specified in ~/.bash_profile.local will not be committed to your dotfiles repository.

If your Homebrew installation is not in /usr/local then you must prepend your custom installation's bin to the PATH in a file called ~/.dotfilesrc:

# Add `brew` command's custom location to PATH
PATH="/opt/acme/bin:$PATH"

Now, if anyone updates their local repository from the remote repository, then using git submodule update will update the submodules (that have been initialized) in their local repository. N.B This will wipe away any local changes made to those submodules.

Inspiration and code was taken from many sources, including:

• @necolas (Nicolas Gallagher) https://github.com/necolas/dotfiles
• @mathiasbynens (Mathias Bynens) https://github.com/mathiasbynens/dotfiles
• @tejr (Tom Ryder) https://github.com/tejr/dotfiles
• @gf3 (Gianni Chiappetta) https://github.com/gf3/dotfiles
• @cowboy (Ben Alman) https://github.com/cowboy/dotfiles
• @alrra (Cãtãlin Mariş) https://github.com/alrra/dotfiles