RDFM - The Rusty DotFiles Manager

Last update: Aug 14, 2022

Related tags

Overview

                    d8888b.   d88888b.   8888888b  8888b  d8888
                    88  `8D    88   `8D   88'       88'YbdP`88 
                    88oobY'    88    88   88ooo     88  88  88 
                    88`8b      88    88   88        88      88 
                    88 `88.    88   .8D   88        88      88 
                   d88b  d88  Y88888D'   d88b      d88b    d88b
                        
                            The Rusty DotFiles Manager.
                            Copyleft (ɔ) 2021, Wafelack

Introduction

RDFM is the Rusty DotFiles Manager, based on a homemade linking system and configured by a simple file ; it is intended for everyone who needs an easy and reliable way to manage and share dotfiles.

Roadmap

Installation

To install RDFM you can either:

Recommended Build the project from source
Run cargo install rdfm
Run bruh install rdfm
Download the latest binary from the releases page

Getting Started

In this guide, the $FOLDER variable will refer to your $XDG_CONFIG_HOME folder if it is set, or $HOME if it is not.

Setting up rdfm

RDFM can be set up with the command rdfm setup, that will create a $FOLDER/.dotfiles/ directory and a $FOLDER/.dotfiles/dotfiles.rdfm file.

Adding dotfiles

You can add dotfiles to the $FOLDER/.dotfiles/dotfiles.rdfm file with the rdfm add $src $dest command that can be used as following:

$ rdfm add ~/.vim/ vim/.vim
Successfully added `/home/wafelack/.vim/` to dotfiles as `vim/.vim`
$ cat ~/.dotfiles/dotfiles.rdfm
# This file is created by rdfm and is not intended for manual editing.
/home/wafelack/.vim/->/home/wafelack/.dotfiles/vim/.vim
$

Removing dotfiles

To remove dotfiles from $FOLDER/.dotfiles/dotfiles.rdfm, you can use the rdfm remove $pattern command that will remove every line containing one or more occurences of $pattern.

Proceeding linking

To proceed linking and copy your dotfiles to the $FOLDER/.dotfiles folder, you'll use the rdfm proceed command.

Pulling dotfiles

To pull dotfiles from an external repo, you can use rdfm pull $repo as following:

$ rdfm pull https://github.com/wafelack/dotfiles
Successfully pulled `https://github.com/wafelack/dotfiles` into `~/.dotfiles`
$

Contributing

There are a few rules that contributors may respect:
1. Format your code using cargo fmt.
2. Follow the commit rule, gitmoji.dev or at least conventional commits.
3. Use semantic versioning
4. All submited code has to be working.

Legal

RDFM is distributed under the GNU Affero General Public License version 3.0 (AGPL-3.0) as described in the LICENSE file.

Build from source

Clone the project: git clone [email protected]:Wafelack/rdfm.git.
cd in rdfm/ and run cargo build --release.
Add the produced binary somewhere in your $PATH.

Comments

[Improvement] Default target name

By default it might be nice that the $dest of the add command is just the same directory relative to home. That is, instead of specifying rdfm add .vimrc .vimrc it could by default infer the destination from rdfm add .vimrc. Typically I'll want to use the destination file that reflects the structure in my home directory.
enhancement

opened by rutrum 3
[Improvement] Support XDG Base Directory

XDG Base Directory standard[1][2] defines a relocatable dotfile directory that keeps the home directory less cluttered. It would be great if rdfm supported reading this environment variable, and using that path if present.
enhancement

opened by pandruszkow 2
Add Cargo.lock

Hey! You need to commit Cargo.lock file because it's a binary project. See more info here: https://doc.rust-lang.org/cargo/faq.html#why-do-binaries-have-cargolock-in-version-control-but-not-libraries Also you can remove it from .gitignore: https://github.com/Wafelack/rdfm/blob/master/.gitignore#L2

opened by orhun 1
[enhancement] A «reverse proceed» on pull

Hello,

It would be great if a «reverse proceed» happens on dotfile pull, id est, transfering the content of the ~/.dotfiles/ folder to the $XDG_CONFIG_HOME or $HOME folder.

Regards, Wafelack.
enhancement

opened by Wafelack 1
[Bug] Accidental remove of newlines when using remove command
This should reproduce my issue from a new install.

rdfm setup rdfm add .vimrc .vimrc rdfm add .vimrc vim/.vimrc rdfm remove vim/.vimrc

That produces a rdfm file that appears invalid.

$ cat .dotfiles/dotfiles.rdfm # This file is created by rdfm and is not intended for manual editing..vimrc->/home/rutrum/.dotfiles/.vimrc

That is, there are no newlines in the file anymore.
bug
opened by rutrum 1