deez

[!DANGER]

Work In Progress.

Same idea as GNU Stow or chezmoi, but way simpler, requiring less neuron activation to use.

Usage

The root (current working directory unless specified), will be mapped to $HOME. deez will copy any file it finds under the root to a matching file in $HOME.

• In sync mode, the files are copied and the target files overridden.
• In link mode, symlinks are created to the files in the root.

No special heuristics are planned outside of templates (find a less intimidating name for that).

Maybe add deez diff, that diffs the two versions (using the diff executable, or settable through an env variable), nothing fancy or homemade. Maybe there's a crate for this?

$ tree
.
├── .config
│   ├── alacritty
│   │   └── alacritty.toml
│   ├── fish
│   │   └── config.fish
│   ├── ghostty
│   │   ├── config
│   │   └── ssh.txt
│   └── nvim
│       └── init.vim
├── .gitconfig
└── .tmux.conf

$ deez --help
deez sync|link [<root>]

$ deez sync
Copies the files to the $HOME directory.
Also creates any missing directories.

$ deez link
Creates symlinks to the files in $HOME.
Also creates any missing directories.

$ deez sync somedir
Will treat `somedir` as the root instead of using `cwd`.

• Respects .gitignore.
• Warns (asks confirmation) in link mode if a target file exists and it's not a symlink (meaning we'd override a file with a symlink). One or more existing config files would be replaced by a symlink, continue?.
• Warns (asks confirmation) in sync mode if a target symlink exists where we'd put a file.

Templating

Sometimes you don't want to replace the whole config file, just a part of it. For example, in config.fish you may have generic fish config, but you also want a variable per-machine section.

With deez you can achieve this by creating a template section in the target config file (won't work in link mode).

# <%deez-template%>

This section will be overridden/updated by the `deez` config file.

# </%deez-template%>

Outside of the template won't be touched.

• Only one template opening is allowed per file.
• Only one template closing is allowed per file.
• If there's an opening there must be a closing.
• If there's a closing there must be an opening.