Ouch!
ouch
stands for Obvious Unified Compression Helper.
It's a CLI tool for compressing and decompressing for various formats.
Features
- Easy to use.
- Fast.
- Great error message feedback.
- No runtime dependencies required (for Linux x86_64).
- Accessibility mode (see more).
- Shell completions and man pages.
Usage
Ouch has three main subcommands:
ouch decompress
(aliasd
)ouch compress
(aliasc
)ouch list
(aliasl
orls
)
To see help
for a specific command:
Decompressing
Use the decompress
subcommand, ouch
will detect the extensions automatically.
# Decompress multiple files
The -d/--dir
flag can be used to redirect decompression results to another directory.
# Decompress 'summer_vacation.zip' inside of new folder 'pictures'
Compressing
Pass input files to the compress
subcommand, add the output file at the end.
# Compress two files into `archive.zip`
# Compress file.txt using .lz4 and .zst
ouch
detects the extensions of the output file to decide what formats to use.
Listing
# Example with tree formatting
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 |
7z |
.gz |
.xz , .lzma |
.bz , .bz2 |
.lz4 |
.sz (Snappy) |
.zst |
.rar |
---|---|---|---|---|---|---|---|---|---|---|
Supported | ✓ | ✓¹ | ✓¹ | ✓² | ✓ | ✓ | ✓ | ✓² | ✓ | ✓³ |
✓: Supports compression and decompression.
✓¹: Due to limitations of the compression format itself, (de)compression can't be done with streaming.
✓²: Supported, and compression runs in parallel.
✓³: Due to Rar's restrictive license, only decompression and listing can be supported.
tar
aliases are also supported: tgz
, tbz
, tbz2
, tlz4
, txz
, tlzma
, tsz
, tzst
.
Formats can be chained:
.tar.gz
.tar.gz.xz.zst.gz.lz4.sz
If the filename has no extensions, Ouch
will try to infer the format by the file signature and ask the user for confirmation.
Installation
On Arch Linux
On Windows via Scoop
scoop install ouch
From crates.io
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.
- Open an issue.
- Package it for your favorite distribution or package manager.
- Open a pull request.
- Share it with a friend!