Introduction

Here lies my dotfiles. But these are not ordinary dotfiles. It is more like an artisanal package manager of sorts. Each "package" is a script that will install a component locally (in ~/.local) as well as the corresponding config ~/.config.

But why? you may ask 🤔

1. Because I can 🤓.
2. Because I often work remotely on servers where I do not have root access. And this package manager is a way to gain back control.
3. Because I always get the exact version I want regardless of the underlying distribution / package manager.
4. Because I can restart from scratch by removing ~/.local and ~/.config and rerun one command to get back to a clean known state.

And why not use nix then? because using nix without root access is a pain in the 🤡, otherwize it would be 🥇.

CAUTION: this is highly experimental! Use are your own risk ⚠

Installation

The short way

eval "$(curl https://raw.githubusercontent.com/meuter/dotfiles/main/install.sh)"

The long way

Just clone the repo, then source bootstrap.sh in your ~/.bashrc:

git clone https://github.com/meuter/dotfiles ~/.dotfiles/
echo ". ~/.dotfiles/bootstrap.sh" >> ~/.bashrc
. ~/.dotfiles/bootstrap.sh

You then have access to a dedicated dotfiles command:

❯ dotfiles
Usage:
    dotfiles <command>

Available Commands:
    list                  list available packages
    list_installed        list installed packages
    check                 check all packages
    install               install packages
    uninstall             uninstall packages
    help                  print this help message

Examples:
    dotfiles install neovim tmux

Structure of a Package

function dependencies() {
    # This function returns (prints to stdout) the list of packages
    # that should be installed before this package. Note that there
    # are no transitive dependencies here. *ALL* dependencies and
    # their dependencies, and their dependencies, etc. should be
    # specified here.
    #
    # NOTE: this function is optional
    echo ""
}

function install_package() {
    # This function is used to install the package. It will be executed
    # in a dedicated subshell, so no need to be a good citizen here
    # (for the cwd for instance). The subshell in which the function
    # is executed will be configured with `set -eou pipefile`. Therefore
    # if it fails on any command, the execution will halt and
    # an error message will be displayed.
    #
    # NOTE: this function is mandatory
    echo -n
}

function uninstall_package() {
    # This function is used to uninstall the packages. It will be
    # executed in the exact same way as `install_pakage`.
    #
    # NOTE: this function is mandatory
    echo -n
}

function init_package() {
    # This function is used to initialize the package during the
    # bootstrap phase (will be called from ~/.bashrc via bootstrap.sh).
    # This function will also be called directly after installation
    # so that any environment variable is propagated to the next package
    # in the list that will be installed.
    # Beware that this function is executed in the main shell, it should
    # therefore be a good citizen, e.g. not change the cwd.
    #
    # NOTE: this function is optional
    echo -n
}

function uninit_package() {
    # This function is used to un-initialize the package after it is
    # uninstalled to e.g. remove alias, cleanup environment variables, ...
    # Beware that this function is executed in the main shell, it should
    # therefore be a good citizen, e.g. not change the cwd.
    #
    # NOTE: this function is optional
    echo -n
}

Package Examples

neovim

function install_package() {
    # version info
    local version=0.9.5
    local tarball=nvim-linux64.tar.gz
    local checksum=9edfa4d46fc382ca90e8c4c84c2e8c73

    # download tarball
    curl -L https://github.com/neovim/neovim/releases/download/v${version}/${tarball} --output /tmp/${tarball}

    # check tarball
    if [ "${checksum}" != $(md5sum /tmp/${tarball} | awk '{print $1}') ]; then
        >&2 echo Unexpected checksum
        return 1
    fi

    # extract tarball
    tar xvf /tmp/${tarball} --strip-components=1 -C ${DOTFILES_PREFIX}
    rm -rf /tmp/${tarball}
}

function uninstall_package() {
    # remove all nvim files
    rm -rvf \
        ${DOTFILES_SHARE}/nvim/ \
        ${DOTFILES_BIN}/nvim \
        ${DOTFILES_LIB}/nvim \
        ${DOTFILES_MAN}/man1/nvim.1
    rm -vf \
        $(find ${DOTFILES_SHARE} -name "*nvim*")
    unalias vim
}

function init_package() {
    alias vim=nvim
}

function uninit_package() {
    unalias vim
}