Help: archive

hg archive [OPTION]... DEST

create an unversioned archive of a repository revision

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).


  • create a zip file containing the 1.0 release:
    hg archive -r 1.0
  • create a tarball excluding .hg files:
    hg archive project.tar.gz -X ".hg*"

Valid types are:

a directory full of files (default)
tar archive, uncompressed
tar archive, compressed using bzip2
tar archive, compressed using gzip
tar archive, compressed using lzma (only in Python 3)
zip archive, uncompressed
zip archive, compressed using deflate

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 ([+] can be repeated):

--no-decode do not pass files through decoders
-p --prefix PREFIX directory prefix for files in archive
-r --rev REV revision to distribute
-t --type TYPE type of distribution to create
-S --subrepos recurse into subrepositories
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns

global options ([+] can be repeated):

-R --repository REPO repository root directory or name of overlay bundle file
--cwd DIR change working directory
-y --noninteractive do not prompt, automatically pick the first choice for all prompts
-q --quiet suppress output
-v --verbose enable additional output
--color TYPE when to colorize (boolean, always, auto, never, or debug)
--config CONFIG [+] set/override config option (use '')
--debug enable debugging output
--debugger start debugger
--encoding ENCODE set the charset encoding (default: UTF-8)
--encodingmode MODE set the charset encoding mode (default: strict)
--traceback always print a traceback on exception
--time time how long the command takes
--profile print command execution profile
--version output version information and exit
-h --help display help and exit
--hidden consider hidden changesets
--pager TYPE when to paginate (boolean, always, auto, or never) (default: auto)