README.md

   1 # Ouch!
   2
   3 [![crates.io](https://img.shields.io/crates/v/ouch.svg?style=for-the-badge&logo=rust)](https://crates.io/crates/ouch) [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge&logo=Open-Source-Initiative&logoColor=ffffff)](https://github.com/ouch-org/ouch/blob/main/LICENSE)
   4
   5 `ouch` stands for **Obvious Unified Compression Helper**, it's a CLI tool to compress and decompress files.
   6
   7 - [Features](#features)
   8 - [Usage](#usage)
   9 - [Installation](#installation)
  10 - [Supported Formats](#supported-formats)
  11 - [Contributing](#contributing)
  12
  13 ## Features
  14
  15 1. Easy to use.
  16 2. Automatic format detection.
  17 3. Same syntax, various formats.
  18 4. Encoding and decoding streams, it's fast. <!-- We should post benchmarks in our wiki and link them here -->
  19 5. No runtime dependencies (for _Linux x86_64_).
  20
  21 ## Usage
  22
  23 ### Decompressing
  24
  25 Use the `decompress` subcommand and pass the files.
  26
  27 ```sh
  28 # Decompress one
  29 ouch decompress a.zip
  30
  31 # Decompress multiple
  32 ouch decompress a.zip b.tar.gz c.tar
  33
  34 # Short alternative
  35 ouch d a.zip
  36 ```
  37
  38 You can redirect the decompression results to another folder with the `-o/--output` flag.
  39
  40 ```sh
  41 # Decompress 'summer_vacation.zip' inside of new folder 'pictures'
  42 ouch decompress summer_vacation.zip -o pictures
  43 ```
  44
  45 ### Compressing
  46
  47 Use the `compress` subcommand, pass the files and the **output file** at the end.
  48
  49 ```sh
  50 # Compress four files/folders
  51 ouch compress 1 2 3 4 archive.zip
  52
  53 # Short alternative
  54 ouch c file.txt file.zip
  55
  56 # Compress everything in the current folder again and again
  57 ouch compress * everything.tar.gz.xz.bz.zst.gz.gz.gz.gz.gz
  58 ```
  59
  60 `ouch` checks for the extensions of the **output file** to decide which formats should be used.
  61
  62 ## Installation
  63
  64 [![Packaging status](https://repology.org/badge/vertical-allrepos/ouch.svg)](https://repology.org/project/ouch/versions)
  65
  66 ### Downloading the latest binary
  67
  68 Compiled for `x86_64` on _Linux_, _Mac OS_ and _Windows_, run with `curl` or `wget`.
  69
  70 | Method    | Command                                                                            |
  71 |:---------:|:-----------------------------------------------------------------------------------|
  72 | **curl**  | `curl -s https://raw.githubusercontent.com/ouch-org/ouch/master/install.sh \| sh`   |
  73 | **wget**  | `wget https://raw.githubusercontent.com/ouch-org/ouch/master/install.sh -O - \| sh` |
  74
  75
  76 The script will download the [latest binary](https://github.com/ouch-org/ouch/releases) and copy it to `/usr/bin`.
  77
  78 ### Installing from source code
  79
  80 For compiling, check the [wiki guide](https://github.com/ouch-org/ouch/wiki/Compiling-and-installing-from-source-code).
  81
  82 ## Supported formats
  83
  84 | Format        | .tar | .zip | .bz, .bz2 | .gz | .xz, .lz, .lzma | .zst |
  85 |:-------------:|:----:|:----:|:---------:| --- |:---------------:| --- |
  86 | Supported | ✓   | ✓   | ✓         | ✓  |   ✓            | ✓  |
  87
  88 And the aliases: `tgz`, `tbz`, `tbz2`, `txz`, `tlz`, `tlzma`, `tzst`.
  89
  90 Formats can be chained (`ouch` keeps it _fast_):
  91
  92 - `.gz.xz.bz.zst`
  93 - `.tar.gz.xz.bz.zst`
  94 - `.tar.gz.gz.gz.gz.xz.xz.xz.xz.bz.bz.bz.bz.zst.zst.zst.zst`
  95
  96 ## Contributing
  97
  98 `ouch` is 100% made out of voluntary work, any small contribution is welcome!
  99
 100 - Open an issue.
 101 - Open a pull request.
 102 - Share it to a friend!