Dotfiles

After cloning this repo, run install to automatically set up the development environment. Note that the install script is idempotent: it can safely be run multiple times.

Dotfiles uses Dotbot for installation.

Programs

Dotfiles assumes you have the following programs installed for some aliases / plugins:

curl
fzf
gitui
kitty
ripgrep
terraform
vim or neovim (aliased to vim)

Optional programs that will enable additional aliases if installed:

Plugins / Submodules

Dotfiles uses the following plugins and submodules for different programs:

git: git-open
vim: tabular
vim: vim-log-highlighting
vim: vim-ripgrep
vim: vim-terraform
vim: vimrc
zsh: ohmyzsh
zsh: spaceship-prompt
zsh: spaceship-vi-mode
zsh: zgen
zsh: zsh-autosuggestions
zsh: zsh-syntax-highlighting

Making Local Customizations

You can make local customizations to some programs by editing these files:

git: ~/.gitconfig_local
kitty: ~/.config/kitty/local.conf
sh: ~/.alias_local
sh: ~/.env_local
sh: ~/.functions_local
zgen: ~/.zgen_before run before zgen
zgen: ~/.zgen_after run after zgen save
zsh: ~/.zprofile_local run after .zprofile
zsh: ~/.zshrc_local run after .zshrc

See my dotfiles-local for an example.

Inspiration

Project structure, plugins, aliases, etc. took inspiration from the following repositories:

License

This software is hereby released into the public domain. That means you can do whatever you want with it without restriction. See LICENSE.md for details.