https://github.com/firestreaker2/hentairead-cli
CLI tool to quickly interact with hentairead.com
https://github.com/firestreaker2/hentairead-cli
cli commander hentai js npm
Last synced: 5 months ago
JSON representation
CLI tool to quickly interact with hentairead.com
- Host: GitHub
- URL: https://github.com/firestreaker2/hentairead-cli
- Owner: FireStreaker2
- License: mit
- Created: 2024-01-12T05:49:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-01T22:00:52.000Z (over 1 year ago)
- Last Synced: 2025-03-25T04:23:25.722Z (over 1 year ago)
- Topics: cli, commander, hentai, js, npm
- Language: JavaScript
- Homepage: https://npmjs.com/package/hentairead-cli
- Size: 89.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
hentairead-cli
# 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.
```bash
$ npm i -g hentairead-cli
```
## Commands
```console
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 Download a doujin locally
info Get the info for a doujin
search [options] Search for a doujin
view View a doujin locally
help [command] display help for command
```
## Example
```bash
$ 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
```json
{
"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](https://discord.com/developers). An example can be found [here](https://discord.com/developers/docs/getting-started).
> 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:
```bash
$ hentai config -k showImage -v false
```
# License
[MIT](https://github.com/FireStreaker2/hentairead-cli/blob/main/README.md)