README.md

   1 # ouch (_work in progress_)
   2
   3 `ouch` is the Obvious Unified Compression (and decompression) Helper.
   4
   5
   6 | Supported formats | .tar | .zip | .tar.{.lz, .lzma, .gz, .bz}  | .zip.{.lz, .lzma, .gz, .bz}  | .bz | .gz | .lz, .lzma |
   7 |-------------------|------|------|------------------------------|------------------------------|-----|-----|------------|
   8 | Decompression     |   ✓  |   ✓  |               ✓              |               ✓              |  ✓  |  ✓  |      ✓     |
   9 | Compression       |   ✓  |   ✗  |               ✗              |               ✗              |  ✗  |  ✗  |      ✗     |
  10
  11 ## How does it work?
  12
  13 `ouch` infers commands from the extensions of its command-line options.
  14
  15 ```
  16 ouch 0.1.0
  17 ouch is a unified compression & decompression utility
  18
  19 USAGE:
  20     ouch [OPTIONS] --input <input>...
  21
  22 FLAGS:
  23     -h, --help       Displays this message and exits
  24     -V, --version    Prints version information
  25
  26 OPTIONS:
  27     -i, --input <input>...    Input files (TODO description)
  28     -o, --output <output>     Output file (TODO description)
  29 ```
  30
  31 ### Examples
  32
  33 #### Decompressing a bunch of files
  34
  35 ```bash
  36 $ ouch -i file{1..5}.zip another_file.tar.gz yet_another_file.tar.bz
  37 ```
  38
  39 When no output file is supplied, `ouch` infers that it must decompress all of its input files. This will error if any of the input files are not decompressible.
  40
  41 #### Decompressing a bunch of files into a folder
  42
  43 ```bash
  44 $ ouch -i file{1..5}.tar.gz -o some-folder
  45 info: attempting to decompress input files into single_folder
  46 info: done!
  47 ```
  48
  49 When the output file is not a compressed file, `ouch` will check if all input files are decompressible and infer that it must decompress them into the output file.
  50
  51 #### Compressing files
  52
  53 ```bash
  54 $ ouch -i file{1..20} -o archive.tar
  55 info: trying to compress input files into 'archive.tar'
  56 info: done!
  57 ```
  58
  59 ### Error scenarios
  60
  61 #### No clear decompression algorithm
  62
  63 ```bash
  64 $ ouch -i some-file -o some-folder
  65 error: file 'some-file' is not decompressible.
  66 ```
  67
  68 `ouch` might (TODO!) be able to sniff a file's compression format if it isn't supplied in the future, but that is not currently implemented.
  69
  70 ## Installation
  71
  72 ### Runtime dependencies
  73
  74 `ouch` depends on a few widespread libraries:
  75 * libbz2
  76 * liblzma
  77
  78 Both should be already installed in any mainstream Linux distribution.
  79
  80 If they're not, then:
  81
  82 * On Debian-based distros
  83
  84 `sudo apt install liblzma-dev libbz2-dev`
  85
  86 * On Arch-based distros
  87
  88 `sudo pacman -S xz bzip2`
  89
  90 The last dependency is a recent [Rust](https://www.rust-lang.org/) toolchain. If you don't have one installed, follow the instructions at [rustup.rs](https://rustup.rs/).
  91
  92 ### Build process
  93
  94 Once the dependency requirements are met:
  95
  96 ```bash
  97 git clone https://github.com/vrmiguel/jacarex   # Clone the repo.
  98 cargo install --path ouch # .. and install it
  99 ```