Stash command-line tool

stash.py supports stashing changes for Mercurial and Subversion (1.7.x+) repositories similar to git stash. One major difference with git stash is that changes are not stored in a stack, but rather as a named patch in a predefined location (~/.stash/ by default).

After stashing, all changes in the repository are reverted, and the repository is back at HEAD in an unmodified state.

Usage

To temporarily stash all changes including all added and removed files in a repository issue:

$ stash.py <patch name>

<patch name> is a user-defined name that describes the contents of the patch. In case a patch with the given name already exists, stash will ask the user to either overwrite the existing patch, or specify an alternative name for the patch. The stash command can be issued from any path within a repository, provided it is either a Mercurial or Subversion respository.

All changes that are stashd in this way can be inspected using stash.py -l, and shown using stash.py -s <patch name>.

Changes that were previously saved can be restored again using stash.py -a <patch name>, potentially on top of a different commit. In case the changes apply cleanly to the current repository, the entry for the patch is automatically removed from the stash. Otherwise, the files will be merged in place (similar to merge), and the patch will remain in the stash.

For more information on the usage of stash:

$ stash.py -h

Bash completion support

When installing stash, a command-line completion script is automatically installed to /etc/bash_completion.d. This provides support for auto completing patch names in Bash.