Skip to content

Usage

Wring has various subcommand tools to help keep files small.

Usage:

wring [OPTIONS] COMMAND [ARGS]...

Options:

  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

csv

Crawl a directory and compress csv files into parquet.

Usage:

wring csv [OPTIONS]

Options:

  --directory PATH             [default: .]
  --compression TEXT           compression algorithm  [default: zstd]
  --compression-level INTEGER  compression level  [default: 9]
  --clean / --no-clean         remove uncompressed files after successful
                               wringing  [default: no-clean]

omx

Convert one or more OMX files using different data types and filters.

Usage:

wring omx [OPTIONS] [GLOB_PATTERN] [COMPLEVEL] [COMPLIB]

Options:

  [GLOB_PATTERN]          file name or glob pattern for the OMX files to
                          convert  [default: *.omx]
  [COMPLEVEL]             compression level  [default: 3]
  [COMPLIB]               compression library  [default: blosc2:zstd]
  --dtype-shrink INTEGER  maximum bitwidth to use for integer and float types
                          [default: 32]
  --n-processes INTEGER   number of processes to use while converting files
                          [default: 8]
  --out-dir TEXT          directory name for the resulting reprocessed
                          file(s), if not provided any '.omx' suffix is
                          stripped from the original file name(s) and a
                          '.omxz' suffix is added

tarzst

Compress a directory using the .tar.zst format.

Usage:

wring tarzst [OPTIONS] DIRECTORY

Options:

  DIRECTORY               the directory to compress  [required]
  --archive PATH          base file name for the resulting archive file(s), if
                          not provided a '.tar.zst' suffix is added to the
                          original directory name
  -c, --chunk-gigs FLOAT  chunk the resulting archive into parts that are no
                          larger than this many gigabytes

untarzst

Decompress a directory stored in .tar.zst format.

Usage:

wring untarzst [OPTIONS] ARCHIVE

Options:

  ARCHIVE        the archive file to decompress, or the first of multiple
                 parts  [required]
  --outdir PATH  directory name for the resulting decompressed file(s), if not
                 provided any '.tar.zst' suffix is stripped from the archive
                 file name and the rest is used

Last update: 2024-04-26
Created: 2024-04-26