mirror of
https://github.com/ouch-org/ouch.git
synced 2025-06-06 11:35:45 +00:00
147 lines
4.7 KiB
Markdown
147 lines
4.7 KiB
Markdown
<p align="center">
|
|
<a href="https://crates.io/crates/ouch">
|
|
<img src="https://img.shields.io/crates/v/ouch?color=6090FF&style=flat-square" alt="Crates.io link">
|
|
</a>
|
|
<a href="https://docs.rs/ouch">
|
|
<img src="https://img.shields.io/docsrs/ouch?color=6090FF&style=flat-square" alt="Docs.rs link">
|
|
</a>
|
|
<a href="https://github.com/ouch/ouch-org/blob/master/LICENSE">
|
|
<img src="https://img.shields.io/crates/l/ouch?color=6090FF&style=flat-square" alt="License">
|
|
</a>
|
|
</p>
|
|
|
|
# Ouch!
|
|
|
|
`ouch` stands for **Obvious Unified Compression Helper** and is a CLI tool to help you compress and decompress files of several formats.
|
|
|
|
- [Features](#features)
|
|
- [Usage](#usage)
|
|
- [Installation](#installation)
|
|
- [Supported Formats](#supported-formats)
|
|
- [Benchmarks](#benchmarks)
|
|
- [Contributing](#contributing)
|
|
|
|
# Features
|
|
|
|
1. Easy to use.
|
|
2. Accessibility mode (A11Y) via `--accessibility` or `ACCESSIBILITY` env var (see [wiki page](https://github.com/ouch-org/ouch/wiki/Accessibility)).
|
|
3. Automatic formats detection.
|
|
4. Same usage syntax for all formats.
|
|
5. Uses encoding and decoding streams to improve performance.
|
|
6. No runtime dependencies (for _Linux x86_64_).
|
|
7. Can list archive contents with pretty tree formatting.
|
|
8. Shell completions (soon!).
|
|
|
|
# Usage
|
|
|
|
## Decompressing
|
|
|
|
Use the `decompress` subcommand and pass the files.
|
|
|
|
```sh
|
|
# Decompress a file
|
|
ouch decompress a.zip
|
|
|
|
# Decompress multiple files
|
|
ouch decompress a.zip b.tar.gz c.tar
|
|
|
|
# Short alternative
|
|
ouch d a.zip
|
|
```
|
|
|
|
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
|
|
|
|
Use the `compress` subcommand, pass the files and the **output file** at the end.
|
|
|
|
```sh
|
|
# Compress four files
|
|
ouch compress 1 2 3 4 archive.zip
|
|
|
|
# Short alternative
|
|
ouch c file.txt file.zip
|
|
```
|
|
|
|
`ouch` detects the extensions of the **output file** to decide what formats to use.
|
|
|
|
# Supported formats
|
|
|
|
| Format | `.tar` | `.zip` | `.bz`, `.bz2` | `.gz` | `.lz4` | `.xz`, `.lzma` | `.sz` | `.zst` |
|
|
|:---------:|:------:|:------:|:-------------:|:-----:|:------:|:--------------:|:-----:|:-------|
|
|
| Supported | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
|
|
|
And the aliases: `tgz`, `tbz`, `tbz2`, `tlz4`, `txz`, `tlzma`, `tsz`, `tzst`.
|
|
|
|
Formats can be chained:
|
|
|
|
- `.tar.gz`
|
|
- `.tar.gz.gz.gz.gz`
|
|
- `.tar.gz.gz.gz.gz.zst.xz.bz.lz4`
|
|
|
|
# Installation
|
|
|
|
[](https://repology.org/project/ouch/versions)
|
|
|
|
## Downloading the latest binary
|
|
|
|
Compiled for `x86_64` on _Linux_, _Mac OS_ and _Windows_, run with `curl` or `wget`.
|
|
|
|
| Method | Command |
|
|
|:---------:|:------------------------------------------------------------------------------------|
|
|
| **curl** | `curl -s https://raw.githubusercontent.com/ouch-org/ouch/master/install.sh \| sh` |
|
|
| **wget** | `wget https://raw.githubusercontent.com/ouch-org/ouch/master/install.sh -O - \| sh` |
|
|
|
|
The script will copy the [latest binary](https://github.com/ouch-org/ouch/releases) to `/usr/local/bin`.
|
|
|
|
## Compiling from source code
|
|
|
|
Check the [wiki guide](https://github.com/ouch-org/ouch/wiki/Compiling-and-installing-from-source-code).
|
|
|
|
# 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:
|
|
|
|
* [liblzma](https://www.7-zip.org/sdk.html)
|
|
* [libbz2](https://www.sourceware.org/bzip2/)
|
|
* [libz](https://www.zlib.net/)
|
|
|
|
These are available on all mainstream _Linux_ distributions and on _macOS_.
|
|
|
|
# Benchmarks
|
|
|
|
Comparison made decompressing `linux.tar.gz` and measured with
|
|
[Hyperfine](https://github.com/sharkdp/hyperfine) and the values presented are the average (wall clock) elapsed time.
|
|
|
|
| Tool | `ouch` | [`tar`] | [`bsdtar`] |
|
|
|:------------:|:------:|:-------:|:----------:|
|
|
| Average time | 911 ms | 1102 ms | 829 ms |
|
|
|
|
Note: `ouch` focuses heavily on usage ergonomics and nice error messages, but
|
|
we plan on doing some optimization in the future.
|
|
|
|
Versions used:
|
|
|
|
- `ouch` _0.3.1_
|
|
- [`tar`] _1.34_
|
|
- [`bsdtar`] _3.5.2_
|
|
|
|
# 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](https://github.com/ouch-org/ouch/issues).
|
|
- Package it for your favorite distribution or package manager.
|
|
- Open a pull request.
|
|
- Share it with a friend!
|
|
|
|
[`tar`]: https://www.gnu.org/software/tar/
|
|
[`bsdtar`]: https://www.freebsd.org/cgi/man.cgi?query=bsdtar&sektion=1&format=html
|