About

hentairead-cli is a way to quickly download and read hentai, from your terminal.

Usage

Installation

In order to install hentairead-cli, you must have nodejs and npm installed.

$ npm i -g hentairead-cli

Commands

Usage: hentai [options] [command]

CLI tool to quickly interact with hentairead.com

Options:
  -V, --version              output the version number
  -h, --help                 display help for command

Commands:
  config [options]           See and set your configuration
  download <string>          Download a doujin locally
  info <string>              Get the info for a doujin
  search [options] <string>  Search for a doujin
  view <string>              View a doujin locally
  help [command]             display help for command

Example

$ hentai search neko
$ hentai info nekomimi-chan-wa-toroketai
$ hentai download nekomimi-chan-wa-toroketai
$ hentai view ./nekomimi-chan-wa-toroketai/0.jpg

Configuration

hentairead-cli comes with a settings.json file used for customizing the output. Currently, there are a few valid options that will affect hentairead-cli.

Options

| Option | Description | Value | |--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| | showImage | Whether or not to show a low resolution image in the terminal. Triggers after running the info or search command. Note that if you use iTerm, the image will be displayed in full resolution. | true / false | | discordRpc | Whether or not to enable Discord rich presence after running the view command. | true / false | | discordRpcID | ID of the Discord application used for rich presence. | Discord application ID |

Example settings.json file

{
  "showImage": "true",
  "discordRpc": "true",
  "discordRpcID": "1197355953650143322"
}

Custom Discord RPC Application

To customize the name of the Discord Rich Prescence, you can make your own application via the Discord Developer Panel. An example can be found here.

Note that you do not need to make a bot, you can just copy the client ID.

Editing the configuration

Currently, there are two ways to edit the configuration. You can either edit the file directly, or you can use the config command. For example:

$ hentai config -k showImage -v false

License

MIT