Last updated 12 October 2026
Commands
Polypress provides five commands. Run polypress without arguments for a
summary.
compress
polypress compress FILE [-o OUT] [--encoding ENC] [--no-verify]
Compresses a table into a .ppz archive. Without -o, the archive is written next to the input with .ppz added to its name.
| Option | Description |
|---|---|
-o OUT | Name of the archive. |
--encoding ENC | Text encoding of the input, if it is not UTF-8. |
--no-verify | Skips the check that decompresses the archive and compares it with the input. |
restore
polypress restore ARCHIVE [-o OUT]
Restores a table from an archive. The extension of OUT selects the output format: .csv, .tsv, .psv, .json or .jsonl.
| Option | Description |
|---|---|
-o OUT | Name and format of the restored table. |
info
polypress info ARCHIVE [--json]
Prints information about an archive, including the version of Polypress that created it.
| Option | Description |
|---|---|
--json | Prints the information as JSON. |
convert
polypress convert IN OUT [--encoding ENC]
Converts a table from one format to another without compressing it.
| Option | Description |
|---|---|
--encoding ENC | Text encoding of the input, if it is not UTF-8. |
stream-compress
polypress stream-compress FILE [-o OUT] [--budget GB] [--rows N]
Compresses a delimited text file that is too large to fit in memory, one block at a time. Archives created this way are restored with restore.
| Option | Description |
|---|---|
--budget GB | Memory limit in gigabytes (default 1.0). |
--rows N | Number of rows per block. |
--encoding ENC | Text encoding of the input, if it is not UTF-8. |
Standard input and output
A hyphen (-) in place of a file name denotes standard input or standard output.
Data passed this way are read or written as CSV.
Environment variables
| Variable | Description |
|---|---|
PPZ_THREADS | Number of threads used for compression, up to 64. By default, Polypress uses up to four threads, or fewer on machines with fewer processor cores. |