Recnys

Recnys is a simple dotfiles synchronization helper. I coded it primarily for personal use.

It supports Windows and Linux platforms.

It is called as "Recnys" because it is the reverse of "Syncer".

Installation

Use uv or pipx for installation:

uv tool install recnys

or

pipx install recnys

After installation, there will be two executables named recnys and syncer, with the same functionality.

Usage

Recnys requires a recnys.yaml configuration file defined in the root of the dotfile repository. This configuration file gives instructions on which files to sync, where to sync, and how to sync.

See recnys.example.yaml for detailed introduction about the configuration syntax.

Recnys supports using variables. This requires a variables.yaml file in the root of the dotfiles repository. Files that are to be rendered using these variables must have a .template suffix.

See recnys.example.yaml for the configuration syntax and variables.example.yaml for an example of variable definitions.

With configuration file correctly set, run recnys or syncer in the dotfile repository root, the synchronization will start. For example:

syncer

Recnys will prompt for confirmation request for each file's synchronization, specify -s or --skip-confirmation to disable the behavior. For example:

syncer -f

For more options, run:

syncer --help