Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Manage dotfiles with stow

Project description

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
  • 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

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
dotstow-0.1.3-py2.py3-none-any.whl (6.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3
dotstow-0.1.3.tar.gz (5.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page