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