Manage dotfiles with stow
Project description
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
Powered by GNU Stow
Installation
pip3 install dotstow
Dependencies
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
Note that this will fail if conflicting files exist in the home directory.
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
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!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dotstow-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da793236e851fa9420e2cc57afcddc9f62628114c7609d6a9df7f9caa78f8343 |
|
MD5 | 909abcda15637cf650ab00e741636ba6 |
|
BLAKE2b-256 | 172f152d6d3453ac1bc32d10fd327746ed0afaa9e79eb0b1f25b932817f2c08b |