README.rst

   1 nhentai
   2 =======
   3
   4 .. code-block::
   5
   6            _   _            _        _
   7      _ __ | | | | ___ _ __ | |_ __ _(_)
   8     | '_ \| |_| |/ _ \ '_ \| __/ _` | |
   9     | | | |  _  |  __/ | | | || (_| | |
  10     |_| |_|_| |_|\___|_| |_|\__\__,_|_|
  11
  12
  13 あなたも変態。 いいね?
  14
  15 |travis|
  16 |pypi|
  17 |license|
  18
  19
  20 nHentai is a CLI tool for downloading doujinshi from <http://nhentai.net>
  21
  22 ===================
  23 Manual Installation
  24 ===================
  25 .. code-block::
  26
  27     git clone https://github.com/RicterZ/nhentai
  28     cd nhentai
  29     python setup.py install
  30
  31 ==================
  32 Installation (pip)
  33 ==================
  34 Alternatively, install from PyPI with pip:
  35
  36 .. code-block::
  37
  38            pip install nhentai
  39
  40 For a self-contained installation, use `Pipx <https://github.com/pipxproject/pipx/>`_:
  41
  42 .. code-block::
  43
  44            pipx install nhentai
  45
  46 =====================
  47 Installation (Gentoo)
  48 =====================
  49 .. code-block::
  50
  51     layman -fa glicOne
  52     sudo emerge net-misc/nhentai
  53
  54 =====================
  55 Installation (NixOs)
  56 =====================
  57 .. code-block::
  58
  59     nix-env -iA nixos.nhentai
  60
  61 =====
  62 Usage
  63 =====
  64 **IMPORTANT**: To bypass the nhentai frequency limit, you should use `--cookie` option to store your cookie.
  65
  66 *The default download folder will be the path where you run the command (CLI path).*
  67
  68
  69 Set your nhentai cookie against captcha:
  70
  71 .. code-block:: bash
  72
  73     nhentai --cookie "YOUR COOKIE FROM nhentai.net"
  74
  75 **NOTE**
  76
  77 - The format of the cookie is `"csrftoken=TOKEN; sessionid=ID; cf_clearance=CLOUDFLARE"`
  78 - `cf_clearance` cookie and useragent must be set if you encounter "blocked by cloudflare captcha" error. Make sure you use the same IP and useragent as when you got it
  79
  80 | To get csrftoken and sessionid, first login to your nhentai account in web browser, then:
  81 | (Chrome) |ve| |ld| More tools    |ld| Developer tools     |ld| Application |ld| Storage |ld| Cookies |ld| https://nhentai.net
  82 | (Firefox) |hv| |ld| Web Developer |ld| Web Developer Tools                  |ld| Storage |ld| Cookies |ld| https://nhentai.net
  83 |
  84
  85 .. |hv| unicode:: U+2630 .. https://www.compart.com/en/unicode/U+2630
  86 .. |ve| unicode:: U+22EE .. https://www.compart.com/en/unicode/U+22EE
  87 .. |ld| unicode:: U+2014 .. https://www.compart.com/en/unicode/U+2014
  88
  89 Download specified doujinshi:
  90
  91 .. code-block:: bash
  92
  93     nhentai --id=123855,123866
  94
  95 Download doujinshi with ids specified in a file (doujinshi ids split by line):
  96
  97 .. code-block:: bash
  98
  99     nhentai --file=doujinshi.txt
 100
 101 Set search default language
 102
 103 .. code-block:: bash
 104
 105     nhentai --language=english
 106
 107 Search a keyword and download the first page:
 108
 109 .. code-block:: bash
 110
 111     nhentai --search="tomori" --page=1 --download
 112     # you also can download by tags and multiple keywords
 113     nhentai --search="tag:lolicon, artist:henreader, tag:full color"
 114     nhentai --search="lolicon, henreader, full color"
 115
 116 Download your favorites with delay:
 117
 118 .. code-block:: bash
 119
 120     nhentai --favorites --download --delay 1
 121
 122 Format output doujinshi folder name:
 123
 124 .. code-block:: bash
 125
 126     nhentai --id 261100 --format '[%i]%s'
 127
 128 Supported doujinshi folder formatter:
 129
 130 - %i: Doujinshi id
 131 - %t: Doujinshi name
 132 - %s: Doujinshi subtitle (translated name)
 133 - %a: Doujinshi authors' name
 134 - %p: Doujinshi pretty name
 135
 136
 137 Other options:
 138
 139 .. code-block::
 140
 141     Options:
 142       # Operation options
 143       -h, --help            show this help message and exit
 144       -D, --download        download doujinshi (for search results)
 145       -S, --show            just show the doujinshi information
 146
 147       # Doujinshi options
 148       --id=ID               doujinshi ids set, e.g. 1,2,3
 149       -s KEYWORD, --search=KEYWORD
 150                             search doujinshi by keyword
 151       --tag=TAG             download doujinshi by tag
 152       -F, --favorites       list or download your favorites.
 153
 154       # Multi-page options
 155       --page=PAGE           page number of search results
 156       --max-page=MAX_PAGE   The max page when recursive download tagged doujinshi
 157
 158       # Download options
 159       -o OUTPUT_DIR, --output=OUTPUT_DIR
 160                             output dir
 161       -t THREADS, --threads=THREADS
 162                             thread count for downloading doujinshi
 163       -T TIMEOUT, --timeout=TIMEOUT
 164                             timeout for downloading doujinshi
 165       -d DELAY, --delay=DELAY
 166                             slow down between downloading every doujinshi
 167       -p PROXY, --proxy=PROXY
 168                             uses a proxy, for example: http://127.0.0.1:1080
 169       -f FILE, --file=FILE  read gallery IDs from file.
 170       --format=NAME_FORMAT  format the saved folder name
 171
 172       # Generating options
 173       --html                generate a html viewer at current directory
 174       --no-html             don't generate HTML after downloading
 175       --gen-main            generate a main viewer contain all the doujin in the folder
 176       -C, --cbz             generate Comic Book CBZ File
 177       -P --pdf              generate PDF file
 178       --rm-origin-dir       remove downloaded doujinshi dir when generated CBZ
 179                             or PDF file.
 180
 181       # nHentai options
 182       --cookie=COOKIE       set cookie of nhentai to bypass Google recaptcha
 183
 184
 185 ==============
 186 nHentai Mirror
 187 ==============
 188 If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.
 189 For example:
 190
 191 .. code-block::
 192
 193     i.h.loli.club -> i.nhentai.net
 194     h.loli.club -> nhentai.net
 195
 196 Set `NHENTAI` env var to your nhentai mirror.
 197
 198 .. code-block:: bash
 199
 200     NHENTAI=http://h.loli.club nhentai --id 123456
 201
 202
 203 .. image:: ./images/search.png?raw=true
 204     :alt: nhentai
 205     :align: center
 206 .. image:: ./images/download.png?raw=true
 207     :alt: nhentai
 208     :align: center
 209 .. image:: ./images/viewer.png?raw=true
 210     :alt: nhentai
 211     :align: center
 212
 213 ============
 214 あなたも変態
 215 ============
 216 .. image:: ./images/image.jpg?raw=true
 217     :alt: nhentai
 218     :align: center
 219
 220
 221
 222 .. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master
 223    :target: https://travis-ci.org/RicterZ/nhentai
 224
 225 .. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg
 226    :target: https://pypi.org/project/nhentai/
 227
 228 .. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg
 229    :target: https://github.com/RicterZ/nhentai/blob/master/LICENSE