OCD

Organize current dotfiles.

This tool provides a way to manage the user's dotfiles through a cluster. A cluster is a group of repositories that can be deployed together. Upon deployment, the user can issue Git commands interactively to manage their dotfiles within a given repository apart of their cluster.

Installation

Make sure you have the following pieces of software already installed before attempting to install OCD itself:

• Git [>= 2.30.0]
• Rust [>= 2021 Edition]

Through Cargo simply type the following into your terminal:

cargo install ocd --locked

Currently, there are no packaged version of OCD for major Linux distributions, but hopefully that will change as OCD becomes more mature. Finally, you can also directly build the project yourself by cloning and using Cargo.

Usage

See usage guide.

Acknowledgements

• Arch Linux Wiki page about dotfiles, which provided a great introduction about using Git to manage dotfiles using the bare-alias technique.
• Richard Hartmann's vcsh and myrepos tools, which generally provided the overall look and feel of OCD's command set.

Contribution

The OCD coding project is open to contribution.

See the contribution guidelines for more information about contributing to the project.

License

The OCD project abides by the MIT license for distribution of its source code and documentation. The project also uses the CC0-1.0 license to place files in the public domain, which are considered to be to small, or to generic to place copyright over.

The project uses the REUSE 3.3 specification to make it easier to determine who owns the copyright and licensing of any given file in the codebase. The Developer Certificate of Origin version 1.1 is also used to ensure that any contributions made have the right to be merged into the project, and can be distributed with the project under its main licenses.