]> git.lizzy.rs Git - nhentai.git/blob - README.md
modify tests #54
[nhentai.git] / README.md
1 nhentai\r
2 =======\r
3            _   _            _        _\r
4      _ __ | | | | ___ _ __ | |_ __ _(_)\r
5     | '_ \| |_| |/ _ \ '_ \| __/ _` | |\r
6     | | | |  _  |  __/ | | | || (_| | |\r
7     |_| |_|_| |_|\___|_| |_|\__\__,_|_|\r
8 \r
9 あなたも変態。 いいね?  \r
10 [![Build Status](https://travis-ci.org/RicterZ/nhentai.svg?branch=master)](https://travis-ci.org/RicterZ/nhentai) ![nhentai PyPI Downloads](https://img.shields.io/pypi/dm/nhentai.svg) [![license](https://img.shields.io/cocoapods/l/AFNetworking.svg)](https://github.com/RicterZ/nhentai/blob/master/LICENSE)\r
11 \r
12 \r
13 nHentai is a CLI tool for downloading doujinshi from [nhentai.net](http://nhentai.net).\r
14 \r
15 ### Installation\r
16 \r
17     git clone https://github.com/RicterZ/nhentai\r
18     cd nhentai\r
19     python setup.py install\r
20     \r
21 ### Installation (Gentoo)\r
22 \r
23     layman -fa glicOne\r
24     sudo emerge net-misc/nhentai\r
25 \r
26 ### Usage\r
27 **IMPORTANT**: To bypass the nhentai frequency limit, you should use `--login` option to log into nhentai.net.\r
28 \r
29 *The default download folder will be the path where you run the command (CLI path).*\r
30 \r
31 Download specified doujinshi:\r
32 ```bash\r
33 nhentai --id=123855,123866\r
34 ```\r
35 \r
36 Download doujinshi with ids specified in a file:\r
37 ```bash\r
38 nhentai --file=doujinshi.txt\r
39 ```\r
40 \r
41 Search a keyword and download the first page:\r
42 ```bash\r
43 nhentai --search="tomori" --page=1 --download\r
44 ```\r
45 \r
46 Download your favourite doujinshi (login required):\r
47 ```bash\r
48 nhentai --login "username:password" --download\r
49 ```\r
50 \r
51 Download by tag name:\r
52 ```bash\r
53 nhentai --tag lolicon --download\r
54 ```\r
55 \r
56 ### Options\r
57 \r
58 + `-t, --thread`: Download threads, max: 10  \r
59 + `--output`:Output dir of saving doujinshi  \r
60 + `--tag`:Download by tag name  \r
61 + `--timeout`: Timeout of downloading each image   \r
62 + `--proxy`: Use proxy, example: http://127.0.0.1:8080/  \r
63 + `--login`: username:password pair of your nhentai account  \r
64 + `--nohtml`: Do not generate HTML  \r
65 + `--cbz`: Generate Comic Book CBZ File  \r
66 \r
67 ### nHentai Mirror\r
68 If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.\r
69 For example:\r
70 \r
71     i.h.loli.club -> i.nhentai.net\r
72     h.loli.club -> nhentai.net\r
73 \r
74 Set `NHENTAI` env var to your nhentai mirror.\r
75 ```bash\r
76 NHENTAI=http://h.loli.club nhentai --id 123456\r
77 ```\r
78 \r
79 ![](./images/search.png)  \r
80 ![](./images/download.png)  \r
81 ![](./images/viewer.png)  \r
82 \r
83 ### あなたも変態\r
84 ![](./images/image.jpg)\r