yolk_dots

Install v0.0.13

Published on Dec 18 2024 at 21:57 UTC

View all installation options

Yolk – Painfree Templated Dotfile Management

Yolk is a dotfile management tool with a unique spin on templating, sitting somewhere in between GNU Stow and chezmoi.

Have a look at our documentation for more information on how to get started!

WARNING

This is beta-quality software. In its current state, be careful trying this. Always make backups of everything before trying to use yolk, until it's in a stable state.

The Concept

Yolk allows you to use simple templates in your configuration files without having to worry about keeping a separate template file and the generated config file in sync. This is achieved through a design that allows all templates to be included inside comments in your actual configuration file.

Let's demonstrate:

# Use a different font on one host
# {% if SYSTEM.hostname == "epic-desktop" %}
font="Fira Code"
# {% else %}
#<yolk> font="Iosevka"
# {% end %}

[colors]
# Load your colors from your yolk configuration
background="#282828" # {< replace_color(data.colors.background) >}
foreground="#ebdbb2" # {< replace_color(data.colors.foreground) >}

Yolk will now be able to run the corresponding modifications on the file itself, allowing you to set templated values while keeping the template directly in the same file.

User Configuration

Yolk template expressions and configuration are written in the Rhai scripting language. You can provide custom data to use in your templates via the yolk.rhai file in your yolk directory, which allows you to fetch data dynamically from your system, or reference different static data depending on your system.

Version Control

How does this work with git? Given that the concrete files in use on your system may be different across machines, adding those to version control directly would result in a lot of merge conflicts frequently. Yolk solves this by only commiting a "canonical" version of your templates, generated right before you commit. This means that the version of your configuration seen in git will always be generated from a consistent, stable context.