dotstow 0.1.2

Manage dotfiles with stow

GitHub stars

Manage dotfiles with stow

Please ★ this repo if you found it useful ★ ★ ★

Features

• Group dotfiles into units (stow packages)

• Automatically symlink (stow) files

• Backup dotfiles with git

Installation

pip3 install dotstow

Dependencies

• Python 3

• GNU Stow

Usage

Note that unlike many dotfile syncing tools, this is powered by GNU Stow. This means your dotfiles must be stored inside stow packages (subfolders) instead of the root of your repo. This prevents cluttering your home directory with unwanted files, like your README.md. It also enables you to only install dotfiles you want on that computer.

Setup

Create a remote dotfiles repo. You can create one at GitHub.

Run the following command

dotstow sync

Creating a stow package

mkdir ~/.dotfiles/my-stow-package

Adding dotfiles to stow package

mv ~/.some-dotfile ~/.dotfiles/my-stow-package

Symlink stow package

dotstow my-stow-package

Syncing dotfiles

dotstow sync

Example

The following example demonstrates syncing your .zshrc file with dotstow

mkdir ~/.dotstow/zsh       # creates a new stow package called 'zsh'
mv ~/.zshrc ~/.dotstow/zsh # adds dotfiles to the 'zsh' stow package
dotstow zsh                # symlinks the 'zsh' stow package
dotstow sync               # syncs your dotfiles

Support

Submit an issue

Contributing

Review the guidelines for contributing

License

MIT License

Jam Risser © 2018

Changelog

Review the changelog

Credits

• Jam Risser - Author

Support on Liberapay

A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.

Add some fuel if you’d like to keep me going!

Liberapay receiving Liberapay patrons