Dotbot makes installing your dotfiles as easy as
git clone $url && cd dotfiles && ./install, even on a freshly installed system!
- Getting Started
- Directives (Link, Create, Shell, Clean, Defaults)
Dotbot is a tool that bootstraps your dotfiles (it's a [Dot]files [bo]o[t]strapper, get it?). It does less than you think, because version control systems do more than you think.
Dotbot is designed to be lightweight and self-contained, with no external dependencies and no installation required. Dotbot can also be a drop-in replacement for any other tool you were using to manage your dotfiles, and Dotbot is VCS-agnostic -- it doesn't make any attempt to manage your dotfiles.
If you want an in-depth tutorial about organizing your dotfiles, see this blog post.
Great! You can automate the creation of your dotfiles by using the user-contributed init-dotfiles script. If you'd rather use a template repository, check out dotfiles_template. Or, if you're just looking for some inspiration, we've got you covered.
Integrate with Existing Dotfiles
The following will help you get set up using Dotbot in just a few steps.
If you're using Git, you can add Dotbot as a submodule:
cd ~/.dotfiles # replace with the path to your dotfiles
git init # initialize repository if needed
git submodule add https://github.com/anishathalye/dotbot
git config -f .gitmodules submodule.dotbot.ignore dirty # ignore dirty commits in the submodule
cp dotbot/tools/git-submodule/install .
If you're using Mercurial, you can add Dotbot as a subrepo:
cd ~/.dotfiles # replace with the path to your dotfiles
hg init # initialize repository if needed
echo "dotbot = [git]https://github.com/anishathalye/dotbot" > .hgsub
hg add .hgsub
git clone https://github.com/anishathalye/dotbot
cp dotbot/tools/hg-subrepo/install .
To get started, you just need to fill in the
install.conf.yaml and Dotbot
will take care of the rest. To help you get started we have an
example config file as well as configuration
documentation for the accepted parameters.
install script is merely a shim that checks out the appropriate
version of Dotbot and calls the full Dotbot installer. By default, the script
assumes that the configuration is located in
install.conf.yaml the Dotbot
submodule is located in
dotbot. You can change either of these parameters by
editing the variables in the
install script appropriately.
Setting up Dotbot as a submodule or subrepo locks it on the current version.
You can upgrade Dotbot at any point. If using a submodule, run
git submodule update --remote dotbot, substituting
dotbot with the path to the Dotbot
submodule; be sure to commit your changes before running
the old version of Dotbot will be checked out by the install script. If using a
git fetch && git checkout origin/master in the Dotbot directory.
If you prefer, you can install Dotbot from PyPI and call it as a command-line program:
pip install dotbot
In this case, rather than running
./install, you can invoke Dotbot with
dotbot -c <path to configuration file>.
Here's an example of a complete configuration.
The conventional name for the configuration file is
- clean: ['~']
- [git submodule update --init --recursive, Installing submodules]
The configuration file is typically written in YAML, but it can also be written
in JSON (which is a subset of YAML). Here is the JSON
equivalent of the YAML configuration given above. JSON
configuration files are conventionally named
Dotbot uses YAML or JSON-formatted configuration files to let you specify how to set up your dotfiles. Currently, Dotbot knows how to link files and folders, create folders, execute shell commands, and clean directories of broken symbolic links. Dotbot also supports user plugins for custom commands.
Ideally, bootstrap configurations should be idempotent. That is, the installer should be able to be run multiple times without causing any problems. This makes a lot of things easier to do (in particular, syncing updates between machines becomes really easy).
Dotbot configuration files are arrays of tasks, where each task is a dictionary that contains a command name mapping to data for that command. Tasks are run in the order in which they are specified. Commands within a task do not have a defined ordering.
When writing nested constructs, keep in mind that YAML is whitespace-sensitive. Following the formatting used in the examples is a good idea. If a YAML configuration file is not behaving as you expect, try inspecting the equivalent JSON and check that it is correct.
Also, note that
~ in YAML is the same as
null in JSON. If you want a single
character string containing a tilde, make sure to enclose it in quotes:
Link commands specify how files and directories should be symbolically linked. If desired, items can be specified to be forcibly linked, overwriting existing files if necessary. Environment variables in paths are automatically expanded.
Link commands are specified as a dictionary mapping targets to source locations. Source locations are specified relative to the base directory (that is specified when running the installer). If linking directories, do not include a trailing slash.
Link commands support an (optional) extended configuration. In this type of configuration, instead of specifying source locations directly, targets are mapped to extended configuration dictionaries.
Available extended configuration parameters:
|The source for the symlink, the same as in the shortcut syntax (default:null, automatic (see below))
|When true, create parent directories to the link as needed. (default:false)
|Removes the old target if it's a symlink (default:false)
|Force removes the old target, file or folder, and forces a new link (default:false)
|Use a relative path to the source when creating the symlink (default:false, absolute links)
|Resolve any symbolic links encountered in the source to symlink to the canonical path (default:true, real paths)
* character as a wildcard, and perform link operations on all of those matches (default:false)
|Execute this in your
$SHELL and only link if it is successful.
|Do not fail if the source is missing and create the link anyway (default:false)
if: '[ `uname` = Darwin ]'
If the source location is omitted or set to
null, Dotbot will use the
basename of the destination, with a leading
. stripped if present. This makes
the following config files equivalent:
Create commands specify empty directories to be created. This can be useful for scaffolding out folders or parent folder structure required for various apps, plugins, shell commands, etc.
Create commands are specified as an array of directories to be created.
Shell commands specify shell commands to be run. Shell commands are run in the base directory (that is specified when running the installer).
Shell commands can be specified in several different ways. The simplest way is just to specify a command as a string containing the command to be run.
Another way is to specify a two element array where the first element is the shell command and the second is an optional human-readable description.
Shell commands support an extended syntax as well, which provides more
fine-grained control. A command can be specified as a dictionary that contains
the command to be run, a description, whether to suppress outputting the
command in the display via
quiet, and whether
stderr are enabled. In this syntax, all keys are optional except for the
- chsh -s $(which zsh)
- [chsh -s $(which zsh), Making zsh the default shell]
command: read var && echo Your variable is $var
description: Reading and printing variable
command: read fail
Clean commands specify directories that should be checked for dead symbolic
links. These dead links are removed automatically. Only dead links that point
to the dotfiles directory are removed unless the
force option is set to
Clean commands are specified as an array of directories to be cleaned.
Clean commands support an extended configuration syntax. In this type of
configuration, commands are specified as directory paths mapping to options. If
force option is set to
true, dead links are removed even if they don't
point to a file inside the dotfiles directory. If
recursive is set to
the directory is traversed recursively (not recommended for
~ because it will
- clean: ['~']
Default options for plugins can be specified so that options don't have to be repeated many times. This can be very useful to use with the link command, for example.
Defaults apply to all commands that follow setting the defaults. Defaults can be set multiple times; each change replaces the defaults with a new set of options.
Defaults are specified as a dictionary mapping action names to settings, which are dictionaries from option names to values.
Dotbot also supports custom directives implemented by plugins. Plugins are
implemented as subclasses of
dotbot.Plugin, so they must implement
can_handle() method should return
if the plugin can handle an action with the given name. The
should do something and return whether or not it completed successfully.
All built-in Dotbot directives are written as plugins that are loaded by default, so those can be used as a reference when writing custom plugins.
Plugins are loaded using the
--plugin-dir options, using
either absolute paths or paths relative to the base directory. It is
recommended that these options are added directly to the
Check out the Dotbot wiki for more information, tips and tricks, user-contributed plugins, and more.
Do you have a feature request, bug report, or patch? Great! See CONTRIBUTING.md for information on what you can do about that.
Update version information.
Build the package using
python setup.py sdist bdist_wheel.
Sign and upload the package using
twine upload -s dist/*.
Copyright (c) 2014-2020 Anish Athalye. Released under the MIT License. See LICENSE.md for details.