Skip to content

cli.md

Latest commit

 

History

History
127 lines (99 loc) · 3.37 KB

cli.md

File metadata and controls

127 lines (99 loc) · 3.37 KB
Raw

CLI reference

bun add -g @myrialabs/zipkit      # or: npm i -g @myrialabs/zipkit
zipkit help
zipkit <command> [options]

Commands

compress <file>

Compress a file. Defaults to zstd.

zipkit compress data.json                       # → data.json.zst (zstd)
zipkit compress data.json --codec brotli        # → data.json.br
zipkit compress data.json --mode ratio          # smallest, codec-default level
zipkit compress data.json --codec gzip --level 9 -o out.gz
Flag Description
--codec <c> One of: gzip, deflate, zlib, zstd, lz4, snappy, brotli, lzma, bzip2 (default zstd)
--mode <m> speed, balanced (default), or ratio — picks a codec-specific level
--level <n> Compression level (codec-specific, clamped). Overrides --mode's level
-o, --out <file> Output path (default: <file>.<ext>)

decompress <file>

Decompress a file. Auto-detects gzip/zlib/zstd by default.

zipkit decompress data.json.zst
zipkit decompress data.bin --codec brotli       # name the codec for headerless formats
zipkit decompress data.json.gz -o data.json
Flag Description
--codec <c> Force a codec (required for brotli, snappy, lz4, lzma, bzip2)
-o, --out <file> Output path

zip <archive.zip> <files|dirs...>

Create a ZIP archive. Directory arguments are added recursively, preserving their relative paths.

zipkit zip site.zip index.html app.js style.css
zipkit zip site.zip ./public --method zstd      # recurse a directory
Flag Description
--method <m> deflate (default), zstd, or store

unzip <archive.zip>

Extract a ZIP archive.

zipkit unzip site.zip
zipkit unzip site.zip -d ./out
Flag Description
-d, --dir <dir> Output directory (default .)

tar <archive.tar[.gz|.zst]> <files|dirs...> / untar <archive>

Create or extract a tarball. The flavor is chosen by extension: .tar (plain), .tar.gz, or .tar.zst. Directories recurse.

zipkit tar release.tar.zst ./dist
zipkit untar release.tar.zst -d ./out

7z <archive.7z> <files|dirs...> / un7z <archive.7z>

Create or extract a 7z archive (LZMA1, or --method copy). Reading also handles LZMA2 / copy archives from 7-Zip.

zipkit 7z bundle.7z ./src
zipkit un7z bundle.7z -d ./out

info <file>

Show the detected format. For ZIP archives, list the entries.

zipkit info data.json.gz        # format: gzip
zipkit info site.zip            # lists entries with sizes and methods

bench [file]

Compress and decompress with every codec; print ratio and timings. With no file, benchmarks a built-in deterministic preset corpus (text / JSON / log / binary) so comparisons across versions are apple-to-apple. Add --json for machine-readable output (CI regression gates).

zipkit bench big.log
zipkit bench                 # preset corpus
zipkit bench --json > bench.json
bench big.log (5.9 KB)
codec     ratio    size        comp     decomp
gzip        1.2%        73 B     0.1ms    0.1ms
zstd        0.6%        38 B     1.5ms    1.2ms
brotli      0.5%        32 B    11.3ms    1.2ms
...

version / help

zipkit version
zipkit help

Notes

  • Colors are disabled automatically when stdout is not a TTY, or when NO_COLOR is set.
  • The CLI runs on both Node and Bun.