humble-cli 0.16.3

The missing CLI for downloading your Humble Bundle purchases
Documentation 
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

[![Build status](https://github.com/smbl64/humble-cli/actions/workflows/tests.yml/badge.svg)](https://github.com/smbl64/humble-cli/actions/workflows/tests.yml)
![GitHub](https://img.shields.io/github/license/smbl64/humble-cli)
![GitHub release (with filter)](https://img.shields.io/github/v/release/smbl64/humble-cli)

# humble-cli
The missing CLI for downloading your Humble Bundle purchases!

## Features
- List all your Humble Bundle purchases
- See contents of each bundle, along with file formats and their size
- Download items in a bundle, with the option to 
    - filter them by format (epub, pdf etc.)
    - filter them by size 
    - download only selected items (by index)
- See which bundles have unclaimed keys
- Check your Humble Bundle Choices in current and previous months
- Search through all your purchases for a specific product

## Install
**Option 1:** Download the binaries in the [Releases][releases] page. Windows, macOS and Linux are supported.

**Option 2:** Install it via `cargo`:

```sh
cargo install humble-cli
```

## Usage

To start, go to the [Humble Bundle website][hb-site] and log in. Then find the cookie value for `_simpleauth_sess`. This is required to interact with Humble Bundle API. 

See this guide on how to find the cookie value for your browser: [Chrome][guide-chrome], [Firefox][guide-firefox], [Safari][guide-safari].

Use `humble-cli auth "<YOUR SESSION KEY>"` to store the authentication key locally for other subcommands.

After that you will have access to the following sub-commands:

```
$ humble-cli --help
humble-cli 0.16.3
The missing Humble Bundle CLI

USAGE:
    humble-cli <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    auth            Set the authentication session key
    completion      Generate shell completions
    details         Print details of a certain bundle [aliases: info]
    download        Selectively download items from a bundle [aliases: d]
    help            Print this message or the help of the given subcommand(s)
    list            List all your purchased bundles [aliases: ls]
    list-choices    List your current Humble Choices
    search          Search through all bundle products for keywords

Note: `humble-cli -h` prints a short and concise overview while `humble-cli --help` gives all
details.
```

[releases]: https://github.com/smbl64/humble-cli/releases
[hb-site]: https://www.humblebundle.com/
[guide-chrome]: https://github.com/smbl64/humble-cli/blob/master/docs/session-key-chrome.md
[guide-firefox]: https://github.com/smbl64/humble-cli/blob/master/docs/session-key-firefox.md
[guide-safari]: https://github.com/smbl64/humble-cli/blob/master/docs/session-key-safari.md