Crates.io link License

Ouch!

ouch stands for Obvious Unified Compression Helper.

It's a CLI tool for compressing and decompressing for various formats.

Features

  1. Easy to use.
  2. Fast.
  3. Great error message feedback.
  4. No runtime dependencies required (for Linux x8664_).
  5. Accessibility mode (see more).
  6. Shell completions and man pages.

Usage

Ouch has three main subcommands:

Decompressing

Use the decompress subcommand, ouch will detect the extensions automatically.

```sh ouch decompress a.zip

Decompress multiple files

ouch decompress a.zip b.tar.gz c.tar ```

The -d/--dir flag can be used to redirect decompression results to another directory.

```sh

Decompress 'summer_vacation.zip' inside of new folder 'pictures'

ouch decompress summer_vacation.zip --dir pictures ```

Compressing

Pass input files to the compress subcommand, add the output file at the end.

```sh

Compress two files into archive.zip

ouch compress one.txt two.txt archive.zip

Compress file.txt using .lz4 and .zst

ouch compress file.txt file.txt.lz4.zst ```

ouch detects the extensions of the output file to decide what formats to use.

Listing

```sh ouch list archive.zip

Example with tree formatting

ouch list source-code.zip --tree ```

Output:

└── src ├── archive │ ├── mod.rs │ ├── tar.rs │ └── zip.rs ├── utils │ ├── colors.rs │ ├── formatting.rs │ ├── mod.rs │ └── fs.rs ├── commands │ ├── list.rs │ ├── compress.rs │ ├── decompress.rs │ └── mod.rs ├── accessible.rs ├── error.rs ├── cli.rs └── main.rs

Supported formats

| Format | .tar | .zip | .gz | .xz, .lzma | .bz, .bz2 | .lz4 | .sz | .zst | |:---------:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:| | Supported | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |

And the aliases: tgz, tbz, tbz2, tlz4, txz, tlzma, tsz, tzst.

Formats can be chained:

Installation

Packaging status

On Arch Linux

bash yay -S ouch

From crates.io

bash cargo install ouch

Download the latest release bundle

Check the releases page.

Compiling from source code

Check the wiki guide on compiling.

Dependencies

If you installed ouch using the download script, you will need no dependencies (static MUSL binary).

Otherwise, you'll need these libraries installed on your system:

These are available on all mainstream Linux distributions and on macOS.

Benchmarks

Benchmark results are available here. Performance of compressing and decompressing Rust source code are measured and compared with Hyperfine. The values presented are the average (wall clock) elapsed time.

Note: ouch focuses heavily on usage ergonomics and nice error messages, but we plan on doing some optimization in the future.

Versions used:

Contributing

ouch is made out of voluntary work, contributors are very welcome! No contribution is too small and all contributions are valued.