Skip to content

Bootstrap

Pol Rivero edited this page Feb 27, 2025 · 3 revisions

The doot bootstrap command makes it easier to set up your dotfiles repository after installing a new OS or distro.

doot bootstrap <repo> <dir> [--key /path/to/key]

# Example:
# doot bootstrap pol-rivero/dotfiles ~/.dotfiles --key ~/dotfiles.key
  • <repo>: The URL of the repository to clone, admits the same formats as git clone. Additionally, if your dotfiles are hosted on GitHub, you can simply use <username>/<repo_name>.

Tip

If your dotfiles repository is not public, you will have to set up the appropriate credentials to be able to clone it. For example:

yay -S github-cli firefox && gh auth login  # Choose "Login with web browser"
  • <dir>: Local path for the dotfiles directory.

    If it's not a standard dotfiles location ($XDG_DATA_HOME/dotfiles or $HOME/.dotfiles), make sure your installed dotfiles will set up the DOOT_DIR variable. Otherwise, subsequent executions will not work.

  • key: If the cloned repository contains private files (with .doot-crypt), doot bootstrap will attempt to unlock the repository. This is the decryption key you obtained with doot crypt export-key.

Hooks

You can define scripts to be run after the bootstrap process in order to install additional packages or enable services. See the Hooks page to know more.

Clone this wiki locally