mirror of
https://github.com/ouch-org/ouch.git
synced 2025-06-06 11:35:45 +00:00
104 lines
3.3 KiB
Markdown
104 lines
3.3 KiB
Markdown
# Ouch!
|
|
|
|
[](https://crates.io/crates/ouch) [](https://github.com/ouch-org/ouch/blob/main/LICENSE)
|
|
|
|
`ouch` stands for **Obvious Unified Compression Helper**, it's a CLI tool to compress and decompress files.
|
|
|
|
- [Features](#features)
|
|
- [Usage](#usage)
|
|
- [Installation](#installation)
|
|
- [Supported Formats](#supported-formats)
|
|
- [Contributing](#contributing)
|
|
|
|
## Features
|
|
|
|
1. Easy to use.
|
|
2. Automatic format detection.
|
|
3. Same syntax, various formats.
|
|
4. Encoding and decoding streams, it's fast. <!-- We should post benchmarks in our wiki and link them here -->
|
|
5. No runtime dependencies (for _Linux x86_64_).
|
|
6. Listing archive contents with tree formatting (in next release!).
|
|
|
|
## Usage
|
|
|
|
### Decompressing
|
|
|
|
Use the `decompress` subcommand and pass the files.
|
|
|
|
```sh
|
|
# Decompress one
|
|
ouch decompress a.zip
|
|
|
|
# Decompress multiple
|
|
ouch decompress a.zip b.tar.gz c.tar
|
|
|
|
# Short alternative
|
|
ouch d a.zip
|
|
```
|
|
|
|
You can redirect the decompression results to another folder with the `-d/--dir` flag.
|
|
|
|
```sh
|
|
# Decompress 'summer_vacation.zip' inside of new folder 'pictures'
|
|
ouch decompress summer_vacation.zip -d pictures
|
|
```
|
|
|
|
### Compressing
|
|
|
|
Use the `compress` subcommand, pass the files and the **output file** at the end.
|
|
|
|
```sh
|
|
# Compress four files/folders
|
|
ouch compress 1 2 3 4 archive.zip
|
|
|
|
# Short alternative
|
|
ouch c file.txt file.zip
|
|
|
|
# Compress everything in the current folder again and again
|
|
ouch compress * everything.tar.gz.xz.bz.zst.gz.gz.gz.gz.gz
|
|
```
|
|
|
|
`ouch` checks for the extensions of the **output file** to decide which formats should be used.
|
|
|
|
## 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 download the [latest binary](https://github.com/ouch-org/ouch/releases) and copy it to `/usr/bin`.
|
|
|
|
### Installing from source code
|
|
|
|
For compiling, check the [wiki guide](https://github.com/ouch-org/ouch/wiki/Compiling-and-installing-from-source-code).
|
|
|
|
## Supported formats
|
|
|
|
| Format | .tar | .zip | .bz, .bz2 | .gz | .xz, .lz, .lzma | .zst |
|
|
|:-------------:|:----:|:----:|:---------:| --- |:---------------:| --- |
|
|
| Supported | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
|
|
|
And the aliases: `tgz`, `tbz`, `tbz2`, `txz`, `tlz`, `tlzma`, `tzst`.
|
|
|
|
Formats can be chained (`ouch` keeps it _fast_):
|
|
|
|
- `.gz.xz.bz.zst`
|
|
- `.tar.gz.xz.bz.zst`
|
|
- `.tar.gz.gz.gz.gz.xz.xz.xz.xz.bz.bz.bz.bz.zst.zst.zst.zst`
|
|
|
|
## Contributing
|
|
|
|
`ouch` is 100% made out of voluntary work, any small contribution is welcome!
|
|
|
|
- Open an issue.
|
|
- Open a pull request.
|
|
- Share it to a friend!
|