My dotfiles and config files for zsh, nvim, git, tmux, etc.
This repo uses the bare git repository approach from https://www.atlassian.com/git/tutorials/dotfiles (also https://news.ycombinator.com/item?id=11070797 ) to avoid symlinking dotfiles all over my home directory. I used to use a symlink folder approach which worked well for years, but setup on a new machine was always a pain point. The older approach (and longer file history) can be found in the symlink-dir branch of this repo.
One thing that's important to me in my dotfile setup is to allow machine-specific extension points. The core configs need to be easy to reuse on my home machines and work machines, but they need to allow for machine-specific differences: different aliases and paths, shortcuts and scripts, different git username/email, and so on.
Install:
curl -fsSL https://github.com/kjhaber/dotfiles/raw/main/.config/meta/install/install.sh | zsh
More manually:
- Clone bare git repository with work tree set to $HOME directory, and set up aliases to work with this git repo.
cd ~
git clone --bare https://github.com/kjhaber/dotfiles "$HOME/.config/meta/repo"
alias gitdotfile='git --git-dir=$HOME/.config/meta/repo/ --work-tree=$HOME'
gitdotfile checkout
gitdotfile config --local status.showUntrackedFiles no
-
Restart zsh, or start a new zsh sub-shell. This will load the zsh configs in this repo, which includes some install scripts for asdf, node, vim-plug, tpm (tmux plugin manager), etc. which are used by other areas of the config.
-
Open
nvim. Most vim plugins and themes should already be loaded, but coc.nvim may autoload its plugins. Run:PU(alias forPlugUpdate | PlugUpgrade) to install all vim-plug plugins - this should show everything is "Already up to date". Exit from nvim (how to do that is an exercise left to the reader, ha). -
Verify that tmux plugins are installed. Install tmux plugins by running
.tmux/plugins/tpm/bin/install_plugins- this should report that all plugins are already installed. Alternatively, start a tmux session and type<tmux-action-key>Ito update plugins. (In this config, is set to the backtick character. I find this more comfortable than using a chorded ctrl character. To type a backtick within a tmux session, type the backtick character twice.)
The idea is to use gitdotfile alias in the place of just git in git commands to add, commit, and push changes. The gitdotfile alias still works like regular git, but copes with the repo not being in the regular .git directory in the root directory (which is the home directory in this case).
gitdotfile pull
gitdotfile push
(first time, using gitdotfile push --set-upstream origin master works)
To test changes before committing and pushing, see .config/meta/testing.
(This needs a lot more detail.) Homebrew: https://brew.sh/
- neovim
- tmux
- zsh
... lots of other things too, WIP.
Machine-specific settings are defined in ~/.config-local. Everything here is optional.
This directory in included in $PATH. Add any machine-specific scripts or executables here.
Git settings.
gitconfig-local
Sourced by ~/.gitconfig. This is a good place to put user.name and user.email settings (e.g. work vs. personal).
IntelliJ IDEA settings.
ideavimrc-local
Sourced by ~/.ideavimrc. On personal machines this is a good place to experiment with new bindings. On work machines I have mappings for our company-specific IntelliJ plugin, particularly for our internal code searching.
Neovim settings.
plugins.vim
Add machine-specific plugins. I use vim-plug, so plugin entries should follow this format. On home machines I experiment with more programming languages and other plugins, but there's no reason to include these at work.
init-before.vim
init-after.vim
Additional "vimrc" init code for the beginning/end of Neovim's regular init.vim. The init-after.vim is more useful since it allows overriding settings in init.vim. I use this on home machine for trying out new mappings, defining extra home-specific vimwiki wikis, and stuff like that.
snippets/all.snippets
Machine-specific snippets. I use vim-snippets and coc.nvim occasionally. Snippets here should follow that syntax.
ZSH settings.
aliases.zsh
path.zsh
plugins.zsh
Aliases, PATH entries, and zsh plugins specific to the machine. These are sourced by ~.zshrc, and they could contain arbitrary zsh commands - the separation into separate files is just for organization. For zsh plugin manager I use zcomet. (For a long time I happily used Antibody. When I learned it was deprecated I tried a few other zsh plugin managers. zcomet gave me the fewest problems.)
zshenv-before.zsh
zshenv-after.zsh
zshrc-before.zsh
zshrc-after.zsh
Additional zsh init code for the beginning/end of ZSH's regular .zshenv and .zshrc configs. I don't use these much, but they come in handy once in a while. One example is for setting environment variables for tools that are specific to either work or home. For example, I set GRAALVM_HOME in zshenv-after.zsh for messing with GraalVM on a personal project.
autoload/*.zsh
Additional zsh scripts that should be executed. This one's more for completeness and consistency with the main .config/zsh/autoload scripts, which is where I keep zsh scripts that I don't think are ready to be made into full-blown zsh plugins (or worth the work to do so).
tmux settings.
tmux-before.conf
tmux-plugins.conf
tmux-after.conf
Additional tmux init code specific to the machine. I don't use the -before or -plugins configs often, but I find tmux-after.conf very useful to set environment-specific colors, for example, to set a reddish "theme" on my remote development server at work. This makes my remote machine's sessions visually distinct from the blue/green "theme" of my local tmux windows. The reddish tmux theme config in my tmux-after.conf looks like this:
set -g status-bg '#7f0100'
set -g status-fg '#efefef'
set -g window-style 'fg=#b5b5b5 bg=#020102'
set -g window-active-style 'fg=#feffff bg=#120102'
set -g pane-border-style fg='#017f00',bg='#020102'
set -g pane-active-border-style fg='#feffff',bg='#120102'
MIT license