hg1

Repository creation

clone

make a copy of an existing repository:

hg clone [OPTION]... SOURCE [DEST]

Create a copy of an existing repository in a new directory.

If no destination directory name is specified, it defaults to the basename of the source.

The location of the source is added to the new repository's .hg/hgrc file, as the default to be used for future pulls.

Only local paths and ssh:// URLs are supported as destinations. For ssh:// destinations, no working directory or .hg/hgrc will be created on the remote side.

If the source repository has a bookmark called '@' set, that revision will be checked out in the new repository by default.

To check out a particular version, use -u/--update, or -U/--noupdate to create a clone with no working directory.

To pull only a subset of changesets, specify one or more revisions identifiers with -r/--rev or branches with -b/--branch. The resulting clone will contain only the specified changesets and their ancestors. These options (or 'clone src#rev dest') imply --pull, even for local source repositories.

In normal clone mode, the remote normalizes repository data into a common exchange format and the receiving end translates this data into its local storage format. --stream activates a different clone mode that essentially copies repository files from the remote with minimal data processing. This significantly reduces the CPU cost of a clone both remotely and locally. However, it often increases the transferred data size by 30-40%. This can result in substantially faster clones where I/O throughput is plentiful, especially for larger repositories. A side-effect of --stream clones is that storage settings and requirements on the remote are applied locally: a modern client may inherit legacy or inefficient storage used by the remote or a legacy Mercurial client may not be able to clone from a modern Mercurial remote.

Note

Specifying a tag will include the tagged changeset but not the changeset containing the tag.

For efficiency, hardlinks are used for cloning whenever the source and destination are on the same filesystem (note this applies only to the repository data, not to the working directory). Some filesystems, such as AFS, implement hardlinking incorrectly, but do not report errors. In these cases, use the --pull option to avoid hardlinking.

Mercurial will update the working directory to the first applicable revision from this list:

a.

null if -U or the source repository has no changesets

b.

if -u . and the source repository is local, the first parent of the source repository's working directory

c.

the changeset specified with -u (if a branch name, this means the latest head of that branch)

d.

the changeset specified with -r

e.

the tipmost head specified with -b

f.

the tipmost head specified with the url#branch source syntax

g.

the revision marked with the '@' bookmark, if present

h.

the tipmost head of the default branch

i.

tip

When cloning from servers that support it, Mercurial may fetch pre-generated data from a server-advertised URL or inline from the same stream. When this is done, hooks operating on incoming changesets and changegroups may fire more than once, once for each pre-generated bundle and as well as for any additional remaining data. In addition, if an error occurs, the repository may be rolled back to a partial clone. This behavior may change in future releases. See hg help -e clonebundles for more.

Examples:

•

clone a remote repository to a new directory named hg/:

hg clone https://www.mercurial-scm.org/repo/hg/

•

create a lightweight local clone:

hg clone project/ project-feature/

•

clone from an absolute path on an ssh server (note double-slash):

hg clone ssh://user@server//home/projects/alpha/

•

do a streaming clone while checking out a specified version:

hg clone --stream http://server/repo -u 1.5

•

create a repository without changesets after a particular revision:

hg clone -r 04e544 experimental/ good/

•

clone (and track) a particular named branch:

hg clone https://www.mercurial-scm.org/repo/hg/#stable

See hg help urls for details on specifying URLs.

Returns 0 on success.

Options:

-U, --noupdate

the clone will include an empty working directory (only a repository)

-u,--updaterev <REV>

revision, tag, or branch to check out

-r,--rev <REV[+]>

do not clone everything, but include this changeset and its ancestors

-b,--branch <BRANCH[+]>

do not clone everything, but include this branch's changesets and their ancestors

--pull

use pull protocol to copy metadata

--uncompressed

an alias to --stream (DEPRECATED)

--stream

clone with minimal data processing

-e,--ssh <CMD>

specify ssh command to use

--remotecmd <CMD>

specify hg command to run on the remote side

--insecure

do not verify server certificate (ignoring web.cacerts config)

[+] marked option can be specified multiple times

init

create a new repository in the given directory:

hg init [-e CMD] [--remotecmd CMD] [DEST]

Initialize a new repository in the given directory. If the given directory does not exist, it will be created.

If no directory is given, the current directory is used.

It is possible to specify an ssh:// URL as the destination. See hg help urls for more information.

Returns 0 on success.

Options:

Remote repository management

incoming

show new changesets found in source:

hg incoming [-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME] [SOURCE]

Show new changesets found in the specified path/URL or the default pull location. These are the changesets that would have been pulled by hg pull at the time you issued this command.

See pull for valid source format details.

With -B/--bookmarks, the result of bookmark comparison between local and remote repositories is displayed. With -v/--verbose, status is also displayed for each bookmark like below:

BM1               01234567890a added
BM2               1234567890ab advanced
BM3               234567890abc diverged
BM4               34567890abcd changed

The action taken locally when pulling depends on the status of each bookmark:

From the point of view of pulling behavior, bookmark existing only in the remote repository are treated as added, even if it is in fact locally deleted.

For remote repository, using --bundle avoids downloading the changesets twice if the incoming is followed by a pull.

Examples:

Returns 0 if there are incoming changes, 1 otherwise.

Options:

[+] marked option can be specified multiple times

outgoing

show changesets not found in the destination:

hg outgoing [-M] [-p] [-n] [-f] [-r REV]... [DEST]...

Show changesets not found in the specified destination repository or the default push location. These are the changesets that would be pushed if a push was requested.

See pull for details of valid destination formats.

With -B/--bookmarks, the result of bookmark comparison between local and remote repositories is displayed. With -v/--verbose, status is also displayed for each bookmark like below:

BM1               01234567890a added
BM2                            deleted
BM3               234567890abc advanced
BM4               34567890abcd diverged
BM5               4567890abcde changed

The action taken when pushing depends on the status of each bookmark:

From the point of view of pushing behavior, bookmarks existing only in the remote repository are treated as deleted, even if it is in fact added remotely.

Returns 0 if there are outgoing changes, 1 otherwise.

Options:

[+] marked option can be specified multiple times

paths

show aliases for remote repositories:

hg paths [NAME]

Show definition of symbolic path name NAME. If no name is given, show definition of all available names.

Option -q/--quiet suppresses all output when searching for NAME and shows only the path names when listing all definitions.

Path names are defined in the [paths] section of your configuration file and in /etc/mercurial/hgrc. If run inside a repository, .hg/hgrc is used, too.

The path names default and default-push have a special meaning. When performing a push or pull operation, they are used as fallbacks if no location is specified on the command-line. When default-push is set, it will be used for push and default will be used for pull; otherwise default is used as the fallback for both. When cloning a repository, the clone source is written as default in .hg/hgrc.

Note

default and default-push apply to all inbound (e.g. hg incoming) and outbound (e.g. hg outgoing, hg email and hg bundle) operations.

See hg help urls for more information.

Template:

The following keywords are supported. See also hg help templates.

name

String. Symbolic name of the path alias.

pushurl

String. URL for push operations.

url

String. URL or directory path for the other operations.

Returns 0 on success.

Options:

-T,--template <TEMPLATE>

display with template

pull

pull changes from the specified source:

