Forked from: thoughtbot/dotfiles**
Set zsh as your login shell:
chsh -s $(which zsh)
Clone onto your laptop:
git clone git://github.com/kuschti/dotfiles.git
Review the script (avoid running scripts you haven't read!):
less install
Execute the downloaded script:
sh install 2>&1 | tee ~/dotfiles/dotfiles.log
Optionally, review the log:
less ~/dotfiles/dotfiles.log
Install rcm:
brew tap thoughtbot/formulae
brew install rcm
Install the dotfiles:
env RCRC=$HOME/dotfiles/rcrc rcup
After the initial installation, you can run rcup
without the one-time variable
RCRC
being set (rcup
will symlink the repo's rcrc
to ~/.rcrc
for future
runs of rcup
). See
example.
This command will create symlinks for config files in your home directory.
Setting the RCRC
environment variable tells rcup
to use standard
configuration options:
- Exclude the
README.md
andLICENSE
files, which are part of thedotfiles
repository but do not need to be symlinked in. - Give precedence to personal overrides which by default are placed in
~/dotfiles-local
You can safely run rcup
multiple times to update:
rcup
You should run rcup
after pulling a new version of the repository to symlink
any new files in the repository.
Put your customizations in dotfiles appended with .local
:
~/.aliases.local
~/.git_template.local/*
~/.gitconfig.local
~/.zshrc.local
~/.zsh/configs/*
For example, your ~/.aliases.local
might look like this:
# Productivity
alias todo='$EDITOR ~/.todo'
Your ~/.gitconfig.local
might look like this:
[alias]
l = log --pretty=colored
[pretty]
colored = format:%Cred%h%Creset %s %Cgreen(%cr) %C(bold blue)%an%Creset
[user]
name = Dan Croak
email = [email protected]
To extend your git
hooks, create executable scripts in
~/.git_template.local/hooks/*
files.
Your ~/.zshrc.local
might look like this:
# load pyenv if available
if which pyenv &>/dev/null ; then
eval "$(pyenv init -)"
fi
Additional zsh configuration can go under the ~/.zsh/configs
directory. This
has two special subdirectories: pre
for files that must be loaded first, and
post
for files that must be loaded last.
For example, ~/.zsh/configs/pre/virtualenv
makes use of various shell
features which may be affected by your settings, so load it first:
# Load the virtualenv wrapper
. /usr/local/bin/virtualenvwrapper.sh
Setting a key binding can happen in ~/.zsh/configs/keys
:
# Grep anywhere with ^G
bindkey -s '^G' ' | grep '
Some changes, like chpwd
, must happen in ~/.zsh/configs/post/chpwd
:
# Show the entries in a directory whenever you cd in
function chpwd {
ls
}
This directory is handy for combining dotfiles from multiple teams; one team
can add the virtualenv
file, another keys
, and a third chpwd
.
The ~/.zshrc.local
is loaded after ~/.zsh/configs
.
git configuration:
- Adds a
create-branch
alias to create feature branches. - Adds a
delete-branch
alias to delete feature branches. - Adds a
merge-branch
alias to merge feature branches into master. - Adds an
up
alias to fetch and rebaseorigin/master
into the feature branch. Usegit up -i
for interactive rebases. - Adds
post-{checkout,commit,merge}
hooks to re-index your ctags. - Adds
pre-commit
andprepare-commit-msg
stubs that delegate to your local config.
Shell aliases and scripts:
b
forbundle
.g
with no arguments isgit status
and with arguments acts likegit
.git-churn
to show churn for the files changed in the branch.migrate
forrake db:migrate && rake db:rollback && rake db:migrate
.mcd
to make a directory and change into it.replace foo bar **/*.rb
to find and replace within a given list of files.tat
to attach to tmux session named the same as the current directory.v
for$VISUAL
.
Thank you, contributors! Also, thank you to Corey Haines, Gary Bernhardt, and others for sharing your dotfiles and other shell scripts from which we derived inspiration for items in this project.
dotfiles is copyright © 2009-2016 thoughtbot. It is free software, and may be
redistributed under the terms specified in the LICENSE
file.
dotfiles is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.
We love open source software! See our other projects. We are available for hire.