Dotfiles

Cloning

Base repo (recommended)

This clone step is based on the tutorial at https://www.atlassian.com/git/tutorials/dotfiles.

Clone dotfiles to ~/.config/dotfiles and build a work tree in $HOME:

git clone --bare https://git.ynnx.eu/yannik/dotfiles.git ~/.config/dotfiles
git --git-dir="$HOME/.config/dotfiles" --work-tree="$HOME" checkout

Reload your ZSH, so the newly added files are loaded. You can now use the

dotfiles

command to interact with the git directory.

When you use

dotfiles status

, you see all the files in your home directory are untracked. To prevent this, run

dotfiles config --local status.showUntrackedFiles no

Stow (alternate)

If you are unfamiliar with bare repos or you don't want a command aliased to git, you can also use GNU Stow. Stow automatically links files or directories from the stow-dir to your dotfiles folder.

First, you need to install Stow, if it isn't already installed:

sudo pacman -S stow  # arch-based systems OR
sudo apt install stow  # Debian-based systems (like Ubuntu) OR
sudo dnf install stow  # RPM-based systems (like Fedora, CentOS, SUSE)

Clone dotfiles to ~/.dotfiles:

git clone https://git.ynnx.eu/yannik/dotfiles.git .dotfiles

Now you can stow the files:

cd dotfiles
stow -v .

This creates symlinks to all files in this stow-dir. You can get an error message when files already exist in your home dir. Rename those files with

mv ~/file-with-error ~/file-with-error.bak

and try stow again. Now you can compare those backupped files with the new ones and extend these as you like.

Modules

fzf

If your zsh startes with the message unknown option: --zsh, your fzf version is too old. Install fzf with version 0.48.1 or later.

You can download fzf from junegunn/fzf.

Extract the tar.gz file and copy fzf to /usr/local/bin or any location on your $PATH.

tmux

Tmux-plugin-manager TPM writes its plugins to $XDG_CONFIG_HOME/tmux/plugins/. As we stow our config to $XDG_CONFIG_HOME/tmux/, too, we must create this directory before stow-ing, so only the tmux.conf is a symlink. This is not needed when using recommended base-repo install.

mkdir $XDG_CONFIG_HOME/tmux  # before stowing