hg pull [-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [SOURCE]...

Pull changes from a remote repository to a local one.

This finds all changes from the repository at the specified path or URL and adds them to a local repository (the current one unless -R is specified). By default, this does not update the copy of the project in the working directory.

When cloning from servers that support it, Mercurial may fetch pre-generated data. When this is done, hooks operating on incoming changesets and changegroups may fire more than once, once for each pre-generated bundle and as well as for any additional remaining data. See hg help -e clonebundles for more.

Use hg incoming if you want to see what would have been added by a pull at the time you issued this command. If you then decide to add those changes to the repository, you should use hg pull -r X where X is the last changeset listed by hg incoming.

If SOURCE is omitted, the 'default' path will be used. See hg help urls for more information.

If multiple sources are specified, they will be pulled sequentially as if the command was run multiple times. If --update is specified, the command will stop at the first failed --update.

Specifying bookmark as . is equivalent to specifying the active bookmark's name.

One can use the --remote-hidden flag to pull changesets hidden on the remote. This flag is "best effort", and will only work if the server supports the feature and is configured to allow the user to access hidden changesets. This option is experimental and backwards compatibility is not guaranteed.

Returns 0 on success, 1 if an update had unresolved files.

Options:

[+] marked option can be specified multiple times

push

push changes to the specified destination:

hg push [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]...

Push changesets from the local repository to the specified destination.

This operation is symmetrical to pull: it is identical to a pull in the destination repository from the current one.

By default, push will not allow creation of new heads at the destination, since multiple heads would make it unclear which head to use. In this situation, it is recommended to pull and merge before pushing.

Use --new-branch if you want to allow push to create a new named branch that is not present at the destination. This allows you to only create a new branch without forcing other changes.

Note

Extra care should be taken with the -f/--force option, which will push all new heads on all branches, an action which will almost always cause confusion for collaborators.

If -r/--rev is used, the specified revision and all its ancestors will be pushed to the remote repository.

If -B/--bookmark is used, the specified bookmarked revision, its ancestors, and the bookmark will be pushed to the remote repository. Specifying . is equivalent to specifying the active bookmark's name. Use the --all-bookmarks option for pushing all current bookmarks.

Please see hg help urls for important details about ssh:// URLs. If DESTINATION is omitted, a default path will be used.

When passed multiple destinations, push will process them one after the other, but stop should an error occur.

The --pushvars option sends strings to the server that become environment variables prepended with HG_USERVAR_. For example, --pushvars ENABLE_FEATURE=true, provides the server side hooks with HG_USERVAR_ENABLE_FEATURE=true as part of their environment.

pushvars can provide for user-overridable hooks as well as set debug levels. One example is having a hook that blocks commits containing conflict markers, but enables the user to override the hook if the file is using conflict markers for testing purposes or the file format has strings that look like conflict markers.

By default, servers will ignore --pushvars. To enable it add the following to your configuration file:

[push]
pushvars.server = true

Returns 0 if push was successful, 1 if nothing to push.

Options:

-f, --force

force push

-r,--rev <REV[+]>

a changeset intended to be included in the destination

-B,--bookmark <BOOKMARK[+]>

bookmark to push

--all-bookmarks

push all bookmarks (EXPERIMENTAL)

-b,--branch <BRANCH[+]>

a specific branch you would like to push

--new-branch

allow pushing a new branch

--pushvars <VALUE[+]>

variables that can be sent to server (ADVANCED)

--publish

push the changeset as public (EXPERIMENTAL)

-e,--ssh <CMD>

specify ssh command to use

--remotecmd <CMD>

specify hg command to run on the remote side

--insecure

do not verify server certificate (ignoring web.cacerts config)

[+] marked option can be specified multiple times

serve

start stand-alone webserver:

hg serve [OPTION]...

Start a local HTTP repository browser and pull server. You can use this for ad-hoc sharing and browsing of repositories. It is recommended to use a real web server to serve a repository for longer periods of time.

Please note that the server does not implement access control. This means that, by default, anybody can read from the server and nobody can write to it by default. Set the web.allow-push option to * to allow everybody to push to the server. You should use a real web server if you need to authenticate users.

By default, the server logs accesses to stdout and errors to stderr. Use the -A/--accesslog and -E/--errorlog options to log to files.

To have the server choose a free port number to listen on, specify a port number of 0; in this case, the server will print the port number it uses.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

Change creation

commit

commit the specified files or all outstanding changes:

hg commit [OPTION]... [FILE]...

Commit changes to the given files into the repository. Unlike a centralized SCM, this operation is a local operation. See hg push for a way to actively distribute your changes.

If a list of files is omitted, all changes reported by hg status will be committed.

If you are committing the result of a merge, do not provide any filenames or -I/-X filters.

If no commit message is specified, Mercurial starts your configured editor where you can enter a message. In case your commit fails, you will find a backup of your message in .hg/last-message.txt.

The --close-branch flag can be used to mark the current branch head closed. When all heads of a branch are closed, the branch will be considered closed and no longer listed.

The --amend flag can be used to amend the parent of the working directory with a new commit that contains the changes in the parent in addition to those currently reported by hg status, if there are any. The old commit is stored in a backup bundle in .hg/strip-backup (see hg help bundle and hg help unbundle on how to restore it).

Message, user and date are taken from the amended commit unless specified. When a message isn't specified on the command line, the editor will open with the message of the amended commit.

It is not possible to amend public changesets (see hg help phases) or changesets that have children.

See hg help dates for a list of formats valid for -d/--date.

Returns 0 on success, 1 if nothing changed.

Examples:

Options:

[+] marked option can be specified multiple times

Change manipulation

abort

abort an unfinished operation (EXPERIMENTAL):

hg abort

Aborts a multistep operation like graft, histedit, rebase, merge, and unshelve if they are in an unfinished state.

use --dry-run/-n to dry run the command.

Options:

backout

reverse effect of earlier changeset:

hg backout [OPTION]... [-r] REV

Prepare a new changeset with the effect of REV undone in the current working directory. If no conflicts were encountered, it will be committed immediately.

If REV is the parent of the working directory, then this new changeset is committed automatically (unless --no-commit is specified).

Note

hg backout cannot be used to fix either an unwanted or incorrect merge.

Examples:

•

Reverse the effect of the parent of the working directory. This backout will be committed immediately:

hg backout -r .

•

Reverse the effect of previous bad revision 23:

hg backout -r 23

•

Reverse the effect of previous bad revision 23 and leave changes uncommitted:

hg backout -r 23 --no-commit
hg commit -m "Backout revision 23"

By default, the pending changeset will have one parent, maintaining a linear history. With --merge, the pending changeset will instead have two parents: the old parent of the working directory and a new child of REV that simply undoes REV.

Before version 1.7, the behavior without --merge was equivalent to specifying --merge followed by hg update --clean . to cancel the merge and leave the child of REV as a head to be merged separately.

See hg help dates for a list of formats valid for -d/--date.

See hg help revert for a way to restore files to the state of another revision.

Returns 0 on success, 1 if nothing to backout or there are unresolved files.

Options:

--merge

merge with old dirstate parent after backout

--commit

commit if no conflicts were encountered (DEPRECATED)

--no-commit

do not commit

--parent <REV>

parent to choose when backing out merge (DEPRECATED)

-r,--rev <REV>

revision to backout

-e, --edit

invoke editor on commit messages

-t,--tool <TOOL>

specify merge tool

-I,--include <PATTERN[+]>

include names matching the given patterns

-X,--exclude <PATTERN[+]>

exclude names matching the given patterns

-m,--message <TEXT>

use text as commit message

-l,--logfile <FILE>

read commit message from file

-d,--date <DATE>

record the specified date as commit date

-u,--user <USER>

record the specified user as committer

[+] marked option can be specified multiple times

continue

resumes an interrupted operation (EXPERIMENTAL):

hg continue

Finishes a multistep operation like graft, histedit, rebase, merge, and unshelve if they are in an interrupted state.

use --dry-run/-n to dry run the command.

Options:

graft

copy changes from other branches onto the current branch:

hg graft [OPTION]... [-r REV]... REV...

This command uses Mercurial's merge logic to copy individual changes from other branches without merging branches in the history graph. This is sometimes known as 'backporting' or 'cherry-picking'. By default, graft will copy user, date, and description from the source changesets.

Changesets that are ancestors of the current revision, that have already been grafted, or that are merges will be skipped.

If --log is specified, log messages will have a comment appended of the form:

(grafted from CHANGESETHASH)

If --force is specified, revisions will be grafted even if they are already ancestors of, or have been grafted to, the destination. This is useful when the revisions have since been backed out.

If a graft merge results in conflicts, the graft process is interrupted so that the current merge can be manually resolved. Once all conflicts are addressed, the graft process can be continued with the -c/--continue option.

The -c/--continue option reapplies all the earlier options.

The --base option exposes more of how graft internally uses merge with a custom base revision. --base can be used to specify another ancestor than the first and only parent.

The command:

hg graft -r 345 --base 234

is thus pretty much the same as:

hg diff --from 234 --to 345 | hg import

but using merge to resolve conflicts and track moved files.

The result of a merge can thus be backported as a single commit by specifying one of the merge parents as base, and thus effectively grafting the changes from the other side.

It is also possible to collapse multiple changesets and clean up history by specifying another ancestor as base, much like rebase --collapse --keep.

The commit message can be tweaked after the fact using commit --amend .

For using non-ancestors as the base to backout changes, see the backout command and the hidden --parent option.

The experimental --to option allows grafting a revision in-memory, independent of the working copy. Merge conflicts are not currently supported, and the operation will be aborted if the configured tool cannot handle the conflicts that might be encountered.

As the operation is performed in-memory, the on-disk files will not be modified, and some hooks might not be run.

Examples:

See hg help revisions for more about specifying revisions.

Returns 0 on successful completion, 1 if there are unresolved files.

Options:

[+] marked option can be specified multiple times

merge

merge another revision into working directory:

hg merge [-P] [[-r] REV]

The current working directory is updated with all changes made in the requested revision since the last common predecessor revision.

Files that changed between either parent are marked as changed for the next commit and a commit must be performed before any further updates to the repository are allowed. The next commit will have two parents.

--tool can be used to specify the merge tool used for file merges. It overrides the HGMERGE environment variable and your configuration files. See hg help merge-tools for options.

If no revision is specified, the working directory's parent is a head revision, and the current branch contains exactly one other head, the other head is merged with by default. Otherwise, an explicit revision with which to merge must be provided.

See hg help resolve for information on handling file conflicts.

To undo an uncommitted merge, use hg merge --abort which will check out a clean copy of the original merge parent, losing all changes.

Returns 0 on success, 1 if there are unresolved files.

Options:

Change organization

bookmarks

create a new bookmark or list existing bookmarks:

hg bookmarks [OPTIONS]... [NAME]...

Bookmarks are labels on changesets to help track lines of development. Bookmarks are unversioned and can be moved, renamed and deleted. Deleting or moving a bookmark has no effect on the associated changesets.

Creating or updating to a bookmark causes it to be marked as 'active'. The active bookmark is indicated with a '*'. When a commit is made, the active bookmark will advance to the new commit. A plain hg update will also advance an active bookmark, if possible. Updating away from a bookmark will cause it to be deactivated.

Bookmarks can be pushed and pulled between repositories (see hg help push and hg help pull). If a shared bookmark has diverged, a new 'divergent bookmark' of the form 'name@path' will be created. Using hg merge will resolve the divergence.

Specifying bookmark as '.' to -m/-d/-l options is equivalent to specifying the active bookmark's name.

A bookmark named '@' has the special property that hg clone will check it out by default if it exists.

Template:

The following keywords are supported in addition to the common template keywords and functions such as {bookmark}. See also hg help templates.

Examples:

Options:

branch

set or show the current branch name:

hg branch [-fC] [NAME]

Note

Branch names are permanent and global. Use hg bookmark to create a light-weight bookmark instead. See hg help glossary for more information about named branches and bookmarks.

With no argument, show the current branch name. With one argument, set the working directory branch name (the branch will not exist in the repository until the next commit). Standard practice recommends that primary development take place on the 'default' branch.

Unless -f/--force is specified, branch will not let you set a branch name that already exists.

Use -C/--clean to reset the working directory branch to that of the parent of the working directory, negating a previous branch change.

Use the command hg update to switch to an existing branch. Use hg commit --close-branch to mark this branch head as closed. When all heads of a branch are closed, the branch will be considered closed.

Returns 0 on success.

Options:

-f, --force

set branch name even if it shadows an existing branch

-C, --clean

reset branch name to parent branch name

-r,--rev <VALUE[+]>

change branches of the given revs (EXPERIMENTAL)

[+] marked option can be specified multiple times

branches

list repository named branches:

hg branches [-c]

List the repository's named branches, indicating which ones are inactive. If -c/--closed is specified, also list branches which have been marked closed (see hg commit --close-branch).

Use the command hg update to switch to an existing branch.

Template:

The following keywords are supported in addition to the common template keywords and functions such as {branch}. See also hg help templates.

Returns 0.

Options:

[+] marked option can be specified multiple times

phase

set or show the current phase name:

hg phase [-p|-d|-s] [-f] [-r] [REV...]

With no argument, show the phase name of the current revision(s).

With one of -p/--public, -d/--draft or -s/--secret, change the phase value of the specified revisions.

Unless -f/--force is specified, hg phase won't move changesets from a lower phase to a higher phase. Phases are ordered as follows:

public < draft < secret

Returns 0 on success, 1 if some phases could not be changed.

(For more information about the phases concept, see hg help phases.)

Options:

[+] marked option can be specified multiple times

tag

add one or more tags for the current or given revision:

hg tag [-f] [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...

Name a particular revision using <name>.

Tags are used to name particular revisions of the repository and are very useful to compare different revisions, to go back to significant earlier versions or to mark branch points as releases, etc. Changing an existing tag is normally disallowed; use -f/--force to override.

If no revision is given, the parent of the working directory is used.

To facilitate version control, distribution, and merging of tags, they are stored as a file named ".hgtags" which is managed similarly to other project files and can be hand-edited if necessary. This also means that tagging creates a new commit. The file ".hg/localtags" is used for local tags (not shared among repositories).

Tag commits are usually made at the head of a branch. If the parent of the working directory is not a branch head, hg tag aborts; use -f/--force to force the tag commit to be based on a non-head changeset.

See hg help dates for a list of formats valid for -d/--date.

Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.

Returns 0 on success.

Options:

tags

list repository tags:

hg tags

This lists both regular and local tags. When the -v/--verbose switch is used, a third column "local" is printed for local tags. When the -q/--quiet switch is used, only the tag name is printed.

Template:

The following keywords are supported in addition to the common template keywords and functions such as {tag}. See also hg help templates.

Returns 0 on success.

Options:

File content management

annotate

show changeset information by line for each file:

hg annotate [-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...

List changes in files, showing the revision id responsible for each line.

This command is useful for discovering when a change was made and by whom.

If you include --file, --user, or --date, the revision number is suppressed unless you also include --number.

Without the -a/--text option, annotate will avoid processing files it detects as binary. With -a, annotate will annotate the file anyway, although the results will probably be neither useful nor desirable.

Use -L/--line-range FILE,M:N options to filter the output to the lines from M to N in FILE. This option is incompatible with --no-follow and cannot be combined with file pattern arguments. When combined with --rev the line ranges refer to the state of the file at the requested revision.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

And each entry of {lines} provides the following sub-keywords in addition to {date}, {node}, {rev}, {user}, etc.

See hg help templates.operators for the list expansion syntax.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

cat

output the current or given revision of files:

hg cat [OPTION]... FILE...

Print the specified files as they were at the given revision. If no revision is given, the parent of the working directory is used.

Output may be to a file, in which case the name of the file is given using a template string. See hg help templates. In addition to the common template keywords, the following formatting rules are supported:

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

copy

mark files as copied for the next commit:

hg copy [OPTION]... (SOURCE... DEST | --forget DEST...)

Mark dest as having copies of source files. If dest is a directory, copies are put in that directory. If dest is a file, the source must be a single file.

By default, this command copies the contents of files as they exist in the working directory. If invoked with -A/--after, the operation is recorded, but no copying is performed.

To undo marking a destination file as copied, use --forget. With that option, all given (positional) arguments are unmarked as copies. The destination file(s) will be left in place (still tracked). Note that hg copy --forget behaves the same way as hg rename --forget.

This command takes effect with the next commit by default.

Returns 0 on success, 1 if errors are encountered.

Options:

[+] marked option can be specified multiple times

diff

diff repository (or selected files):

hg diff [OPTION]... ([-c REV] | [--from REV1] [--to REV2]) [FILE]...

Show differences between revisions for the specified files.

Differences between files are shown using the unified diff format.

Note

hg diff may generate unexpected results for merges, as it will default to comparing against the working directory's first parent changeset if no revisions are specified. To diff against the conflict regions, you can use --config diff.merge=yes.

By default, the working directory files are compared to its first parent. To see the differences from another revision, use --from. To see the difference to another revision, use --to. For example, hg diff --from .^ will show the differences from the working copy's grandparent to the working copy, hg diff --to . will show the diff from the working copy to its parent (i.e. the reverse of the default), and hg diff --from 1.0 --to 1.2 will show the diff between those two revisions.

Alternatively you can specify -c/--change with a revision to see the changes in that changeset relative to its first parent (i.e. hg diff -c 42 is equivalent to hg diff --from 42^ --to 42)

Without the -a/--text option, diff will avoid generating diffs of files it detects as binary. With -a, diff will generate a diff anyway, probably with undesirable results.

Use the -g/--git option to generate diffs in the git extended diff format. For more information, read hg help diffs.

Examples:

•

compare a file in the current working directory to its parent:

hg diff foo.c

•

compare two historical versions of a directory, with rename info:

hg diff --git --from 1.0 --to 1.2 lib/

•

get change stats relative to the last change on some date:

hg diff --stat --from "date('may 2')"

•

diff all newly-added files that contain a keyword:

hg diff "set:added() and grep(GNU)"

•

compare a revision and its parents:

hg diff -c 9353                  # compare against first parent
hg diff --from 9353^ --to 9353   # same using revset syntax
hg diff --from 9353^2 --to 9353  # compare against the second parent

Returns 0 on success.

Options:

-r,--rev <REV[+]>

revision (DEPRECATED)

--from <REV1>

revision to diff from

--to <REV2>

revision to diff to

-c,--change <REV>

change made by revision

--ignore-changes-from-ancestors

only compare the change made by the selected revision (EXPERIMENTAL)

-a, --text

treat all files as text

-g, --git

use git extended diff format (DEFAULT: diff.git)

--binary

generate binary diffs in git mode (default)

--nodates

omit dates from diff headers

--noprefix

omit a/ and b/ prefixes from filenames

-p, --show-function

show which function each change is in (DEFAULT: diff.showfunc)

--reverse

produce a diff that undoes the changes

-w, --ignore-all-space

ignore white space when comparing lines

-b, --ignore-space-change

ignore changes in the amount of white space

-B, --ignore-blank-lines

ignore changes whose lines are all blank

-Z, --ignore-space-at-eol

ignore changes in whitespace at EOL

-U,--unified <NUM>

number of lines of context to show

--stat

output diffstat-style summary of changes

--root <DIR>

produce diffs relative to subdirectory

-I,--include <PATTERN[+]>

include names matching the given patterns

-X,--exclude <PATTERN[+]>

exclude names matching the given patterns

-S, --subrepos

recurse into subrepositories

[+] marked option can be specified multiple times

grep

search for a pattern in specified files:

hg grep [--diff] [OPTION]... PATTERN [FILE]...

Search the working directory or revision history for a regular expression in the specified files for the entire repository.

By default, grep searches the repository files in the working directory and prints the files where it finds a match. To specify historical revisions instead of the working directory, use the --rev flag.

To search instead historical revision differences that contains a change in match status ("-" for a match that becomes a non-match, or "+" for a non-match that becomes a match), use the --diff flag.

PATTERN can be any Python (roughly Perl-compatible) regular expression.

If no FILEs are specified and the --rev flag isn't supplied, all files in the working directory are searched. When using the --rev flag and specifying FILEs, use the --follow argument to also follow the specified FILEs across renames and copies.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

And each entry of {texts} provides the following sub-keywords.

See hg help templates.operators for the list expansion syntax.

Returns 0 if a match is found, 1 otherwise.

Options:

[+] marked option can be specified multiple times

Change navigation

bisect

subdivision search of changesets:

hg bisect [-gbsr] [-U] [-c CMD] [REV]

This command helps to find changesets which introduce problems. To use, mark the earliest changeset you know exhibits the problem as bad, then mark the latest changeset which is free from the problem as good. Bisect will update your working directory to a revision for testing (unless the -U/--noupdate option is specified). Once you have performed tests, mark the working directory as good or bad, and bisect will either update to another candidate changeset or announce that it has found the bad revision.

As a shortcut, you can also use the revision argument to mark a revision as good or bad without checking it out first.

If you supply a command, it will be used for automatic bisection. The environment variable HG_NODE will contain the ID of the changeset being tested. The exit status of the command will be used to mark revisions as good or bad: status 0 means good, 125 means to skip the revision, 127 (command not found) will abort the bisection, and any other non-zero exit status means the revision is bad.

Some examples:

See hg help revisions.bisect for more about the bisect() predicate.

Returns 0 on success.

Options:

heads

show branch heads:

hg heads [-ct] [-r STARTREV] [REV]...

With no arguments, show all open branch heads in the repository. Branch heads are changesets that have no descendants on the same branch. They are where development generally takes place and are the usual targets for update and merge operations.

If one or more REVs are given, only open branch heads on the branches associated with the specified changesets are shown. This means that you can use hg heads . to see the heads on the currently checked-out branch.

If -c/--closed is specified, also show branch heads marked closed (see hg commit --close-branch).

If STARTREV is specified, only those heads that are descendants of STARTREV will be displayed.

If -t/--topo is specified, named branch mechanics will be ignored and only topological heads (changesets with no children) will be shown.

Returns 0 if matching heads are found, 1 if not.

Options:

identify

identify the working directory or specified revision:

hg identify [-nibtB] [-r REV] [SOURCE]

Print a summary identifying the repository state at REV using one or two parent hash identifiers, followed by a "+" if the working directory has uncommitted changes, the branch name (if not default), a list of tags, and a list of bookmarks.

When REV is not given, print a summary of the current state of the repository including the working directory. Specify -r. to get information of the working directory parent without scanning uncommitted changes.

Specifying a path to a repository root or Mercurial bundle will cause lookup to operate on that repository/bundle.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

Examples:

See hg log for generating more information about specific revisions, including full hash identifiers.

Returns 0 if successful.

Options:

log

show revision history of entire repository or files:

hg log [OPTION]... [FILE]

Print the revision history of the specified files or the entire project.

If no revision range is specified, the default is tip:0 unless --follow is set.

File history is shown without following rename or copy history of files. Use -f/--follow with a filename to follow history across renames and copies. --follow without a filename will only show ancestors of the starting revisions. The starting revisions can be specified by -r/--rev, which default to the working directory parent.

By default this command prints revision number and changeset id, tags, non-trivial parents, user, date and time, and a summary for each commit. When the -v/--verbose switch is used, the list of changed files and full commit message are shown.

With --graph the revisions are shown as an ASCII art DAG with the most recent changeset at the top. 'o' is a changeset, '@' is a working directory parent, '%' is a changeset involved in an unresolved merge conflict, '_' closes a branch, 'x' is obsolete, '*' is unstable, and '+' represents a fork where the changeset from the lines below is a parent of the 'o' merge on the same line. Paths in the DAG are represented with '|', '/' and so forth. ':' in place of a '|' indicates one or more revisions in a path are omitted.

Use -L/--line-range FILE,M:N options to follow the history of lines from M to N in FILE. With -p/--patch only diff hunks affecting specified line range will be shown. This option requires --follow; it can be specified multiple times. Currently, this option is not compatible with --graph. This option is experimental.

Note

hg log --patch may generate unexpected diff output for merge changesets, as it will only compare the merge changeset against its first parent. Also, only files different from BOTH parents will appear in files:.

Note

For performance reasons, hg log FILE may omit duplicate changes made on branches and will not show removals or mode changes. To see all such changes, use the --removed switch.

Note

The history resulting from -L/--line-range options depends on diff options; for instance if white-spaces are ignored, respective changes with only white-spaces in specified line range will not be listed.

Some examples:

•

changesets with full descriptions and file lists:

hg log -v

•

changesets ancestral to the working directory:

hg log -f

•

last 10 commits on the current branch:

hg log -l 10 -b .

•

changesets showing all modifications of a file, including removals:

hg log --removed file.c

•

all changesets that touch a directory, with diffs, excluding merges:

hg log -Mp lib/

•

all revision numbers that match a keyword:

hg log -k bug --template "{rev}\n"

•

the full hash identifier of the working directory parent:

hg log -r . --template "{node}\n"

•

list available log templates:

hg log -T list

•

check if a given changeset is included in a tagged release:

hg log -r "a21ccf and ancestor(1.9)"

•

find all changesets by some user in a date range:

hg log -k alice -d "may 2008 to jul 2008"

•

summary of all changesets after the last tag:

hg log -r "last(tagged())::" --template "{desc|firstline}\n"

•

changesets touching lines 13 to 23 for file.c:

hg log -L file.c,13:23

•

changesets touching lines 13 to 23 for file.c and lines 2 to 6 of main.c with patch:

hg log -L file.c,13:23 -L main.c,2:6 -p

See hg help dates for a list of formats valid for -d/--date.

See hg help revisions for more about specifying and ordering revisions.

See hg help templates for more about pre-packaged styles and specifying custom templates. The default template used by the log command can be customized via the command-templates.log configuration setting.

Returns 0 on success.

Options:

-f, --follow

follow changeset history, or file history across copies and renames

--follow-first

only follow the first parent of merge changesets (DEPRECATED)

-d,--date <DATE>

show revisions matching date spec

-C, --copies

show copied files

-k,--keyword <TEXT[+]>

do case-insensitive search for a given text

-r,--rev <REV[+]>

revisions to select or follow from

-L,--line-range <FILE,RANGE[+]>

follow line range of specified file (EXPERIMENTAL)

--removed

include revisions where files were removed

-m, --only-merges

show only merges (DEPRECATED) (use -r "merge()" instead)

-u,--user <USER[+]>

revisions committed by user

--only-branch <BRANCH[+]>

show only changesets within the given named branch (DEPRECATED)

-b,--branch <BRANCH[+]>

show changesets within the given named branch

-B,--bookmark <BOOKMARK[+]>

show changesets within the given bookmark

-P,--prune <REV[+]>

do not display revision or any of its ancestors

-p, --patch

show patch

-g, --git

use git extended diff format

-l,--limit <NUM>

limit number of changes displayed

-M, --no-merges

do not show merges

--stat

output diffstat-style summary of changes

-G, --graph

show the revision DAG

--style <STYLE>

display using template map file (DEPRECATED)

-T,--template <TEMPLATE>

display with template

-I,--include <PATTERN[+]>

include names matching the given patterns

-X,--exclude <PATTERN[+]>

exclude names matching the given patterns

[+] marked option can be specified multiple times

aliases: history

parents

show the parents of the working directory or revision (DEPRECATED):

hg parents [-r REV] [FILE]

Print the working directory's parent revisions. If a revision is given via -r/--rev, the parent of that revision will be printed. If a file argument is given, the revision in which the file was last changed (before the working directory revision or the argument to --rev if given) is printed.

This command is equivalent to:

hg log -r "p1()+p2()" or
hg log -r "p1(REV)+p2(REV)" or
hg log -r "max(::p1() and file(FILE))+max(::p2() and file(FILE))" or
hg log -r "max(::p1(REV) and file(FILE))+max(::p2(REV) and file(FILE))"

See hg summary and hg help revsets for related information.

Returns 0 on success.

Options:

tip

show the tip revision (DEPRECATED):

hg tip [-p] [-g]

The tip revision (usually just called the tip) is the changeset most recently added to the repository (and therefore the most recently changed head).

If you have just made a commit, that commit will be the tip. If you have just pulled changes from another repository, the tip of that repository becomes the current tip. The "tip" tag is special and cannot be renamed or assigned to a different changeset.

This command is deprecated, please use hg heads instead.

Returns 0 on success.

Options:

Working directory management

add

add the specified files on the next commit:

hg add [OPTION]... [FILE]...

Schedule files to be version controlled and added to the repository.

The files will be added to the repository at the next commit. To undo an add before that, see hg forget.

If no names are given, add all files to the repository (except files matching .hgignore).

Examples:

Returns 0 if all files are successfully added.

Options:

[+] marked option can be specified multiple times

addremove

add all new files, delete all missing files:

hg addremove [OPTION]... [FILE]...

Add all new files and remove all missing files from the repository.

Unless names are given, new files are ignored if they match any of the patterns in .hgignore. As with add, these changes take effect at the next commit.

Use the -s/--similarity option to detect renamed files. This option takes a percentage between 0 (disabled) and 100 (files must be identical) as its parameter. With a parameter greater than 0, this compares every removed file with every added file and records those similar enough as renames. Detecting renamed files this way can be expensive. After using this option, hg status -C can be used to check which files were identified as moved or renamed. If not specified, -s/--similarity defaults to 100 and only renames of identical files are detected.

Examples:

Returns 0 if all files are successfully added.

Options:

[+] marked option can be specified multiple times

files

list tracked files:

hg files [OPTION]... [FILE]...

Print files under Mercurial control in the working directory or specified revision for given files (excluding removed files). Files can be specified as filenames or filesets.

If no files are given to match, this command prints the names of all files under Mercurial control.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

Examples:

See hg help patterns and hg help filesets for more information on specifying file patterns.

Returns 0 if a match is found, 1 otherwise.

Options:

[+] marked option can be specified multiple times

forget

forget the specified files on the next commit:

hg forget [OPTION]... FILE...

Mark the specified files so they will no longer be tracked after the next commit.

This only removes files from the current branch, not from the entire project history, and it does not delete them from the working directory.

To delete the file from the working directory, see hg remove.

To undo a forget before the next commit, see hg add.

Examples:

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

locate

locate files matching specific patterns (DEPRECATED):

hg locate [OPTION]... [PATTERN]...

Print files under Mercurial control in the working directory whose names match the given patterns.

By default, this command searches all directories in the working directory. To search just the current directory and its subdirectories, use "--include .".

If no patterns are given to match, this command prints the names of all files under Mercurial control in the working directory.

If you want to feed the output of this command into the "xargs" command, use the -0 option to both this command and "xargs". This will avoid the problem of "xargs" treating single filenames that contain whitespace as multiple filenames.

See hg help files for a more versatile command.

Returns 0 if a match is found, 1 otherwise.

Options:

[+] marked option can be specified multiple times

purge

removes files not tracked by Mercurial:

hg purge [OPTION]... [DIR]...

Delete files not known to Mercurial. This is useful to test local and uncommitted changes in an otherwise-clean source tree.

This means that purge will delete the following by default:

But it will leave untouched:

The --files and --dirs options can be used to direct purge to delete only files, only directories, or both. If neither option is given, both will be deleted.

If directories are given on the command line, only files in these directories are considered.

Be careful with purge, as you could irreversibly delete some files you forgot to add to the repository. If you only want to print the list of files that this program would delete, use the --print option.

Options:

[+] marked option can be specified multiple times

remove

remove the specified files on the next commit:

hg remove [OPTION]... FILE...

Schedule the indicated files for removal from the current branch.

This command schedules the files to be removed at the next commit. To undo a remove before that, see hg revert. To undo added files, see hg forget.

-A/--after can be used to remove only files that have already been deleted, -f/--force can be used to force deletion, and -Af can be used to remove files from the next revision without deleting them from the working directory.

The following table details the behavior of remove for different file states (columns) and option combinations (rows). The file states are Added [A], Clean [C], Modified [M] and Missing [!] (as reported by hg status). The actions are Warn, Remove (from branch) and Delete (from disk):

Note

hg remove never deletes files in Added [A] state from the working directory, not even if --force is specified.

Returns 0 on success, 1 if any warnings encountered.

Options:

-A, --after

record delete for missing files

-f, --force

forget added files, delete modified files

-S, --subrepos

recurse into subrepositories

-I,--include <PATTERN[+]>

include names matching the given patterns

-X,--exclude <PATTERN[+]>

exclude names matching the given patterns

-n, --dry-run

do not perform actions, just print output

[+] marked option can be specified multiple times

aliases: rm

rename

rename files; equivalent of copy + remove:

hg rename [OPTION]... SOURCE... DEST

Mark dest as copies of sources; mark sources for deletion. If dest is a directory, copies are put in that directory. If dest is a file, there can only be one source.

By default, this command copies the contents of files as they exist in the working directory. If invoked with -A/--after, the operation is recorded, but no copying is performed.

To undo marking a destination file as renamed, use --forget. With that option, all given (positional) arguments are unmarked as renames. The destination file(s) will be left in place (still tracked). The source file(s) will not be restored. Note that hg rename --forget behaves the same way as hg copy --forget.

This command takes effect with the next commit by default.

Returns 0 on success, 1 if errors are encountered.

Options:

[+] marked option can be specified multiple times

resolve

redo merges or set/view the merge status of files:

hg resolve [OPTION]... [FILE]...

Merges with unresolved conflicts are often the result of non-interactive merging using the internal:merge configuration setting, or a command-line merge tool like diff3. The resolve command is used to manage the files involved in a merge, after hg merge has been run, and before hg commit is run (i.e. the working directory must have two parents). See hg help merge-tools for information on configuring merge tools.

The resolve command can be used in the following ways:

Note

Mercurial will not let you commit files with unresolved merge conflicts. You must use hg resolve -m ... before you can commit after a conflicting merge.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

mergestatus

String. Character denoting merge conflicts, U or R.

path

String. Repository-absolute path of the file.

Returns 0 on success, 1 if any files fail a resolve attempt.

Options:

-a, --all

select all unresolved files

-l, --list

list state of files needing merge

-m, --mark

mark files as resolved

-u, --unmark

mark files as unresolved

-n, --no-status

hide status prefix

--re-merge

re-merge files

-t,--tool <TOOL>

specify merge tool

-I,--include <PATTERN[+]>

include names matching the given patterns

-X,--exclude <PATTERN[+]>

exclude names matching the given patterns

-T,--template <TEMPLATE>

display with template

[+] marked option can be specified multiple times

revert

restore files to their checkout state:

hg revert [OPTION]... [-r REV] [NAME]...

Note

To check out earlier revisions, you should use hg update REV. To cancel an uncommitted merge (and lose your changes), use hg merge --abort.

With no revision specified, revert the specified files or directories to the contents they had in the parent of the working directory. This restores the contents of files to an unmodified state and unschedules adds, removes, copies, and renames. If the working directory has two parents, you must explicitly specify a revision.

Using the -r/--rev or -d/--date options, revert the given files or directories to their states as of a specific revision. Because revert does not change the working directory parents, this will cause these files to appear modified. This can be helpful to "back out" some or all of an earlier change. See hg backout for a related method.

Modified files are saved with a .orig suffix before reverting. To disable these backups, use --no-backup. It is possible to store the backup files in a custom directory relative to the root of the repository by setting the ui.origbackuppath configuration option.

See hg help dates for a list of formats valid for -d/--date.

See hg help backout for a way to reverse the effect of an earlier changeset.

Returns 0 on success.

Options:

-a, --all

revert all changes when no arguments given

-d,--date <DATE>

tipmost revision matching date

-r,--rev <REV>

revert to the specified revision

-C, --no-backup

do not save backup copies of files

-i, --interactive

interactively select the changes

-I,--include <PATTERN[+]>

include names matching the given patterns

-X,--exclude <PATTERN[+]>

exclude names matching the given patterns

-n, --dry-run

do not perform actions, just print output

[+] marked option can be specified multiple times

root

print the root (top) of the current working directory:

hg root

Print the root directory of the current repository.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

Returns 0 on success.

Options:

shelve

save and set aside changes from the working directory:

hg shelve [OPTION]... [FILE]...

Shelving takes files that "hg status" reports as not clean, saves the modifications to a bundle (a shelved change), and reverts the files so that their state in the working directory becomes clean.

To restore these changes to the working directory, using "hg unshelve"; this will work even if you switch to a different commit.

When no files are specified, "hg shelve" saves all not-clean files. If specific files or directories are named, only changes to those files are shelved.

In bare shelve (when no files are specified, without interactive, include and exclude option), shelving remembers information if the working directory was on newly created branch, in other words working directory was on different branch than its first parent. In this situation unshelving restores branch information to the working directory.

Each shelved change has a name that makes it easier to find later. The name of a shelved change defaults to being based on the active bookmark, or if there is no active bookmark, the current named branch. To specify a different name, use --name.

To see a list of existing shelved changes, use the --list option. For each shelved change, this will print its name, age, and description; use --patch or --stat for more details.

To delete specific shelved changes, use --delete. To delete all shelved changes, use --cleanup.

Options:

[+] marked option can be specified multiple times

status

show changed files in the working directory:

hg status [OPTION]... [FILE]...

Show status of files in the repository. If names are given, only files that match are shown. Files that are clean or ignored or the source of a copy/move operation, are not listed unless -c/--clean, -i/--ignored, -C/--copies or -A/--all are given. Unless options described with "show only ..." are given, the options -mardu are used.

Option -q/--quiet hides untracked (unknown and ignored) files unless explicitly requested with -u/--unknown or -i/--ignored.

Note

hg status may appear to disagree with diff if permissions have changed or a merge has occurred. The standard diff format does not report permission changes and diff only reports changes relative to one merge parent.

If one revision is given, it is used as the base revision. If two revisions are given, the differences between them are shown. The --change option can also be used as a shortcut to list the changed files of a revision from its first parent.

The codes used to show the status of files are:

M = modified
A = added
R = removed
C = clean
! = missing (deleted by non-hg command, but still tracked)
? = not tracked
I = ignored
  = origin of the previous file (with --copies)

The -t/--terse option abbreviates the output by showing only the directory name if all the files in it share the same status. The option takes an argument indicating the statuses to abbreviate: 'm' for 'modified', 'a' for 'added', 'r' for 'removed', 'd' for 'deleted', 'u' for 'unknown', 'i' for 'ignored' and 'c' for clean.

It abbreviates only those statuses which are passed. Note that clean and ignored files are not displayed with '--terse ic' unless the -c/--clean and -i/--ignored options are also used.

The -v/--verbose option shows information when the repository is in an unfinished merge, shelve, rebase state etc. You can have this behavior turned on by default by enabling the commands.status.verbose option.

You can skip displaying some of these states by setting commands.status.skipstates to one or more of: 'bisect', 'graft', 'histedit', 'merge', 'rebase', or 'unshelve'.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

path

String. Repository-absolute path of the file.

source

String. Repository-absolute path of the file originated from. Available if --copies is specified.

status

String. Character denoting file's status.

Examples:

•

show changes in the working directory relative to a changeset:

hg status --rev 9353

•

show changes in the working directory relative to the current directory (see hg help patterns for more information):

hg status re:

•

show all changes including copies in an existing changeset:

hg status --copies --change 9353

•

get a NUL separated list of added files, suitable for xargs:

hg status -an0

•

show more information about the repository status, abbreviating added, removed, modified, deleted, and untracked paths:

hg status -v -t mardu

Returns 0 on success.

Options:

-A, --all

show status of all files

-m, --modified

show only modified files

-a, --added

show only added files

-r, --removed

show only removed files

-d, --deleted

show only missing files

-c, --clean

show only files without changes

-u, --unknown

show only unknown (not tracked) files

-i, --ignored

show only ignored files

-n, --no-status

hide status prefix

-t,--terse <VALUE>

show the terse output (EXPERIMENTAL) (default: nothing)

-C, --copies

show source of copied files (DEFAULT: ui.statuscopies)

-0, --print0

end filenames with NUL, for use with xargs

--rev <REV[+]>

show difference from revision

--change <REV>

list the changed files of a revision

-I,--include <PATTERN[+]>

include names matching the given patterns

-X,--exclude <PATTERN[+]>

exclude names matching the given patterns

-S, --subrepos

recurse into subrepositories

-T,--template <TEMPLATE>

display with template

[+] marked option can be specified multiple times

aliases: st

summary

summarize working directory state:

hg summary [--remote]

This generates a brief summary of the working directory state, including parents, branch, commit status, phase and available updates.

With the --remote option, this will check the default paths for incoming and outgoing changes. This can be time-consuming.

Returns 0 on success.

Options:

unshelve

restore a shelved change to the working directory:

hg unshelve [OPTION]... [[-n] SHELVED]

This command accepts an optional name of a shelved change to restore. If none is given, the most recent shelved change is used.

If a shelved change is applied successfully, the bundle that contains the shelved changes is moved to a backup location (.hg/shelve-backup).

Since you can restore a shelved change on top of an arbitrary commit, it is possible that unshelving will result in a conflict between your changes and the commits you are unshelving onto. If this occurs, you must resolve the conflict, then use --continue to complete the unshelve operation. (The bundle will not be moved until you successfully complete the unshelve.)

(Alternatively, you can use --abort to abandon an unshelve that causes a conflict. This reverts the unshelved changes, and leaves the bundle in place.)

If bare shelved change (without interactive, include and exclude option) was done on newly created branch it would restore branch information to the working directory.

After a successful unshelve, the shelved changes are stored in a backup directory. Only the N most recent backups are kept. N defaults to 10 but can be overridden using the shelve.maxbackups configuration option.

Timestamp in seconds is used to decide order of backups. More than maxbackups backups are kept, if same timestamp prevents from deciding exact order of them, for safety.

Selected changes can be unshelved with --interactive flag. The working directory is updated with the selected changes, and only the unselected changes remain shelved. Note: The whole shelve is applied to working directory first before running interactively. So, this will bring up all the conflicts between working directory and the shelve, irrespective of which changes will be unshelved.

Options:

update

update working directory (or switch revisions):

hg update [-C|-c|-m] [-d DATE] [[-r] REV]

Update the repository's working directory to the specified changeset. If no changeset is specified, update to the tip of the current named branch and move the active bookmark (see hg help bookmarks).

Update sets the working directory's parent revision to the specified changeset (see hg help parents).

If the changeset is not a descendant or ancestor of the working directory's parent and there are uncommitted changes, the update is aborted. With the -c/--check option, the working directory is checked for uncommitted changes; if none are found, the working directory is updated to the specified changeset.

The -C/--clean, -c/--check, and -m/--merge options control what happens if the working directory contains uncommitted changes. At most of one of them can be specified.

To cancel an uncommitted merge (and lose your changes), use hg merge --abort.

Use null as the changeset to remove the working directory (like hg clone -U).

If you want to revert just one file to an older revision, use hg revert [-r REV] NAME.

See hg help dates for a list of formats valid for -d/--date.

Returns 0 on success, 1 if there are unresolved files.

Options:

Change import/export

archive

create an unversioned archive of a repository revision:

hg archive [OPTION]... DEST

By default, the revision used is the parent of the working directory; use -r/--rev to specify a different revision.

The archive type is automatically detected based on file extension (to override, use -t/--type).

Examples:

Valid types are:

The exact name of the destination archive or directory is given using a format string; see hg help export for details.

Each member added to an archive file has a directory prefix prepended. Use -p/--prefix to specify a format string for the prefix. The default is the basename of the archive, with suffixes removed.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

bundle

create a bundle file:

hg bundle [-f] [-t BUNDLESPEC] [-a] [-r REV]... [--base REV]... FILE [DEST]...

Generate a bundle file containing data to be transferred to another repository.

To create a bundle containing all changesets, use -a/--all (or --base null). Otherwise, hg assumes the destination will have all the nodes you specify with --base parameters. Otherwise, hg will assume the repository has all the nodes in destination, or default-push/default if no destination is specified, where destination is the repositories you provide through DEST option.

You can change bundle format with the -t/--type option. See hg help bundlespec for documentation on this format. By default, the most appropriate format is used and compression defaults to bzip2.

The bundle file can then be transferred using conventional means and applied to another repository with the unbundle or pull command. This is useful when direct push and pull are not available or when exporting an entire repository is undesirable.

Applying bundles preserves all changeset contents including permissions, copy/rename information, and revision history.

Returns 0 on success, 1 if no changes found.

Options:

[+] marked option can be specified multiple times

export

dump the header and diffs for one or more changesets:

hg export [OPTION]... [-o OUTFILESPEC] [-r] [REV]...

Print the changeset header and diffs for one or more revisions. If no revision is given, the parent of the working directory is used.

The information shown in the changeset header is: author, date, branch name (if non-default), changeset hash, parent(s) and commit comment.

Note

hg export may generate unexpected diff output for merge changesets, as it will compare the merge changeset against its first parent only.

Output may be to a file, in which case the name of the file is given using a template string. See hg help templates. In addition to the common template keywords, the following formatting rules are supported:

%%

literal "%" character

%H

changeset hash (40 hexadecimal digits)

%N

number of patches being generated

%R

changeset revision number

%b

basename of the exporting repository

%h

short-form changeset hash (12 hexadecimal digits)

%m

first line of the commit message (only alphanumeric characters)

%n

zero-padded sequence number, starting at 1

%r

zero-padded changeset revision number

\

literal "" character

Without the -a/--text option, export will avoid generating diffs of files it detects as binary. With -a, export will generate a diff anyway, probably with undesirable results.

With -B/--bookmark changesets reachable by the given bookmark are selected.

Use the -g/--git option to generate diffs in the git extended diff format. See hg help diffs for more information.

With the --switch-parent option, the diff will be against the second parent. It can be useful to review a merge.

Template:

The following keywords are supported in addition to the common template keywords and functions. See also hg help templates.

diff

String. Diff content.

parents

List of strings. Parent nodes of the changeset.

Examples:

•

use export and import to transplant a bugfix to the current branch:

hg export -r 9353 | hg import -

•

export all the changesets between two revisions to a file with rename information:

hg export --git -r 123:150 > changes.txt

•

split outgoing changes into a series of patches with descriptive names:

hg export -r "outgoing()" -o "%n-%m.patch"

Returns 0 on success.

Options:

-B,--bookmark <BOOKMARK>

export changes only reachable by given bookmark

-o,--output <FORMAT>

print output to file with formatted name

--switch-parent

diff against the second parent

-r,--rev <REV[+]>

revisions to export

-a, --text

treat all files as text

-g, --git

use git extended diff format (DEFAULT: diff.git)

--binary

generate binary diffs in git mode (default)

--nodates

omit dates from diff headers

-T,--template <TEMPLATE>

display with template

[+] marked option can be specified multiple times

import

import an ordered set of patches:

hg import [OPTION]... PATCH...

Import a list of patches and commit them individually (unless --no-commit is specified).

To read a patch from standard input (stdin), use "-" as the patch name. If a URL is specified, the patch will be downloaded from there.

Import first applies changes to the working directory (unless --bypass is specified), import will abort if there are outstanding changes.

Use --bypass to apply and commit patches directly to the repository, without affecting the working directory. Without --exact, patches will be applied on top of the working directory parent revision.

You can import a patch straight from a mail message. Even patches as attachments work (to use the body part, it must have type text/plain or text/x-patch). From and Subject headers of email message are used as default committer and commit message. All text/plain body parts before first diff are added to the commit message.

If the imported patch was generated by hg export, user and description from patch override values from message headers and body. Values given on command line with -m/--message and -u/--user override these.

If --exact is specified, import will set the working directory to the parent of each patch before applying it, and will abort if the resulting changeset has a different ID than the one recorded in the patch. This will guard against various ways that portable patch formats and mail systems might fail to transfer Mercurial data or metadata. See hg bundle for lossless transmission.

Use --partial to ensure a changeset will be created from the patch even if some hunks fail to apply. Hunks that fail to apply will be written to a <target-file>.rej file. Conflicts can then be resolved by hand before hg commit --amend is run to update the created changeset. This flag exists to let people import patches that partially apply without losing the associated metadata (author, date, description, ...).

Note

When no hunks apply cleanly, hg import --partial will create an empty changeset, importing only the patch metadata.

With -s/--similarity, hg will attempt to discover renames and copies in the patch in the same way as hg addremove.

It is possible to use external patch programs to perform the patch by setting the ui.patch configuration option. For the default internal tool, the fuzz can also be configured via patch.fuzz. See hg help config for more information about configuration files and how to use these options.

See hg help dates for a list of formats valid for -d/--date.

Examples:

•

import a traditional patch from a website and detect renames:

hg import -s 80 http://example.com/bugfix.patch

•

import a changeset from an hgweb server:

hg import https://www.mercurial-scm.org/repo/hg/rev/5ca8c111e9aa

•

import all the patches in an Unix-style mbox:

hg import incoming-patches.mbox

•

import patches from stdin:

hg import -

•

attempt to exactly restore an exported changeset (not always possible):

hg import --exact proposed-fix.patch

•

use an external tool to apply a patch which is too fuzzy for the default internal tool.

hg import --config ui.patch="patch --merge" fuzzy.patch

•

change the default fuzzing from 2 to a less strict 7

hg import --config ui.fuzz=7 fuzz.patch

Returns 0 on success, 1 on partial success (see --partial).

Options:

-p,--strip <NUM>

directory strip option for patch. This has the same meaning as the corresponding patch option (default: 1)

-b,--base <PATH>

base path (DEPRECATED)

--secret

use the secret phase for committing

-e, --edit

invoke editor on commit messages

-f, --force

skip check for outstanding uncommitted changes (DEPRECATED)

--no-commit

don't commit, just update the working directory

--bypass

apply patch without touching the working directory

--partial

commit even if some hunks fail

--exact

abort if patch would apply lossily

--prefix <DIR>

apply patch to subdirectory

--import-branch

use any branch information in patch (implied by --exact)

-m,--message <TEXT>

use text as commit message

-l,--logfile <FILE>

read commit message from file

-d,--date <DATE>

record the specified date as commit date

-u,--user <USER>

record the specified user as committer

-s,--similarity <SIMILARITY>

guess renamed files by similarity (0<=s<=100)

aliases: patch

unbundle

apply one or more bundle files:

hg unbundle [-u] FILE...

Apply one or more bundle files generated by hg bundle.

Returns 0 on success, 1 if an update has unresolved files.

Options:

Repository maintenance

admin::narrow-client

Narrow-related client administration utils. (EXPERIMENTAL):

hg admin::narrow-client

This command is experimental and is subject to change.

Options:

admin::narrow-server

Narrow-related server administration utils. (EXPERIMENTAL):

hg admin::narrow-server

This command is experimental and is subject to change.

Options:

admin::verify

verify the integrity of the repository:

hg admin::verify

Alternative UI to hg verify with a lot more control over the verification process and better error reporting.

Options:

[+] marked option can be specified multiple times

manifest

output the current or given revision of the project manifest:

hg manifest [-r REV]

Print a list of version controlled files for the given revision. If no revision is given, the first parent of the working directory is used, or the null revision if no revision is checked out.

With -v, print file permissions, symlink and executable bits. With --debug, print file revision hashes.

If option --all is specified, the list of all files from all revisions is printed. This includes deleted and renamed files.

Returns 0 on success.

Options:

recover

roll back an interrupted transaction:

hg recover

Recover from an interrupted commit or pull.

This command tries to fix the repository status after an interrupted operation. It should only be necessary when Mercurial suggests it.

Returns 0 if successful, 1 if nothing to recover or verify fails.

Options:

rollback

roll back the last transaction (DANGEROUS) (DEPRECATED):

hg rollback

Please use hg commit --amend instead of rollback to correct mistakes in the last commit.

This command should be used with care. There is only one level of rollback, and there is no way to undo a rollback. It will also restore the dirstate at the time of the last transaction, losing any dirstate changes since that time. This command does not alter the working directory.

Transactions are used to encapsulate the effects of all commands that create new changesets or propagate existing changesets into a repository.

For example, the following commands are transactional, and their effects can be rolled back:

To avoid permanent data loss, rollback will refuse to rollback a commit transaction if it isn't checked out. Use --force to override this protection.

The rollback command can be entirely disabled by setting the ui.rollback configuration setting to false. If you're here because you want to use rollback and it's disabled, you can re-enable the command by setting ui.rollback to true.

This command is not intended for use on public repositories. Once changes are visible for pull by other users, rolling a transaction back locally is ineffective (someone else may already have pulled the changes). Furthermore, a race is possible with readers of the repository; for example an in-progress pull from the repository may fail if a rollback is performed.

Returns 0 on success, 1 if no rollback data is available.

Options:

verify

verify the integrity of the repository:

hg verify

Verify the integrity of the current repository.

This will perform an extensive check of the repository's integrity, validating the hashes and checksums of each entry in the changelog, manifest, and tracked files, as well as the integrity of their crosslinks and indices.

Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more information about recovery from corruption of the repository.

For an alternative UI with a lot more control over the verification process and better error reporting, try hg help admin::verify.

Returns 0 on success, 1 if errors are encountered.

Options:

Help

config

show combined config settings from all hgrc files:

hg config [-u] [NAME]...

With no arguments, print names and values of all config items.

With one argument of the form section.name, print just the value of that config item.

With multiple arguments, print names and values of all config items with matching section names or section.names.

With --edit, start an editor on the user-level config file. With --global, edit the system-wide config file. With --local, edit the repository-level config file.

With --source, the source (filename and line number) is printed for each config item.

See hg help config for more information about config files.

--non-shared flag is used to edit .hg/hgrc-not-shared config file. This file is not shared across shares when in share-safe mode.

Template:

The following keywords are supported. See also hg help templates.

The --shared flag can be used to edit the config file of shared source repository. It only works when you have shared using the experimental share safe feature.

Returns 0 on success, 1 if NAME does not exist.

Options:

help

show help for a given topic or a help overview:

hg help [-eck] [-s PLATFORM] [TOPIC]

With no arguments, print a list of commands with short help messages.

Given a topic, extension, or command name, print help for that topic.

Returns 0 if successful.

Options:

[+] marked option can be specified multiple times

version

output version and copyright information:

hg version

Template:

The following keywords are supported. See also hg help templates.

And each entry of {extensions} provides the following sub-keywords in addition to {ver}.

Options:

Uncategorized commands

admin::chainsaw-update

pull and update to a given revision, no matter what, (EXPERIMENTAL):

hg admin::chainsaw-update [OPTION] --rev REV --source SOURCE --dest DEST

Context of application: some Continuous Integration (CI) systems, packaging or deployment tools.

Wanted end result: local repository at the given REPO_PATH, having the latest changes to the given revision and with a clean working directory updated at the given revision.

chainsaw-update pulls from one source, then updates the working directory to the given revision, overcoming anything that would stand in the way.

By default, it will:

DO NOT use it for anything else than performing a series of unattended updates, with full exclusive repository access each time and without any other local work than running build scripts. In case the local repository is a share (see hg help share), exclusive write access to the share source is also mandatory.

It is recommended to run these commands with the HGPLAIN environment variable (see hg scripting).

Motivation: in Continuous Integration and Delivery systems (CI/CD), the occasional remnant or bogus lock are common sources of waste of time (both working time and calendar time). CI/CD scripts tend to grow with counter- measures, often done in urgency. Also, whilst it is neat to keep repositories from one job to the next (especially with large repositories), an exceptional recloning is better than missing a release deadline.

Options:

Available Types

The following bundle <type> strings are available:

Available Compression Engines

The following bundle <compression> engines can be used:

The compression engines can be prepended with stream to create a streaming bundle. These are bundles that are extremely efficient to produce and consume, but do not have guaranteed compatibility with older clients.

Available Options

The following options exist:

Examples

Mode

Mercurial can use various systems to display color. The supported modes are ansi, win32, and terminfo. See hg help config.color for details about how to control the mode.

Effects

Other effects in addition to color, like bold and underlined text, are also available. By default, the terminfo database is used to find the terminal codes used to change color and effect. If terminfo is not available, then effects are rendered with the ECMA-48 SGR control function (aka ANSI escape codes).

The available effects in terminfo mode are 'blink', 'bold', 'dim', 'inverse', 'invisible', 'italic', 'standout', and 'underline'; in ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and 'underline'. How each is rendered depends on the terminal emulator. Some may not be available for a given terminal type, and will be silently ignored.

If the terminfo entry for your terminal is missing codes for an effect or has the wrong codes, you can add or override those codes in your configuration:

[color]
terminfo.dim = \E[2m

where 'E' is substituted with an escape character.

Labels

Text receives color effects depending on the labels that it has. Many default Mercurial commands emit labelled text. You can also define your own labels in templates using the label function, see hg help templates. In order to receive effects, labels must have a dot, such as log.secret or branch.active. A single portion of text may have more than one label. In that case, effects given to the last label will override any other effects. This includes the special "none" effect, which nullifies other effects.

Labels are normally invisible. In order to see these labels and their position in the text, use the global --color=debug option. The same anchor text may be associated to multiple labels, e.g.

The following are the default effects for some default labels. Default effects may be overridden from your configuration file:

[color]
status.modified = blue bold underline red_background
status.added = green bold
status.removed = red bold blue_background
status.deleted = cyan bold underline
status.unknown = magenta bold underline
status.ignored = black bold
# 'none' turns off all effects
status.clean = none
status.copied = none
qseries.applied = blue bold underline
qseries.unapplied = black bold
qseries.missing = red bold
diff.diffline = bold
diff.extended = cyan bold
diff.file_a = red bold
diff.file_b = green bold
diff.hunk = magenta
diff.deleted = red
diff.inserted = green
diff.changed = white
diff.tab =
diff.trailingwhitespace = bold red_background
# Blank so it inherits the style of the surrounding label
changeset.public =
changeset.draft =
changeset.secret =
resolve.unresolved = red bold
resolve.resolved = green bold
bookmarks.active = green
branches.active = none
branches.closed = black bold
branches.current = green
branches.inactive = none
tags.normal = green
tags.local = black bold
rebase.rebased = blue
rebase.remaining = red bold
shelve.age = cyan
shelve.newest = green bold
shelve.name = blue bold
histedit.remaining = red bold

Custom colors

Because there are only eight standard colors, Mercurial allows you to define color names for other color slots which might be available for your terminal type, assuming terminfo mode. For instance:

color.brightblue = 12
color.pink = 207
color.orange = 202

to set 'brightblue' to color slot 12 (useful for 16 color terminals that have brighter colors defined in the upper eight) and, 'pink' and 'orange' to colors in 256-color xterm's default color cube. These defined colors may then be used as any of the pre-defined eight, including appending '_background' to set the background to that color.

Commands

The following commands are still available but their use are not recommended:

locate

This command has been replaced by hg files.

parents

This command can be replaced by hg summary or hg log with appropriate revsets. See hg help revsets for more information.

tip

The recommended alternative is hg heads.

Options

Current feature status

This feature is still in development.

Instability

Rewriting changesets might introduce instability.

There are two main kinds of instability: orphaning and diverging.

Orphans are changesets left behind when their ancestors are rewritten. Divergence has two variants:

It is possible to prevent local creation of orphans by using the following config:

[experimental]
evolution.createmarkers = true
evolution.exchange = true

You can also enable that option explicitly:

[experimental]
evolution.createmarkers = true
evolution.exchange = true
evolution.allowunstable = true

Operators

There is a single prefix operator:

These are the supported infix operators:

Predicates

The following predicates are supported:

Examples

Some sample queries:

Flag names

Flags for each command are listed in hg help for that command. Additionally, some flags, such as --repository, are global and can be used with any command - those are seen in hg help -v, and can be specified before or after the command.

Every flag has at least a long name, such as --repository. Some flags may also have a short one-letter name, such as the equivalent -R. Using the short or long name is equivalent and has the same effect. The long name may be abbreviated to any unambiguous prefix. For example, hg commit --amend can be abbreviated to hg commit --am.