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 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 (Gentoo)
  33 =====================
  34 .. code-block::
  35
  36     layman -fa glicOne
  37     sudo emerge net-misc/nhentai
  38
  39 =====
  40 Usage
  41 =====
  42 **IMPORTANT**: To bypass the nhentai frequency limit, you should use `--cookie` option to store your cookie.
  43
  44 *The default download folder will be the path where you run the command (CLI path).*
  45
  46
  47 Set your nhentai cookie against captcha:
  48
  49 .. code-block:: bash
  50
  51     nhentai --cookie "YOUR COOKIE FROM nhentai.net"
  52
  53 Download specified doujinshi:
  54
  55 .. code-block:: bash
  56
  57     nhentai --id=123855,123866
  58
  59 Download doujinshi with ids specified in a file (doujinshi ids split by line):
  60
  61 .. code-block:: bash
  62
  63     nhentai --file=doujinshi.txt
  64
  65 Search a keyword and download the first page:
  66
  67 .. code-block:: bash
  68
  69     nhentai --search="tomori" --page=1 --download
  70
  71 Download by tag name:
  72
  73 .. code-block:: bash
  74
  75     nhentai --tag lolicon --download --page=2
  76
  77 Download by language:
  78
  79 .. code-block:: bash
  80
  81     nhentai --language english --download --page=2
  82
  83 Download by artist name:
  84
  85 .. code-block:: bash
  86
  87     nhentai --artist henreader --download
  88
  89 Download by character name:
  90
  91 .. code-block:: bash
  92
  93     nhentai --character "kuro von einsbern" --download
  94
  95 Download by parody name:
  96
  97 .. code-block:: bash
  98
  99     nhentai --parody "the idolmaster" --download
 100
 101 Download by group name:
 102
 103 .. code-block:: bash
 104
 105     nhentai --group clesta --download
 106
 107 Download using multiple tags (--tag, --character, --paordy and --group supported):
 108
 109 .. code-block:: bash
 110
 111     nhentai --tag "lolicon, teasing" --artist "tamano kedama, atte nanakusa"
 112
 113 Download your favorites with delay:
 114
 115 .. code-block:: bash
 116
 117     nhentai --favorites --download --delay 1
 118
 119 Format output doujinshi folder name:
 120
 121 .. code-block:: bash
 122
 123     nhentai --id 261100 --format '[%i]%s'
 124
 125 Supported doujinshi folder formatter:
 126
 127 - %i: Doujinshi id
 128 - %t: Doujinshi name
 129 - %s: Doujinshi subtitle (translated name)
 130 - %a: Doujinshi authors' name
 131
 132
 133 Other options:
 134
 135 .. code-block::
 136
 137     Options:
 138       # Operation options
 139       -h, --help            show this help message and exit
 140       -D, --download        download doujinshi (for search results)
 141       -S, --show            just show the doujinshi information
 142
 143       # Doujinshi options
 144       --id=ID               doujinshi ids set, e.g. 1,2,3
 145       -s KEYWORD, --search=KEYWORD
 146                             search doujinshi by keyword
 147       --tag=TAG             download doujinshi by tag
 148       -F, --favorites       list or download your favorites.
 149
 150       # Multi-page options
 151       --page=PAGE           page number of search results
 152       --max-page=MAX_PAGE   The max page when recursive download tagged doujinshi
 153
 154       # Download options
 155       -o OUTPUT_DIR, --output=OUTPUT_DIR
 156                             output dir
 157       -t THREADS, --threads=THREADS
 158                             thread count for downloading doujinshi
 159       -T TIMEOUT, --timeout=TIMEOUT
 160                             timeout for downloading doujinshi
 161       -d DELAY, --delay=DELAY
 162                             slow down between downloading every doujinshi
 163       -p PROXY, --proxy=PROXY
 164                             uses a proxy, for example: http://127.0.0.1:1080
 165       -f FILE, --file=FILE  read gallery IDs from file.
 166       --format=NAME_FORMAT  format the saved folder name
 167
 168       # Generating options
 169       --html                generate a html viewer at current directory
 170       --no-html             don't generate HTML after downloading
 171       --gen-main            generate a main viewer contain all the doujin in the folder
 172       -C, --cbz             generate Comic Book CBZ File
 173       --rm-origin-dir       remove downloaded doujinshi dir when generated CBZ
 174                             file.
 175
 176       # nHentai options
 177       --cookie=COOKIE       set cookie of nhentai to bypass Google recaptcha
 178
 179
 180 ==============
 181 nHentai Mirror
 182 ==============
 183 If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.
 184 For example:
 185
 186 .. code-block::
 187
 188     i.h.loli.club -> i.nhentai.net
 189     h.loli.club -> nhentai.net
 190
 191 Set `NHENTAI` env var to your nhentai mirror.
 192
 193 .. code-block:: bash
 194
 195     NHENTAI=http://h.loli.club nhentai --id 123456
 196
 197
 198 .. image:: ./images/search.png?raw=true
 199     :alt: nhentai
 200     :align: center
 201 .. image:: ./images/download.png?raw=true
 202     :alt: nhentai
 203     :align: center
 204 .. image:: ./images/viewer.png?raw=true
 205     :alt: nhentai
 206     :align: center
 207
 208 ============
 209 あなたも変態
 210 ============
 211 .. image:: ./images/image.jpg?raw=true
 212     :alt: nhentai
 213     :align: center
 214
 215
 216
 217 .. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master
 218    :target: https://travis-ci.org/RicterZ/nhentai
 219
 220 .. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg
 221    :target: https://pypi.org/project/nhentai/
 222
 223 .. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg
 224    :target: https://github.com/RicterZ/nhentai/blob/master/LICENSE