![build status](https://api.travis-ci.org/derniercri/snatch.svg?branch=devel)

# snatch
A simple, fast and interruptable download accelerator, written in Rust

![Snatch logo](./img/snatch-horizontal.png)

(A special thanks to [@fh-d](https://github.com/fh-d) for this awesome logo !)

## Current features

* **Simple**: a command line tool to manage easily your downloads ;
* **Fast**: multithreading support.

**NOTE**: _Snatch_ is on _alpha_ version. This version runs well on remote contents with a length known **before** the download (with the `content-length` header from the server response) - also, the _Interruptable_ feature is not implemented yet.

## Installation

1. Install Rust and Cargo using [rustup](https://www.rustup.rs/) ;
2. You can download two versions of _Snatch_ :  
  * the latest build from [crates.io](https://crates.io/): `cargo install
    snatch` ;
  * the last commit version from Github: `cargo install --git https://github.com/derniercri/snatch.git --branch devel` ;
3. Enjoy !

## Usage

```
Snatch 0.1.2
Snatch, a simple, fast and interruptable download accelerator, written in Rust.

USAGE:
    snatch [FLAGS] [OPTIONS] <url>

FLAGS:
    -d, --debug      Activate the debug mode
        --force      Assume Yes to all queries and do not prompt
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -f, --file <file>          The local file to save the remote content file
    -t, --threads <threads>    Threads which can be used to download

ARGS:
    <url>
```

## Screenshot

![example](./img/snatch_devel.gif)

## File examples

* [A simple PDF file](http://www.cbu.edu.zm/downloads/pdf-sample.pdf)
* [Big Buck Bunny](http://distribution.bbb3d.renderfarming.net/video/mp4/bbb_sunflower_1080p_60fps_stereo_abl.mp4), a big free mp4 file
* [The cat DNA](http://hgdownload.cse.ucsc.edu/goldenPath/felCat8/bigZips/felCat8.fa.gz), a big .gz file
* [A big PDF file from Princeton](http://scholar.princeton.edu/sites/default/files/oversize_pdf_test_0.pdf)

## Contributing

You want to contribute to _Snatch_ ?
Here are a few ways you can help us out :

* improve the documentation,
* improve the CLI,
* add new features (please to see our issues),
* report bugs.

If you want to create a pull request, this is the procedure to make it great:

* create an issue to explain the problem you encountered (except for typo),
* fork the project,
* create a local branch to make changes (from our `devel` branch),
* test your changes,
* create a pull request (please compare it with our `devel` branch),
* explain your changes,
* submit !

Thank you for your interest in contributing to _Snatch_ ! :-D

## Changelogs

*   0.1.3 (**current**)
    *   Fix the behaviour to know if the download is OK or not
    *   Delete automatically the file if the download is not OK
    *   Fix the behaviour when downloading a file using zero thread (yes, that was possible...)
    *   Fix the behaviour when downloading a file using one thread
    *   Monothreading download if the remote server does not support PartialContent headers

*   0.1.2 (`2ee85c151167770ce0a71245e72c02497625087f`)  
    No changelogs reported
    
*   0.1.1 (`624a59d23e28d369bae2f9d30ea22db197f7e729`)  
    No changelogs reported

*   0.1.0  
    No changelogs reported

## Build issues

* Libraries cannot be build
Please go check if you are using the latest version of `rustc` (stable), running `rustup update`.

* `fatal error: 'openssl/hmac.h' file not found`
If you are on a GNU/Linux distribution (like Ubuntu), please install `libssl-dev`.
If you are on macOS, please install `openssl` and check your OpenSSL configuration:

```
brew install openssl
export OPENSSL_INCLUDE_DIR=`brew --prefix openssl`/include
export OPENSSL_LIB_DIR=`brew --prefix openssl`/lib
export DEP_OPENSSL_INCLUDE=`brew --prefix openssl`/include
```