Shelve Extension

This extension is distributed with Mercurial 2.8 and later. If you are using an earlier version of Mercurial, see ThirdPartyShelveExtension.

Author: Bryan O'Sullivan

Current maintainer: Facebook

1. Overview

The shelve extension lets you set your pending changes aside temporarily and restore them at a later time. It is useful in situations where you need to switch tasks, but are not ready to commit your current work.

2. Configuration

As of Mercurial 5.1, shelve is part of Mercurial core and is enabled by default.

If you are using an earlier version of Mercurial, configure your .hgrc to enable the extension by adding following lines:


3. Usage

Temporarily stash away changes:

hg shelve

List all existing shelves:

hg shelve --list

Get the changes back into the working directory:

hg unshelve

Shelves can be given custom names (the default name is your active bookmark or branch):

hg shelve --name <name>
hg unshelve <name>

See hg shelve --help for advance usage.

4. See also


ShelveExtension (last edited 2020-07-05 06:29:48 by DanKurtz)