Scroll to navigation

hatchzip(1) General Commands Manual hatchzip(1)

NAME

hatchzip - Extract large archives in place, removing the archive progressively.

SYNOPSIS

hatchzip [-q|--quiet] [-h|--help] [-V|--version] <subcommands>

DESCRIPTION

Extract large archives in place, removing the archive progressively.

HatchZip extracts an archive from its end and truncates each completed part from the archive file, so the released space is reused for the next files. Free space is required for the extracted files only, not for the files and the archive. The space plan is checked before the archive is modified, and an interrupted extraction resumes where it stopped when the same command is run again.

With --keep-archive, HatchZip extracts like any other tool and leaves the archive unchanged; free space is then required for all extracted files.

Supported: ZIP (including ZIP64 and self-extracting .exe), 7z, uncompressed tar, gzip-compressed tar (.tar.gz, .tgz), xz-compressed tar (.tar.xz, .txz), split archives (.001, .002, ...) of any of those. This build does not include RAR support; the release builds from hatchzip.dev and github.com/xevrion/hatchzip/releases do.

OPTIONS

Print only errors and prompts
Print help (see a summary with '-h')
Print version

SUBCOMMANDS

Extract an archive, removing it progressively
Show the space plan for an archive without modifying it
List the entries of an archive
Verify every entry of an archive without writing files
Restore a partially extracted archive to a standard archive
Print a shell completion script
Print the man page (roff)
Print this message or the help of the given subcommand(s)

EXTRA

Examples:
hatchzip check game.zip Show the space plan without modifying anything
hatchzip extract game.zip Extract to ./game, removing game.zip during extraction
hatchzip extract game.zip --keep-archive
Extract to ./game and keep game.zip unchanged
hatchzip check game.zip --keep-archive
Show whether a standard extraction fits
hatchzip x game.7z.001 -o D:\Games Extract a split archive from any of its parts
hatchzip extract patch.zip -o Game --replace
Extract over an existing folder, replacing its files
hatchzip extract a.zip b.7z c.tar.gz Extract several archives, one after another
hatchzip extract big.zip --verify-first --keep-free 10GB
hatchzip test game.7z Verify every entry without writing files
hatchzip restore game.zip Restore a partially extracted archive

To resume an interrupted extraction, run the same command again. Progress is stored in files next to the archive (<archive>.hatchzip, <archive>.hatchzip-tail and, for an archive with folder entries, <archive>.hatchzip-folders); do not delete them while an extraction is incomplete. To stop permanently instead, run restore: the entries not yet extracted become a standard archive again. An extraction with --keep-archive resumes the same way and keeps the archive when resumed.

Several archives are processed one after another. extract checks the space for each one just before it starts and stops at the first one that does not complete, then lists what was extracted and what was not. check, test and list process every archive.

Exit status:
0 success
1 failure (progress, if any, is saved)
2 invalid command line
3 insufficient disk space; the archive was not modified
4 the archive is damaged; no files were removed
5 the archive is password protected and no correct password was provided
130 paused with Ctrl+C; run the same command to resume With several archives, the status is that of the first archive that did not succeed.

Encrypted archives (ZIP with ZipCrypto or AES, 7z with AES): HatchZip prompts for the password, or reads --password or the HATCHZIP_PASSWORD environment variable. The password is verified on one file before the archive is modified. It is never stored, so resuming an interrupted extraction prompts again.

VERSION

v0.1.10

hatchzip 0.1.10