My OS X dotfiles
This is a very basic dotfile repository forked from https://mths.be/dotfiles. I have modified the settings to my liking, enhanced the installation process, and added cask to automate macOS Application 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. The bootstrapper script will pull in the latest version and copy the files to your home folder.
git clone https://github.com/mikegreiling/dotfiles.git && cd dotfiles && source install.sh
To update, cd
into your local dotfiles
repository and then:
source install.sh
To install these dotfiles without Git:
cd; curl -#L https://github.com/mikegreiling/dotfiles/tarball/master | tar -xzv --strip-components 1 --exclude={README.md,*.sh,LICENSE-MIT.txt}
To update later on, just run that command again.
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"
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.
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.
My ~/.extra
looks something like this:
# Git credentials
# Not under version control to prevent people from
# accidentally committing with your details
GIT_AUTHOR_NAME="Mike Greiling"
GIT_AUTHOR_EMAIL="mike@pixelcog.com"
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"
When setting up a new Mac, you may want to set some sensible macOS defaults:
./macos.sh
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.
Once this is all in place, there are a few other items which must be done manually (included here for my own reference).
- Go to System Settings ➜ General and:
- Check "Ask to keep changes when closing documents"
- Uncheck "Close windows when quitting an app"
*I have not yet learned how to do this programmatically
- Generate your ssh key and install it on GitHub.
- Enter any license keys necessary for installed apps (Things, Kaleidoscope, Transmit, et al)
Included is a prompt which I shamelessly stole from Nicolas Gallagher. Here is his descroption:
I use a custom bash prompt based on the Solarized color palette and influenced by @gf3's and @cowboy's custom prompts.
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:
Sym Key +
Uncommitted changes in the index !
Unstaged changes ?
Untracked files $
Stashed files Further details are in the
bash_prompt
file.Screenshot:
Mike Greiling |
Original by Mathias Bynens
- Mathias Bynens and the original dotfiles repository
- Nicolas Gallagher and his dotfiles repository
- Ben Alman and his dotfiles repository
- Matthew Mueller and his "Hacker's Guide to Setting Up Your Mac" article which inspired me to research this
- Brandon Brown and his osx-for-hackers.sh gistfile