Skip to main content

Manage dotfiles with stow

Project description

dotstow (DEPRICATED)

GitHub stars

Manage dotfiles with stow

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

DEPRICATED

The pypi dotstow module is deprecated.

Please use the one found on npm. https://npmjs.org/package/dotstow

You can install it by running the following command.

npm install -g dotstow

The new and improved dotstow module on npm supports the following features.

  • Group dotfiles into units (stow packages)
  • Automatically symlink (stow) files
  • Backup dotfiles with git
  • Keep track of simultaneous dotfile configurations for multiple environments
  • Supports shell autocompletion

If you were using the python version of dotstow, you should upgrade to this version to get the benefits of multiple environments. If you switch you will have to move your stash plugins into an environment folder (global is recommended).

You can do that by running the following commands.

mkdir ~/tmp_global
mv ~/.dotfiles/* ~/tmp_global
mv ~/tmp_global mkdir ~/.dotfiles/global

Features

  • Group dotfiles into units (stow packages)
  • Automatically symlink (stow) files
  • Backup dotfiles with git

Screenshots

Screenshot 1

Screenshot 1

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.

The idea behind dotstow is twofold: 1. You don’t need to maintain a shell script that symlinks all of your dotfiles to the correct places in your $HOME directory upon a new dotfile install 2. Individual directories in you .dotfiles become packages that can be installed independently using dotstow [package]

For example:

When setting up your dotfiles on a new computer 1. Run dotstow sync, give it your dotfiles github repo link, and watch as it’s cloned into ~/.dotfiles. 2. Rundotstow zsh emacs vim ... etc for each of the stow packages you’d like to install (aka symlink to $HOME). 3. When you update a file in a package, you only need to dotstow sync to update your linked github repo with the changes. If you add new files to your stow package you will need to restow the package. For example, when adding .zshrc to .dotfiles/zsh/, you will need to dotstow zsh to restow the package and then dotstow sync to update your linked github repo with the changes.

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.

Files for dotstow, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size dotstow-0.1.5-py2.py3-none-any.whl (9.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size dotstow-0.1.5.tar.gz (6.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page