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 .. code-block:: bash
  78
  79     nhentai --artist henreader --download
  80
  81 .. code-block:: bash
  82
  83     nhentai --character kuro von einsbern --download
  84
  85 .. code-block:: bash
  86
  87     nhentai --parody the idolmaster --download
  88
  89 .. code-block:: bash
  90
  91     nhentai --group clesta --download
  92
  93 Download with multiple tags (--tag, --character, --paordy and --group supported):
  94
  95 .. code-block:: bash
  96
  97     nhentai --tag lolicon, teasing --artist tamano kedama, atte nanakusa
  98
  99 Download your favorites with delay:
 100
 101 .. code-block:: bash
 102
 103     nhentai --favorites --download --delay 1
 104
 105 Format output doujinshi folder name:
 106
 107 .. code-block:: bash
 108
 109     nhentai --id 261100 --format '[%i]%s'
 110
 111 Supported doujinshi folder formatter:
 112
 113 - %i: Doujinshi id
 114 - %t: Doujinshi name
 115 - %s: Doujinshi subtitle (translated name)
 116 - %a: Doujinshi authors' name
 117
 118
 119 Other options:
 120
 121 .. code-block::
 122
 123     Options:
 124       # Operation options
 125       -h, --help            show this help message and exit
 126       -D, --download        download doujinshi (for search results)
 127       -S, --show            just show the doujinshi information
 128
 129       # Doujinshi options
 130       --id=ID               doujinshi ids set, e.g. 1,2,3
 131       -s KEYWORD, --search=KEYWORD
 132                             search doujinshi by keyword
 133       --tag=TAG             download doujinshi by tag
 134       -F, --favorites       list or download your favorites.
 135
 136       # Multi-page options
 137       --page=PAGE           page number of search results
 138       --max-page=MAX_PAGE   The max page when recursive download tagged doujinshi
 139
 140       # Download options
 141       -o OUTPUT_DIR, --output=OUTPUT_DIR
 142                             output dir
 143       -t THREADS, --threads=THREADS
 144                             thread count for downloading doujinshi
 145       -T TIMEOUT, --timeout=TIMEOUT
 146                             timeout for downloading doujinshi
 147       -d DELAY, --delay=DELAY
 148                             slow down between downloading every doujinshi
 149       -p PROXY, --proxy=PROXY
 150                             uses a proxy, for example: http://127.0.0.1:1080
 151       -f FILE, --file=FILE  read gallery IDs from file.
 152       --format=NAME_FORMAT  format the saved folder name
 153
 154       # Generating options
 155       --html                generate a html viewer at current directory
 156       --no-html             don't generate HTML after downloading
 157       -C, --cbz             generate Comic Book CBZ File
 158       --rm-origin-dir       remove downloaded doujinshi dir when generated CBZ
 159                             file.
 160
 161       # nHentai options
 162       --cookie=COOKIE       set cookie of nhentai to bypass Google recaptcha
 163
 164
 165 ==============
 166 nHentai Mirror
 167 ==============
 168 If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.
 169 For example:
 170
 171 .. code-block::
 172
 173     i.h.loli.club -> i.nhentai.net
 174     h.loli.club -> nhentai.net
 175
 176 Set `NHENTAI` env var to your nhentai mirror.
 177
 178 .. code-block:: bash
 179
 180     NHENTAI=http://h.loli.club nhentai --id 123456
 181
 182
 183 .. image:: ./images/search.png?raw=true
 184     :alt: nhentai
 185     :align: center
 186 .. image:: ./images/download.png?raw=true
 187     :alt: nhentai
 188     :align: center
 189 .. image:: ./images/viewer.png?raw=true
 190     :alt: nhentai
 191     :align: center
 192
 193 ============
 194 あなたも変態
 195 ============
 196 .. image:: ./images/image.jpg?raw=true
 197     :alt: nhentai
 198     :align: center
 199
 200
 201
 202 .. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master
 203    :target: https://travis-ci.org/RicterZ/nhentai
 204
 205 .. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg
 206    :target: https://pypi.org/project/nhentai/
 207
 208 .. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg
 209    :target: https://github.com/RicterZ/nhentai/blob/master/LICENSE