dotfiles

My dotfiles, compatible with OS X and Debian.

3 years after

SpaceK33zʼs dotfiles

Your dotfiles are how you personalize your system. These are mine. They are based on holmans dotfiles.

Install

Run this:

git clone --recursive https://github.com/SpaceK33z/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/bootstrap

This will symlink the appropriate files in .dotfiles to your home directory. Everything is configured and tweaked within ~/.dotfiles.

dot is a simple script that installs some dependencies and sets sane defaults. It works for macOS and Debian. If the system is not running macOS or Debian, it will simply skip this script. Tweak this script, and occasionally run dot from time to time to keep your environment fresh and up-to-date. You can find this script in bin/.

Usage

For host-specific aliases or shortcuts, create a ~/.localrc.

On your host machine, you often want to run an ssh-agent so that your SSH keys can be automatically forwarded when ssh-ing to other hosts. Add export DOT_START_SSH_AGENT=true to your ~/.localrc to enable it for your host machine.

To customize the colors, add this to your ~/.localrc:

COLOR_HOST=bm
COLOR_USER=bg

A list of color variables is available in zsh/promp.zsh.

Topical

Everything's built around topic areas. If you're adding a new area to your forked dotfiles — say, "Python" — you can simply add a python directory and put files in there. Anything with an extension of .zsh will get automatically included into your shell. Anything with an extension of .symlink will get symlinked without extension into $HOME when you run script/bootstrap.

Components

There's a few special files in the hierarchy.

  • bin/: Anything in bin/ will get added to your $PATH and be made available everywhere.
  • topic/*.zsh: Any files ending in .zsh get loaded into your environment.
  • topic/path.zsh: Any file named path.zsh is loaded first and is expected to setup $PATH or similar.
  • topic/completion.zsh: Any file named completion.zsh is loaded last and is expected to setup autocomplete.
  • topic/*.symlink: Any files ending in *.symlink get symlinked into your $HOME. This is so you can keep all of those versioned in your dotfiles but still keep those autoloaded files in your home directory. These get symlinked in when you run script/bootstrap.

Related Repositories

awesome-dotfiles

awesome-dotfiles

A curated list of dotfiles resources. ...

dotfiles.old

dotfiles.old

My OS X / Ubuntu dotfiles. ...


Top Contributors

holman SpaceK33z memborsky kirelagin jacobwgillespie pcasaretto victorklos metheon christianbundy mdamien AchoArnold dplarson ghuntley jawshooah grawity paulcbetts zpao prathe rcarver ncolton rmcastil mrsimo mazurov rc5hack bsaf drock oieduardorabelo alias-mac Crunch09 ticky