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
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.
- To install RDFM you can either:
- Recommended Build the project from source
cargo install rdfm
- Download the latest binary from the releases page
Setting up rdfm
RDFM can be set up with the command
rdfm setup, that will create a
~/.dotfiles/ directory and a
You can add dotfiles to the
~/.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 $
To remove dotfiles from
~/.dotfiles/dotfiles.rdfm, you can use the
rdfm remove $pattern command that will remove every line containing one or more occurences of
To proceed linking and copy your dotfiles to the
~/.dotfiles folder, you'll use the
rdfm proceed command.
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` $
- There are a few rules that contributors may respect:
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.
cargo build --release.
- Add the produced binary somewhere in your $PATH.