t2sz - GitLite

KO | EN

gitlite — search

#typescript #golang #go #machine-learning #rust #deep-learning #macos #windows #awesome #cli #kubernetes #vue #pytorch #ios

t2sz

(★ 95)

Compresses a file into a seekable zstd with special handling for .tar archives

File Explorer

Download Latest Version (.zip)

- - aur.yml
  - deploy.yml
  - test.yml
- CMakeLists.txt
- fuzz_cli.c
- fuzz_tar_mmap.c
- fuzz_tar_stdin.c
- gen_corpus.sh
- - state
- snapcraft.yaml
- mman_compat.h
- t2sz.c
- CMakeLists.txt
- gen_blob.c
- helpers.sh
- test_coverage.sh
- test_error_paths.sh
- test_roundtrip.sh
- win-cross-build.sh
- win-cross-setup.sh
- win-cross-test.sh
.gitignore
APKBUILD
CMakeLists.txt
FUZZING.md
LICENSE
PKGBUILD
README.md
TESTING.md

# Installation Guide

1. Get the code

git clone https://github.com/martinellimarco/t2sz

Downloads the entire project code from GitHub to your computer.

cd t2sz

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
Homebrew A package manager for macOS/Linux.

sudo apt install libzstd-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

brew install zstd

Installs the pre-built package via Homebrew — no source build required.

brew install t2sz

Installs the pre-built package via Homebrew — no source build required.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. CMake

Medium

Prerequisites

Git Needed to download the project code from GitHub.
CMake The tool used to generate build configuration.
C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.

cmake .. -DCMAKE_BUILD_TYPE="Release"

Analyzes the source code and generates build configuration files (must be run inside the build folder).

