bashdot

Summary

bashdot is a minimalist dotfile management framework that supports multiple profiles and file templates with variables.

It is a single script, written entirely in bash, which is easily auditable, requiring no dependencies.

Bashdot is designed to be simple and concise with comprehensive test coverage (via bats).

Overview

Bashdot symlinks files and directions into the users home directory from a directory known as a profile.

One or more profiles can be installed on a specific instance to provide the unique dotfiles based on use (work, home, etc.), operating system (Linux, MacOS, etc.) or version (Debian, RedHat, etc.).

Install

MacOS Homebrew

brew tap bashdot/tap
brew install bashdot

Manual Installation

curl -s https://raw.githubusercontent.com/bashdot/bashdot/master/bashdot > bashdot
sudo mv bashdot /usr/local/bin
sudo chmod a+x /usr/local/bin/bashdot

Quick Start

Create your initial profile directory, in this example, default.
```
 mkdir default
```
Add any files you would like symlinked into your home directory when this profile is installed:
```
 echo 'set -o vi' > default/env
```
Install the profile.
```
 bashdot install default
```
Note, when you run install, bashdot prepends a dot, in front of the original filename, to the linked file.

In the above, default/env will now be linked to ~/.env.
Continue adding your dotfiles to the default profile.
```
mv ~/.bashrc default/bashrc
```
You can safely re-run bashdot install default to link newly added files. Store this directory in a cloud drive or source control. Repeat for additional profiles.

Templates

Values which need to be set in a file when bashdot is run can be placed in a template.

Append .template to any files which should be rendered.
When installed, template files will have all variables replaced with the current environment variables set when bashdot is run.
The rendered files will be created in the same directory, and have .template replaced with .rendered.
The rendered file will be symlinked into the home directory with the .rendered suffix removed and a pre-prended dot.
For example:

If you have the file default/env.template with the below contents:
```
 export SECRET_KEY=$ENV_SECRET_KEY
```
You can run the following to set the value ENV_SECRET_KEY when installing the home profile:
```
 env ENV_SECRET_KEY=test1234 bashdot install default
```
This will result in the rendered file default/env.rendered being created and symlinkd to ~/.env with the below contents.
```
 export SECRET_KEY=test1234
```
Rendered files will be removed when you uninstall their respective bashdot profile.
Be sure to include **/*.rendered in .gitignore if you will be checking your dotfiles into a Git repo.

Managing Multiple Profiles

Bashdot works by symlinking files within the given profile directory into your home directory.

For example, if you run:

bashdot install default work

Bashdot will symlink all the files in default and work into your home directory.

Profiles installed on the same system must not contain overlapping files.

Frequently Asked Questions

Q: How do I set secrets or private information in my dotfiles?

A: Never store secrets in your dotfiles. To remove sensitive information, create a bashdot template and replace sensitive information with variables. This will prompt for the sensitive information to be provided when you run bashdot install.

Q: How do I manage directories with bashdot, when only some of the contents, of that directory, should be in source control? For example .config or .ssh?

A: Bashdot does not provide any functionality past symlinking into the top level of home directory. To manage the contents of any directories symlinked by bashdot, we recommend you add the directory and then ignore the appropriate files from your source control (For example with .gitignore).

Q: How can I share my bashdot profiles?

A: Bashdot only manages dotfiles installation, not their distribution. To share your bashdot profile, make it available via source control, shared file system or cloud drive.

Q: Does bashdot work with zsh, fish or other shells?

A: Yes. Bashdot works by using standard unix commands and symlinks. It should work with any shell on a system that has bash installed.

Q: If bashdot supports other shells, why is it called bashdot?

A: It is a 100% self contained bash script with no dependencies.

Bashdot Development

Test

Only requirement to run tests is docker. Once installed run:

make test

Shell

To shell into a container to test bashdot without affecting your local environment run:

make shell

Debug

To increase logging, set the BASHDOT_LOG_LEVEL environment variable to debug.

export BASHDOT_LOG_LEVEL=debug

This site is open source. Improve this page.