/.dotfiles

mirror of https://git.tobyvin.dev/.dotfiles

Primary LanguageLuaMIT LicenseMIT

tobyvin's .dotfiles

Install

git clone https://git.tobyvin.dev/.dotfiles && ./.dotfiles/install.sh

Getting started

The configuration files are managed using GNU stow and the dotfiles can be installed solely by running stow */ from the repository's root.

Install script

A install.sh helper script is provided that will stow packages, remove broken symlinks, and run package specific install scripts. The install script can be run with ./install.sh [package ..], defaulting to operating on all packages if none are specified.

Removing broken symlinks

The install script will do it's best to clean broken symlinks from the target directory. It's fairly strict about what it will remove, erroring on the side caution, as to not remove any symlinks that do (or did) not belong to the repository.

Package specific install scripts

The install script will run any package specific install scripts that exist in the root of a package directory, e.g. ./<pkgname>/install.sh.

Example usecases:

  • Creating non-existent directories
  • Enabling systemd user services
  • Fixing file permissions
  • Running one-time setup commands
  • etc.
Example package install script
#!/bin/sh

pkgname=<pkgname>

if ! command -v "$pkgname" >/dev/null; then
 printf '%s: %s not found, skipping...\n' "$0" "$pkgname"
 exit 0
fi

mkdir -pv "${XDG_CACHE_HOME}/${pkgname}"

printf "%s: Installing service\n" "$0"
systemctl --user enable --now --no-block "${pkgname}.service"

More examples: zsh, pass, and nvim

Mirrors

I host this repository (and many others) on my local cgit instance, but it is also mirrored to both SourceHut and GitHub.