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 あなたも変態。 いいね?  \r
  14 |travis|\r
  15 |pypi|\r
  16 |license|\r
  17 \r
  18 \r
  19 nHentai is a CLI tool for downloading doujinshi from <http://nhentai.net>\r
  20 \r
  21 ============\r
  22 Installation\r
  23 ============\r
  24 .. code-block::\r
  25 \r
  26     git clone https://github.com/RicterZ/nhentai\r
  27     cd nhentai\r
  28     python setup.py install\r
  29     \r
  30 =====================\r
  31 Installation (Gentoo)\r
  32 =====================\r
  33 .. code-block::\r
  34 \r
  35     layman -fa glicOne\r
  36     sudo emerge net-misc/nhentai\r
  37 \r
  38 =====\r
  39 Usage\r
  40 =====\r
  41 **IMPORTANT**: To bypass the nhentai frequency limit, you should use `--login` option to log into nhentai.net.\r
  42 *The default download folder will be the path where you run the command (CLI path).*\r
  43 \r
  44 \r
  45 Set your nhentai cookie aginest captcha:\r
  46 \r
  47 .. code-block:: bash\r
  48 \r
  49     nhentai --cookie 'YOUR COOKIE FROM nhentai.net'\r
  50 \r
  51 Download specified doujinshi:\r
  52 \r
  53 .. code-block:: bash\r
  54 \r
  55     nhentai --id=123855,123866\r
  56 \r
  57 Download doujinshi with ids specified in a file:\r
  58 \r
  59 .. code-block:: bash\r
  60 \r
  61     nhentai --file=doujinshi.txt\r
  62 \r
  63 Search a keyword and download the first page:\r
  64 \r
  65 .. code-block:: bash\r
  66 \r
  67     nhentai --search="tomori" --page=1 --download\r
  68 \r
  69 Download by tag name:\r
  70 \r
  71 .. code-block:: bash\r
  72 \r
  73     nhentai --tag lolicon --download\r
  74 \r
  75 Download your favorites:\r
  76 \r
  77 .. code-block:: bash\r
  78 \r
  79     nhentai --favorites --download\r
  80 \r
  81 =======\r
  82 Options\r
  83 =======\r
  84 + `-t, --thread`: Download threads, max: 10  \r
  85 + `--output`:Output dir of saving doujinshi  \r
  86 + `--tag`:Download by tag name  \r
  87 + `--timeout`: Timeout of downloading each image   \r
  88 + `--proxy`: Use proxy, example: http://127.0.0.1:8080/  \r
  89 + `--login`: username:password pair of your nhentai account  \r
  90 + `--nohtml`: Do not generate HTML  \r
  91 + `--cbz`: Generate Comic Book CBZ File  \r
  92 \r
  93 ==============\r
  94 nHentai Mirror\r
  95 ==============\r
  96 If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.\r
  97 For example:\r
  98 \r
  99 .. code-block:: \r
 100 \r
 101     i.h.loli.club -> i.nhentai.net\r
 102     h.loli.club -> nhentai.net\r
 103 \r
 104 Set `NHENTAI` env var to your nhentai mirror.\r
 105 \r
 106 .. code-block:: bash\r
 107 \r
 108     NHENTAI=http://h.loli.club nhentai --id 123456\r
 109 \r
 110 \r
 111 .. image:: ./images/search.png?raw=true\r
 112     :alt: nhentai\r
 113     :align: center\r
 114 .. image:: ./images/download.png?raw=true\r
 115     :alt: nhentai\r
 116     :align: center\r
 117 .. image:: ./images/viewer.png?raw=true\r
 118     :alt: nhentai\r
 119     :align: center\r
 120 \r
 121 ============\r
 122 あなたも変態\r
 123 ============\r
 124 .. image:: ./images/image.jpg?raw=true\r
 125     :alt: nhentai\r
 126     :align: center\r
 127 \r
 128 \r
 129 \r
 130 .. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master\r
 131    :target: https://travis-ci.org/RicterZ/nhentai\r
 132 \r
 133 .. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg\r
 134    :target: https://pypi.org/project/nhentai/\r
 135 \r
 136 .. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg\r
 137    :target: https://github.com/RicterZ/nhentai/blob/master/LICENSE\r