Dotfiles

This is a system to install various dotfiles (.bashrc, .zshrc, helix/config.toml, etc.) to a configured location using symlinks.

Example Configuration

Check out configs/hx/dotfile.toml for an example. The current dotfile.toml spec is as follows:

# Display name of the configuration, required.
name = "sample"

# Description of the configuration, required.
description = "dotfile configuration for sample"

# Pre-validations to run, these will be run against the PATH variable.
validation-commands = [
    ["git", "--help"],
    ["cargo", "--version"],
]

# Array of configurations, you can have as many configurations as you
# want here. Each `configs` section corresponds to a separate file to be symlinked.
[[configs]]

# Display name of this file to be symlinked, optional.
name = "samplerc"

# Path within the configuration directory, required.
path = ".samplerc"

# Installation path, required.
# Environment variables "$VAR/path/after/var" will be expanded
# Tilde "~/path/in/home/dir" will also be expanded
install_location = "~/.samplerc"

# Create another configuration file definition
[[configs]]
name = "otherrc"
path = ".otherrc"

# You can specify platform-specific locations to install
# Currently supported platforms: [windows, linux, macos]
# You can omit certain platforms if you don't want to
# use this `dotfile.toml` in that platform.
[configs.install_location]
windows = "$APPDATA/some/path/.otherrc"
linux = "~/.config/some/path/.otherrc"
macos = "~/.config/some/path/.otherrc"

Installation

Build from source

git clone https://github.com/EDToaster/dotfiles.git
cd dotfiles
cargo install --path .

Running dotfiles

Examples:

Run validations on configs/hx

dotfiles configs/hx

Run installation on configs/hx

dotfiles -i configs/hx