noahpendleton/dotfiles repository overview

⁠Dotfiles

• Dotfiles⁠
  • Install dotfiles⁠
  • Feature highlight⁠
  • Customization⁠
    • ~/.gitconfig -> ~/.gitconfig-local⁠
    • Multiple github ssh keys⁠
    • ~/.zshrc -> ~/.zshrc_local⁠
    • ~/.ssh/config⁠
  • Manual steps⁠
    • alacritty⁠
    • direnv⁠
      • direnv virtualenvs⁠
    • fd⁠
    • font⁠
    • fzf⁠
    • git-status-tree⁠
    • ripgrep⁠
    • python virtualenv⁠
    • vs code multi cursor⁠
    • ydiff⁠
  • Reference⁠
    • cyrus-gdb⁠

⁠Install dotfiles

Run

# just set up symlinks
./install

# or to also install apt/zsh plugins/vscode extensions
DOTFILES_INSTALL_ALL=y ./install

That won't overwrite any existing dotfiles. You'll have to relocate any collisions manually before running the install script if you want the ones in this repo (see install.conf.yaml⁠ for which links are added).

⁠Feature highlight

This is mostly used for me to sync prompt configuration/plugins and .gdbinit/vimrc between computers.

Rough list of features (might not be updated):

• oh-my-zsh (zsh plugin framework and lots of aliases)
• powerlevel10k (fast zsh prompt theme)
• cyrus gdb dashboard (featureful gdb dashboard)
• tmux config
• vimrc (I use it with neovim but might work with vim8 no idea)

Probably the most opinionated thing is the powerlevel10k config.. see zsh/.p10k.zsh⁠ for customizing. That theme also has a customization wizard, see https://github.com/romkatv/powerlevel10k⁠ . It also updates a lot so this might break... definitely make an issue if it fails for you!

⁠Customization

Fork this repo :grinning: .

There are a few spots where I insert host-specific configs.

⁠~/.gitconfig -> ~/.gitconfig-local

To specify local host settings, the ~/.gitconfig⁠ will include ~/.gitconfig-local. I use this to apply certain user name+email settings based on file system location (see https://git-scm.com/docs/git-config#_conditional_includes⁠):

# in ~/.gitconfig-local:
[user]
    name = Noah Pendleton

[includeIf "gitdir:~/dev/work/"]
    path = ~/dev/work/.gitconfig
[includeIf "gitdir:~/dev/github/"]
    path = ~/dev/github/.gitconfig

# in ~/dev/work/.gitconfig:
[user]
    email = [email protected]

# in ~/dev/github/.gitconfig:
[user]
    email = [email protected]

After you set this up, you can verify it with git config --list.

⁠Multiple github ssh keys

If you want to use a separate key for git operations to a github organization, this is one way to do it; override the ssh command for a particular directory.

In the work-specific directory's gitconfig (eg ~/dev/work/.gitconfig):

[core]
    sshCommand = "ssh -i ~/.ssh/id_rsa.work"

Note that if you use GIT_SSH_COMMAND to enable debug etc. you'll also need to provide the key argument. And this won't help with cloning outside of that directory 😕.

⁠~/.zshrc -> ~/.zshrc_local

The ~/.zshrc⁠ file will source a file ~/.zshrc_local near the end, where I apply host-specific settings.

⁠~/.ssh/config

This file is not tracked in my dotfiles repo, because it's host-specific.

Just documenting what I do here as a reference, for selecting the correct ssh keys for a host, set up ~/.ssh/config:

# use a non-default ssh key pair for github (id_rsa.github + id_rsa.github.pub)
Host github.com
  HostName github.com
  User git
  IdentityFile ~/.ssh/id_rsa.github
  IdentitiesOnly yes

⁠Manual steps

Note- at the moment deploying this config requires a few manual steps. TODO #2 to make this more automatic.

⁠alacritty

Fast gpu-accelerated terminal emulator written in rust.

# install cargo
curl https://sh.rustup.rs -sSf | sh
# install dependencies
sudo apt install cmake libfreetype6-dev libfontconfig1-dev xclip \
    libxcb-render-util0-dev libxcb-shape0-dev libxcb-xfixes0-dev libssl-dev

# install alacritty
cargo install --git https://github.com/jwilm/alacritty
# apply in ubuntu
gsettings set org.gnome.desktop.default-applications.terminal exec 'alacritty'

# to also start tmux when starting alacritty:
gsettings set org.gnome.desktop.default-applications.terminal exec 'alacritty --command tmux'

⁠direnv

Set your environment when entering a directory, by placing a .envrc file into that directory. I'm not using this as much anymore but it can be helpful.

⁠direnv virtualenvs

direnv can also be used to select a python virtualenv based on directory location, which can be useful if you have projects that benefit from a little isolation, or require different python interpreters; it can save some typing/confusion to have dedicated virtualenvs.

I put my virtualenvs in a folder ~/.virtualenvs, so this wrapper is useful:

In the individual .envrc files, to enter a virtualenv:

# select ~/.virtualenvs/python3
layout virtualenvwrapper python3

⁠fd

Fast find replacement that honors .gitignore and hidden files by default. Way more user-friendly.

cargo install fd-find

⁠font

Powerlevel10k suggested font- https://github.com/romkatv/powerlevel10k/#recommended-meslo-nerd-font-patched-for-powerlevel10k⁠

I didn't have immediate success getting alacritty to use the Ubuntu Mono Nerd Font so I just went for the Meslo font there 🤷.

⁠fzf

Neat fuzzy searcher for terminal history and path searching.

git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
~/.fzf/install

⁠git-status-tree

Git status tree view.

sudo apt install -y ruby
# my configs assume this repo is located at ~/dev/github/git-status-tree
git clone https://github.com/knugie/git-status-tree.git

⁠ripgrep

Vastly faster grep replacement written in rust.

cargo install ripgrep

⁠python virtualenv

Somewhat tidier python environment management to avoid polluting system python with all those rando pypi packages you love so much.

sudo apt install python-pip

# this adds the virtualenv command to ~/.local/bin . using pip will get the
# normal virtualenv utility, not the weird debian patched one
pip install --user virtualenv

# set up default env for our ~/.zshrc to activate on new shells
virtualenv --clear ~/.virtualenvs/default

⁠vs code multi cursor

gsettings set org.gnome.desktop.wm.preferences mouse-button-modifier "<Super>"

⁠ydiff

Somewhat nicer diffs, eg diff -du <file1> <file2> | ydiff

pip install ydiff

⁠Reference

⁠cyrus-gdb

Nice featureful gdb-dashboard⁠. Tracked as a submodule in this repo.

Note! if debugging shared libraries in gdb that haven't been loaded yet, be sure to run set confirm off to allow setting breakpoints on symbols that haven't yet loaded.