PyPI 官网下载 | dotdrop-0.16.0.tar.gz

# DOTDROP [](https://travis-ci.org/deadc0de6/dotdrop) [](http://www.gnu.org/licenses/gpl-3.0) [](https://coveralls.io/github/deadc0de6/dotdrop?branch=master) [](https://badge.fury.io/py/dotdrop) [](https://aur.archlinux.org/packages/dotdrop) [](https://pypi.python.org/pypi/dotdrop) *Save your dotfiles once, deploy them everywhere* Dotdrop makes the management of dotfiles between different hosts easy. It allows to store your dotfiles on git and automagically deploy different versions on different setups. 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 dotfile can be deployed on different predefined *profiles*. Another use case is when you have a main set of dotfiles for your everyday's host and a sub-set 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 on git for different usages * Allow dotfiles templating by leveraging [jinja2](http://jinja.pocoo.org/) * Comparison between local and stored dotfiles * Handling multiple profiles with different sets of dotfiles * Easy import dotfiles * Handle files and directories * Associate an action to the deployment of specific dotfiles * Associate transformations that allow to store encrypted dotfiles Check also the [blog post](https://deadc0de.re/articles/dotfiles.html), the [example](#example) or how [people are using dotdrop](#people-using-dotdrop) for more. Quick start: ```bash mkdir dotfiles && cd dotfiles git init git submodule add https://github.com/deadc0de6/dotdrop.git ./dotdrop/bootstrap.sh ./dotdrop.sh --help ``` ## Why dotdrop ? There exist many tools to manage dotfiles however not many allow to deploy different versions of the same dotfile on different hosts. Moreover dotdrop allows to specify the set of dotfiles that need to be deployed on a specific profile. See the [example](#example) for a concrete example on why dotdrop rocks. --- **Table of Contents** * [Installation](#installation) * [Usage](#usage) * How to * [Install dotfiles](#install-dotfiles) * [Compare dotfiles](#compare-dotfiles) * [Import dotfiles](#import-dotfiles) * [List profiles](#list-profiles) * [List dotfiles](#list-dotfiles) * [Use actions](#use-actions) * [Use transformations](#use-transformations) * [Update dotdrop](#update-dotdrop) * [Update dotfiles](#update-dotfiles) * [Store sensitive dotfiles](#store-sensitive-dotfiles) * [Config](#config) * [Template](#template) * [Example](#example) * [User tricks](#user-tricks) * [People using dotdrop](#people-using-dotdrop) # Installation There are two ways of installing and using dotdrop, either [as a submodule](#as-a-submodule) to your dotfiles git tree or system-wide [with pypi](#with-pypi). Having dotdrop as a submodule guarantees that anywhere your are cloning your dotfiles git tree from you'll have dotdrop shipped with it. It is the recommended way. Dotdrop is also available on aur: * stable: https://aur.archlinux.org/packages/dotdrop/ * git version: https://aur.archlinux.org/packages/dotdrop-git/ ## As a submodule The following will create a repository for your dotfiles and keep dotdrop as a submodules: ```bash $ mkdir dotfiles; cd dotfiles $ git init $ git submodule add https://github.com/deadc0de6/dotdrop.git $ sudo pip3 install -r dotdrop/requirements.txt $ ./dotdrop/bootstrap.sh $ ./dotdrop.sh --help ``` Install the requirements with: ```bash $ sudo pip3 install -r dotdrop/requirements.txt ``` For MacOS users, make sure to install `realpath` through homebrew (part of *coreutils*). Using this solution will need you to work with dotdrop by using the generated script `dotdrop.sh` at the root of your dotfiles repository. Finally import your dotfiles as described [below](#usage). ## With pypi Start by installing dotdrop ```bash $ sudo pip3 install dotdrop ``` And then create a repository for your dotfiles ```bash $ mkdir dotfiles; cd dotfiles $ git init ``` To avoid the need to provide the config file path to dotdrop each time it is called, you can create an alias: ``` alias dotdrop='dotdrop --cfg=<path-to-your-config.yaml>' ``` Replace any call to `dotdrop.sh` in the documentation below by `dotdrop` if using the pypi solution. Finally import your dotfiles as described [below](#usage). # Usage If starting fresh, the `import` command of dotdrop allows to easily and quickly get a running setup. Install dotdrop on one of your host and then import any dotfiles you want dotdrop to manage (be it a file or a directory): ```bash $ dotdrop.sh import ~/.vimrc ~/.xinitrc ``` Dotdrop does two things: * Copy the dotfiles in the *dotfiles* directory * Create the entries in the *config.yaml* file Commit and push your changes. Then go to another host where your dotfiles need to be managed as well, clone the previously setup git tree and compare local dotfiles with the ones stored by dotdrop: ```bash $ dotdrop.sh list $ dotdrop.sh compare --profile=<other-host-profile> ``` Then adapt any dotfile using the [template](#template) feature and set a new profile for the current host by simply adding lines in the config files, for example: ```yaml ... profiles: host1: dotfiles: - f_vimrc - f_xinitrc host2: dotfiles: - f_vimrc ... ``` When done, you can install your dotfiles using ```bash $ dotdrop.sh install ``` That's it, a single repository with all your dotfiles for your different hosts. For more options see `dotdrop.sh --help`. For easy deployment the default profile used by dotdrop reflects the hostname of the host on which it runs. ## Install dotfiles Simply run ```bash $ dotdrop.sh install ``` Use the `--profile` switch to specify a profile if not using the host's hostname. ## Compare dotfiles Compare local dotfiles with dotdrop's defined ones: ```bash $ dotdrop.sh compare ``` The diffing is done by diff in the backend, one can provide specific options to diff using the `-o` switch. ## Import dotfiles Dotdrop allows to import dotfiles directly from the filesystem. It will copy the dotfile and update the config file automatically. For example to import `~/.xinitrc` ```bash $ dotdrop.sh import ~/.xinitrc ``` You can control how the dotfile key is generated in the config file with the option `longkey` (per default to *false*). Two formats are available: * short format (default): take the shortest unique path * long format: take the full path For example `~/.config/awesome/rc.lua` gives * `f_rc.lua` in the short format * `f_config_awesome_rc.lua` in the long format Importing `~/.mutt/colors` and `~/.vim/colors` will result in * `d_colors` and `d_vim_colors` in the short format * `d_mutt_colors` and `d_vim_colors` in the long format ## List profiles ```bash $ dotdrop.sh list ``` Dotdrop allows to choose which profile to use with the *--profile* switch if you use something else than the default (the hostname). ## List dotfiles The following command lists the different dotfiles configured for a specific profile: ```bash $ dotdrop.sh listfiles --profile=<some-profile> ``` For example: ``` Dotfile(s) for profile "some-profile": f_vimrc (file: "vimrc", link: False) -> ~/.vimrc f_dunstrc (file: "config/dunst/dunstrc", link: False) -> ~/.config/dunst/dunstrc ``` ## Use actions It is sometimes useful to execute some kind of action when deploying a dotfile. For example let's consider [Vundle](https://github.com/VundleVim/Vundle.vim) is used to m