# dotdrop

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/deadc0de6/dotdrop)](https://github.com/deadc0de6/dotdrop/releases/latest) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![GitHub Repo stars](https://img.shields.io/github/stars/deadc0de6/dotdrop?style=social)](https://github.com/deadc0de6/dotdrop/) [![Tests Status](https://github.com/deadc0de6/dotdrop/workflows/tests/badge.svg)](https://github.com/deadc0de6/dotdrop/actions) [![Doc Status](https://readthedocs.org/projects/dotdrop/badge/?version=latest)](https://dotdrop.readthedocs.io/en/latest/?badge=latest) [![Coveralls](https://img.shields.io/coveralls/github/deadc0de6/dotdrop)](https://coveralls.io/github/deadc0de6/dotdrop?branch=master) [![LGTM Grade](https://img.shields.io/lgtm/grade/python/github/deadc0de6/dotdrop?label=code%20quality)](https://lgtm.com/projects/g/deadc0de6/dotdrop/context:python) [![Python](https://img.shields.io/pypi/pyversions/dotdrop.svg)](https://pypi.python.org/pypi/dotdrop) [![PyPI](https://img.shields.io/pypi/v/dotdrop)](https://badge.fury.io/py/dotdrop) [![Homebrew version](https://img.shields.io/homebrew/v/dotdrop)](https://formulae.brew.sh/formula/dotdrop) [![AUR](https://img.shields.io/aur/version/dotdrop.svg)](https://aur.archlinux.org/packages/dotdrop) [![Donate](https://img.shields.io/badge/donate-KoFi-blue.svg)](https://ko-fi.com/deadc0de6) *Save your dotfiles once, deploy them everywhere* [Dotdrop](https://github.com/deadc0de6/dotdrop) makes the management of dotfiles between different hosts easy. It allows you to store your dotfiles in Git and automagically deploy different versions of the same file on different setups. It also allows you to manage different *sets* of dotfiles. For example, you can have a set of dotfiles for your home laptop and a different set for your office desktop. Those sets may overlap, and different versions of the same dotfiles can be deployed using different predefined *profiles*. Or you may have a main set of dotfiles for your everyday host and a subset you only need to deploy to temporary hosts (cloud VM etc.) that may be using a slightly different version of some of the dotfiles. Features: * Sync once every dotfile in Git for different usages * Allow dotfile templating by leveraging [Jinja2](https://palletsprojects.com/p/jinja/) * Dynamically generated dotfile contents with pre-defined variables * Comparison between deployed and stored dotfiles * Handling multiple profiles with different sets of dotfiles * Easily import and update dotfiles * Handle files and directories * Support symlinking of dotfiles * Associate actions to the deployment of specific dotfiles * Associate transformations for storing encrypted/compressed dotfiles * Provide solutions for handling dotfiles containing sensitive information Also check out the [blog post](https://deadc0de.re/articles/dotfiles.html), the [example](#getting-started), the [documentation](https://dotdrop.readthedocs.io/) or how [people are using dotdrop](https://dotdrop.readthedocs.io/en/latest/misc/people-using-dotdrop/) for more. Quick start: ```bash mkdir dotfiles && cd dotfiles git init git submodule add https://github.com/deadc0de6/dotdrop.git pip3 install -r dotdrop/requirements.txt --user ./dotdrop/bootstrap.sh ./dotdrop.sh --help ``` A mirror of this repository is available on GitLab under . ## Why dotdrop? There exist many tools to manage dotfiles; however, not many allow you to deploy different versions of the same dotfile on different hosts. Moreover, dotdrop allows you to specify the set of dotfiles that need to be deployed for a specific profile. See the [example](#getting-started) for a concrete example of why [dotdrop](https://github.com/deadc0de6/dotdrop) rocks. --- **Table of Contents** * [Installation](#installation) * [Getting started](#getting-started) * [Documentation](#documentation) * [Thank you](#thank-you) # Installation There are multiple ways to install and use dotdrop. It is recommended to install dotdrop [as a submodule](#as-a-submodule) to your dotfiles Git tree. Having dotdrop as a submodule guarantees that anywhere you are cloning your dotfiles Git tree from you'll have dotdrop shipped with it. The below instructions show how to install dotdrop as a submodule. For alternative installation instructions, see the [installation documentation](https://dotdrop.readthedocs.io/en/latest/installation/). Dotdrop is also available on: * PyPI: https://pypi.org/project/dotdrop/ * Homebrew: https://formulae.brew.sh/formula/dotdrop * AUR (stable): https://aur.archlinux.org/packages/dotdrop/ * AUR (git version): https://aur.archlinux.org/packages/dotdrop-git/ * Snapcraft: https://snapcraft.io/dotdrop * pacstall: https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript ## As a submodule The following will create a git repository for your dotfiles and keep dotdrop as a submodule: ```bash ## create the repository $ mkdir dotfiles; cd dotfiles $ git init ## install dotdrop as a submodule $ git submodule add https://github.com/deadc0de6/dotdrop.git $ pip3 install -r dotdrop/requirements.txt --user $ ./dotdrop/bootstrap.sh ## use dotdrop $ ./dotdrop.sh --help ``` For macOS users, make sure to install `realpath` through Homebrew (part of *coreutils*). Using dotdrop as a submodule will require you to work with dotdrop by using the generated script `dotdrop.sh` at the root of your dotfiles repository. Note that this script updates the submodule automatically unless called with the environment variable `DOTDROP_AUTOUPDATE` set to `no`. To ease the use of dotdrop, it is recommended to add an alias to it in your shell (*~/.bashrc*, *~/.zshrc*, etc.) with the config file path, for example: ``` alias dotdrop=' --cfg=' ``` Completion scripts exist for `bash`, `zsh` and `fish`; see [the related doc](completion/README.md). # Getting started [Create a new repository](https://dotdrop.readthedocs.io/en/latest/repository-setup/) to store your dotfiles with dotdrop. *Init* or *clone* that new repository and [install dotdrop](https://dotdrop.readthedocs.io/en/latest/installation/#as-a-submodule). Then import any dotfiles (files or directories) you want to manage with dotdrop. You can either use the default profile (which resolves to the *hostname* of the host you are running dotdrop on) or provide it explicitly using the switch `-p`/`--profile`. Import dotfiles on host *home*: ```bash $ dotdrop import ~/.vimrc ~/.xinitrc ~/.config/polybar ``` Dotdrop does two things: * Copy the dotfiles to the *dotpath* directory (defined in `config.yaml`, defaults to *dotfiles*) * Create the associated entries in the `config.yaml` file (in the `dotfiles` and `profiles` entries) Your config file will look like something similar to this: ```yaml config: backup: true banner: true create: true dotpath: dotfiles ignoreempty: false keepdot: false longkey: false showdiff: false workdir: ~/.config/dotdrop dotfiles: d_polybar: dst: ~/.config/polybar src: config/polybar f_vimrc: dst: ~/.vimrc src: vimrc f_xinitrc: dst: ~/.xinitrc src: xinitrc profiles: home: dotfiles: - f_vimrc - f_xinitrc - d_polybar ``` For a description of the different fields and their use, see the [config doc](https://dotdrop.readthedocs.io/en/latest/config-format/). Commit and push your changes with git. Then go to another host where your dotfiles need to be managed as well, clone the previously set up repository, and compare the local dotfiles with the ones stored in dotdrop: ```bash $ dotdrop compare --profile=home ``` Now you might want to adapt the `config.yaml` file to your liking on that second host. Let's say, for example, that you only want `d_polybar` and `f_xinitrc` to be deployed on that second host. You would then change your config to something like this (assuming that the second host's hostname is *office*): ```yaml … profiles: home: dotfiles: - f_vimrc - f_xinitrc - d_polybar office: dotfiles: - f_xinitrc - d_polybar ``` Then adapt any dotfile using the [templating](https://dotdrop.readthedocs.io/en/latest/templating/) feature (if needed). For example, you might want different fonts sizes in Polybar for each host. Edit `/config/polybar/config`: ```bash … {%@@ if profile == "home" @@%} font0 = sans:size=10;0 {%@@ elif profile == "office" @@%} font0 = sans:size=14;0 {%@@ endif @@%} font1 = "Material Design Icons:style=Regular:size=14;0" font2 = "unifont:size=6;0" … ``` You also want to have the correct interface set on the wireless network in the Polybar config. Add a [variable](https://dotdrop.readthedocs.io/en/latest/config/#variables) to the config file (In the below example, *home* gets the default `wlan0` value for the variable `wifi` while *office* gets `wlp2s0`): ```yaml … variables: wifi: "wlan0" … profiles: home: dotfiles: - f_vimrc - f_xinitrc - d_polybar office: dotfiles: - f_xinitrc - d_polybar variables: wifi: "wlp2s0" ``` Then you can adapt the Polybar config file so that the variable `wifi` gets correctly replaced during installation: ```bash [module/wireless-network] type = internal/network interface = {{@@ wifi @@}} ``` Also, the home computer is running [awesomeWM](https://awesomewm.org/), and the office computer [bspwm](https://github.com/baskerville/bspwm). The `~/.xinitrc` file will therefore be different while still sharing some lines. Edit `/xinitrc`: ```bash #!/bin/bash # load Xresources userresources=$HOME/.Xresources if [ -f "$userresources" ]; then xrdb -merge "$userresources" & fi # launch the wm {%@@ if profile == "home" @@%} exec awesome {%@@ elif profile == "office" @@%} exec bspwm {%@@ endif @@%} ``` Finally you want everything installed with the *office* profile to be logged; you thus add an action to the config file: ```yaml … actions: loginstall: "echo {{@@ _dotfile_abs_src @@}} installed to {{@@ _dotfile_abs_dst @@}} >> {0}" … profiles: home: dotfiles: - f_vimrc - f_xinitrc - d_polybar office: dotfiles: - f_xinitrc - d_polybar variables: wifi: "wlp2s0" actions: - loginstall "/tmp/dotdrop-installation.log" ``` When done, you can install your dotfiles using: ```bash $ dotdrop install ``` If you are unsure, you can always run `dotdrop compare` to see how your local dotfiles would be updated by dotdrop before running `install` or you could run install with `--dry`. That's it, a single repository with all your dotfiles for your different hosts. For more, see the [docs](https://dotdrop.readthedocs.io): * [Create actions](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-actions) * [Use transformations](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-transformations) * [Use variables](https://dotdrop.readthedocs.io/en/latest/config/#variables) * [Symlink dotfiles](https://dotdrop.readthedocs.io/en/latest/config/#symlink-dotfiles) * [and more](https://dotdrop.readthedocs.io/en/latest/howto/howto/) # Documentation Dotdrop's documentation is hosted on [Read the Docs](https://dotdrop.readthedocs.io/en/latest/). # Thank you If you like dotdrop, [buy me a coffee](https://ko-fi.com/deadc0de6). # Contribution If you are having trouble installing or using dotdrop, [open an issue](https://github.com/deadc0de6/dotdrop/issues). If you want to contribute, feel free to do a PR (please follow PEP8). Have a look at the [contribution guidelines](https://github.com/deadc0de6/dotdrop/blob/master/CONTRIBUTING.md). # License This project is licensed under the terms of the GPLv3 license.