✅ Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://github.com/martinellimarco/t2sz/workflows/Test%20Build/badge.svg)](https://github.com/martinellimarco/t2sz/actions)
[![License](https://img.shields.io/badge/license-GPLv3-green.svg)](https://github.com/martinellimarco/t2sz/blob/main/LICENSE)
[![AUR version](https://img.shields.io/aur/version/t2sz)](https://aur.archlinux.org/packages/t2sz/)
[![Homebrew version](https://img.shields.io/homebrew/v/t2sz)](https://formulae.brew.sh/formula/t2sz)
[![Snap version](https://snapcraft.io/t2sz/badge.svg)](https://snapcraft.io/t2sz)

# t2sz
It compresses a file into a seekable [zstd](https://github.com/facebook/zstd) splitting the file into multiple frames.

If the file is a tar archive it compresses each file in the archive into an independent frame, hence the name: tar 2 seekable zstd.

It operates in two modes. Tar archive mode and raw mode.

By default it runs in tar archive mode for files ending with `.tar`, unless `-r` is specified.

For all other files it runs in raw mode.

In tar archive mode it compresses the archive keeping each file in a different frame, unless `-s` or `-S` is used.

This allows fast seeking and extraction of a single file without decompressing the whole archive.

When `-s SIZE` is used in tar mode, if the size of the file being compressed into a block is less than `SIZE` then another one will be added in the same block, and so on until the sum of the sizes of all files packed together is at least `SIZE`. A file will be never split as `SIZE` is just a minimum value.

When `-s SIZE` is used in raw mode then it defines exactly the input block size and bigger inputs will be split in blocks of this size accordingly. If there isn't enough input data the last block will be smaller.

When `-S SIZE` is used, files bigger than `SIZE` will be split in blocks of `SIZE` length. It is available only in tar mode and ignored in raw mode.

The compressed archive can be decompressed with any Zstandard tool, including `zstd`.

To take advantage of seeking see the following projects:
- C/C++ library:  [libzstd-seek](https://github.com/martinellimarco/libzstd-seek)
- Python library: [indexed_zstd](https://github.com/martinellimarco/indexed_zstd)
- FUSE mount:     [ratarmount](https://github.com/mxmlnkn/ratarmount)

## Build

### Linux

You'll need `libzstd-dev`

```bash
sudo apt install libzstd-dev
```

```bash
git clone https://github.com/martinellimarco/t2sz
mkdir t2sz/build
cd t2sz/build
cmake .. -DCMAKE_BUILD_TYPE="Release"
make
```

Install with

```bash
sudo make install
```

Or if you want a debian package you can run

```bash
cpack
```

then install it with

```bash
sudo dpkg -i t2sz*.deb
```

### macOS

You'll need `zstd` from Homebrew:

```bash
brew install zstd
```

```bash
git clone https://github.com/martinellimarco/t2sz
mkdir t2sz/build
cd t2sz/build
cmake .. -DCMAKE_BUILD_TYPE="Release"
make
```

Install with

```bash
sudo make install
```

### Windows (cross-compilation)

On macOS or Linux, cross-compile static Windows executables using Docker:

```bash
docker run --rm -v "$(pwd)":/src ubuntu:24.04 bash /src/windows/win-cross-build.sh both
```

This produces `t2sz.exe` for both amd64 and arm64 in `build-windows-{amd64,arm64}-release/`.
Pre-built executables are also available on the [release page](https://github.com/martinellimarco/t2sz/releases/latest).

## Usage

```commandline
Usage: t2sz [OPTIONS...] [TAR ARCHIVE | -]

Use '-' as the input filename to read from standard input.

Examples:
        t2sz -s 10M any.file                        Compress any.file to any.file.zst, each input block will be of 10M
        t2sz archive.tar                            Compress archive.tar to archive.tar.zst
        t2sz -o output.tar.zst archive.tar          Compress archive.tar to output.tar.zst
        t2sz -o - archive.tar                       Compress archive.tar to standard output
        t2sz -r -o out.zst -                        Compress stdin (raw mode) to out.zst
        t2sz -o out.tar.zst -                       Compress tar from stdin to out.tar.zst
        t2sz -r -o - -                              Compress stdin to stdout (raw mode)

Options:
        -l [1..22]         Set compression level, from 1 (lower) to 22 (highest). Default is 3.
        -o FILENAME        Output file name. Use '-' to write to standard output.
                           When reading from stdin ('-') and -o is omitted, output defaults to stdout.
        -s SIZE            In raw mode: the exact size of each input block, except the last one.
                           In tar mode: the minimum size of an input block, in bytes.
                                        A block is composed by one or more whole files.
                                        A file is never split unless -S is used.
                                        If not specified one block will contain exactly one file, no matter the file size.
                                        Each block is compressed to a zstd frame but if the archive has a lot of small files
                                        having a file per block doesn't compress very well. With this you can set a trade off.
                           The greater is SIZE the smaller will be the archive at the expense of the seek speed.
                           SIZE may be followed by the following multiplicative suffixes:
                               k/K/KiB = 1024
                               M/MiB = 1024^2
                               G/GiB = 1024^3
                               kB/KB = 1000
                               MB = 1000^2
                               GB = 1000^3
        -S SIZE            In raw mode: it is ignored.
                           In tar mode: the maximum size of an input block, in bytes.
                           Unlike -s this option may split big files in smaller chunks.
                           Remember that each block is compressed independently and a small value here will result in a bigger archive.
                           -S can be used together with -s but MUST be greater or equal to its value.
                           If -S and -s are equal the input block will be of exactly that size, if there is enough input data.
                           Like -s SIZE may be followed by one of the multiplicative suffixes described above.
        -T [1..N]          Number of thread to spawn. It improves compression speed but cost more memory. Default is single thread.
                           It requires libzstd >= 1.5.0 or an older version compiler with ZSTD_MULTITHREAD.
                           If `-s` or `-S` are too small it is possible that a lower number of threads will be used.
        -r                 Raw mode or non-tar mode. Treat tar archives as regular files, without any special handling.
        -j                 Do not generate a seek table.
        -v                 Verbose. List the elements in the tar archive and their size.
        -f                 Overwrite output without prompting.
        -h                 Print this help.
        -V                 Print the version.

```

## License

See LICENSE

## Release

### Debian-based

Download the latest stable source code or .deb from the [release page](https://github.com/martinellimarco/t2sz/releases/latest). This is the recommended version.

### Arch-based

Check out [t2sz](https://aur.archlinux.org/packages/t2sz/) on AUR or `pamac build t2sz`

### Homebrew

On Linux and macOS you can install with [Homebrew](https://brew.sh/):

```bash
brew install t2sz
```

### Snap

For your convenience you can install the latest release from the [snap store](https://snapcraft.io/t2sz) but beware that it is distributed in strict mode and it can access only your home directory by default.

You can add access to removable devices such as those stored in `/media` with `sudo snap connect t2sz:removable-media`.

If you want to give it access to every file you can install it with `--devmode`.

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/t2sz)

## Testing

The project includes a comprehensive test suite covering round-trip correctness
(compress → decompress → SHA-256 verify), memory safety (AddressSanitizer +
UBSanitizer), and code coverage (LLVM).

See [TESTING.md](TESTING.md) for
prerequisites, build configurations, and the full list of test cases.

## Fuzzing

The project includes [libFuzzer](https://llvm.org/docs/LibFuzzer.html) harnesses
for fuzz-testing the tar header parser and the streaming compression paths.

See [FUZZING.md](FUZZING.md) for build instructions and usage.