xerus 0.3.1

A command-line BitTorrent client, written in Rust.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# xerus

[![Build Status](https://github.com/thomasdidion/xerus/actions/workflows/ci.yaml/badge.svg)](https://github.com/thomasdidion/xerus/actions/workflows/ci.yaml)
[![Crates.io](https://img.shields.io/crates/v/xerus.svg)](https://crates.io/crates/xerus)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A command-line BitTorrent client, written in Rust.

## Usage

```
A command-line BitTorrent client, written in Rust.

Usage: xerus [OPTIONS] <TORRENT>

Arguments:
  <TORRENT>  Path to the .torrent file

Options:
  -o, --output <OUTPUT>  Output filename (defaults to name from torrent)
  -h, --help             Print help
  -V, --version          Print version
```

## Example

Try to download an official Debian ISO image:

```
$> xerus debian-13.2.0-amd64-netinst.iso.torrent
Downloading "debian-13.2.0-amd64-netinst.iso" (3136 pieces)
Saved in "debian-13.2.0-amd64-netinst.iso".
```

And verify the checksum matches that expected from the checksum file:

```
$> sha512sum -c SHA512SUM | grep debian-13.2.0-amd64-netinst.iso
debian-13.2.0-amd64-netinst.iso: OK
```

## Installation

### From crates.io (recommended)

```bash
cargo install xerus
```

### From source

```bash
cargo install --path .
```

## Uninstallation

```bash
cargo uninstall xerus
```

## Debug

Run with the environment variable set:

```
$> RUST_LOG=trace xerus <torrent>
```

## Documentation

Learn more here: [https://docs.rs/xerus](https://docs.rs/xerus).

## License

Xerus is distributed under the terms of the [MIT License](LICENSE).