Quick start

Five commands cover most of what you will do with SQZ: create an archive, test it, list it, extract it, and add a new snapshot later.

1. Create an archive#

Point sqz c at a file or folder and name the archive:

sqz c photos photos.sqz

This uses the default mode, --max, which is the slowest and usually the smallest. For everyday use, --balanced is much faster and only a little larger; --fast finishes almost at once:

sqz c --balanced photos photos.sqz
sqz c --fast photos photos.sqz

If the input is 1 GiB or more, SQZ first prints an estimate of the time, size and memory the job will take. See Estimates.

SQZ never overwrites an existing archive with c. The archive is written under a temporary name and only appears once it is complete.

2. Test it#

Check that every file in the archive restores correctly, without writing anything:

sqz t photos.sqz

3. See what is inside#

sqz l photos.sqz

This lists the files and the snapshots in the archive.

4. Extract it#

Extract into a new folder:

sqz x photos.sqz restored

Every file is checked against its BLAKE3 digest before it gets its real name. SQZ checks the destination before it writes anything: if a file already exists there, or a name cannot be created, it stops with one clear error and leaves nothing half-written. Just one file:

sqz x --file 2026/beach.jpg photos.sqz restored-one

Paths inside the archive always use forward slashes, as sqz l shows them.

5. Add a snapshot later#

When the folder has changed, add a new snapshot to the same archive. Only data that is not already stored is added:

sqz a photos photos.sqz

Every snapshot stays restorable. Snapshot 1 is the oldest; the latest is the default:

sqz x -s 1 photos.sqz photos-as-it-was

More in Snapshots.

Next steps#

• Choose the right mode for your data and your patience.
• Send an archive to someone without SQZ, as a ZIP or with the small extractor.
• Set up encrypted backups (preview).