Skip to content

uroybd/DotR

Repository files navigation

DotR

Codecov Deps.rs Crate Dependencies (latest) GitHub License


GitHub Release GitHub Downloads (all assets, all releases) Crates.io Total Downloads

A dotfiles manager that is as dear as a daughter.

📖 Read the full documentation →

✨ Features

  • 📦 Package management — import, deploy, and update files or whole directories, individually or by profile
  • 🎭 Profiles — different packages, variables, and destinations per machine (work, home, server, ...)
  • 🔧 Variables — environment, config, package, profile, and prompt-sourced, with nested TOML structures
  • 📝 Templating — full Tera support, detected automatically, no config needed
  • Pre/post actions — run shell commands around deployment, with variable interpolation
  • 💬 Interactive prompts — ask once for secrets, remember the answer outside version control
  • 🔗 Symlink support — deploy as symlinks for live-editing workflows
  • 🧹 Clean mode — deployed directories stay in sync, stray files get removed automatically
  • 🔍 Diff & dry run — preview every change before it happens

Full details for all of the above are in the documentation.

📦 Installation

# Homebrew (macOS and Linux)
brew tap uroybd/tap
brew install dotr

# Cargo
cargo install dotr-dear

# From source
cargo install --git https://github.com/uroybd/DotR

Pre-built binaries for macOS and Linux (glibc and musl, x86_64 and aarch64) are on the releases page. See the installation guide for details.

🚀 Quick Start

DotR quick start demo

dotr init                        # initialize a repository
dotr import ~/.bashrc            # bring an existing dotfile under management
dotr deploy                      # deploy on a (new) machine
dotr diff                        # preview changes before deploying
dotr update                      # pull local edits back into the repository

See the Quick Start guide for a complete walkthrough, and the CLI reference for every command and flag.

🤝 Contributing

Issues and pull requests are welcome.

📝 License

MIT

About

A dotfiles manager that is as dear as a daughter.

Resources

License

Stars

53 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors

Languages