Skip to main content

A simple dotfile synchronization helper

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

recnys-0.5.0.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

recnys-0.5.0-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

Details for the file recnys-0.5.0.tar.gz.

File metadata

  • Download URL: recnys-0.5.0.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for recnys-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a97ef55152f1de38de5edd795950cc0aa53ba8f64448750c9403cc24fd75981e
MD5 6cb2b328d6994acf2df15325df7b250b
BLAKE2b-256 a638a765c54d15fd67fc863b4053a163cf6aea103137789b322082d9baf57e27

See more details on using hashes here.

File details

Details for the file recnys-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: recnys-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 25.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for recnys-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 06f8ccfb3cf8bdd1d0daa05d6236ef205599920899ab865e2df462ea48b32d14
MD5 873082485d304f7c56a51237461eaef4
BLAKE2b-256 1c7d4b542dd27abe87ba7fa17602cdd33efae8b5c04239dc3b59512b243de1f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page