Skip to main content

The CLI to make managing your config files across systems easier.

Project description


Codacy Badge

The CLI to make managing your config files across systems easier.


ModRC makes it easy to install, manage, and sync your dotfiles or any other config across all your computers.


Installation of ModRC is easy, install it directly from PyPI.

$ pip install modrc

If you want to edit the installed code or PyPI is not available, setuptools works for installation.

$ pip install -e .

After installing with pip, run the installation command.

$ modrc setup install

This will create the ModRC directory at ~/.modrc.


ModRC consists of a number of sub-commands to manage your installatio and files. Not all commands are available/working as this project is still in Alpha. This list acts as a guideline for development, not an official list of forthcoming commands.


modrc setup
modrc setup install [(-e|--editor) <editor>] [(-u|--url) <url>] [(-p|--package) <package>] [(-c|--compile)] [(-s|--auto-sync)]
modrc setup uninstall


modrc compile [--package <package> [--file <file>]]


modrc package add [(-d | --default)] [--url <url>] <package>
modrc package remove [-y] <package>
modrc package edit [<package>]
modrc package default <package>
modrc package sync [<package>]


modrc file add <file> [<package>]
modrc file remove [-y] <file> [<package>]
modrc file edit [((-c|--compile)|(-n|--no-compile))] <file> [<package>]


modrc filter add <filter> <file> [<package>]
modrc filter remove [-y] <filter> <file> [<package>]
modrc filter edit <filter> <file> [<package>]


modrc chunk add <chunk> [<package>]
modrc chunk remove [-y] <chunk> [<package>]
modrc chunk edit <chunk> [<package>]


Testing is slightly complicated since ModRC creates and deletes files in a user's home directory. To avoid modifying files in your home directory, it is advised to run the tests in a container. To run the tests in an isolated Docker container, use the following command. It will mount the code as a volume so you dont have to re-compile the container every time the tests run.

$ ./

Project details

Download files

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

Files for modrc, version 0.4
Filename, size File type Python version Upload date Hashes
Filename, size modrc-0.4-py3-none-any.whl (4.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size modrc-0.4.tar.gz (13.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page