# hentairead-cli

> CLI tool to quickly interact with hentairead.com

Latest version **1.0.3** (published 2025-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install hentairead-cli
pnpm add hentairead-cli
yarn add hentairead-cli
bun add hentairead-cli
```

Provides the command `hentai`.

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2025-02-01 |
| First published | 2024-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | FireStreaker2 |
| Maintainers | firestreaker2 |
| Keywords | hentai, cli |

## Links

- npm: https://www.npmjs.com/package/hentairead-cli
- Repository: https://github.com/FireStreaker2/hentairead-cli
- Homepage: https://github.com/FireStreaker2/hentairead-cli#readme
- Issues: https://github.com/FireStreaker2/hentairead-cli/issues
- npm.io page: https://npm.io/package/hentairead-cli

## Dependencies (8)

- [open](https://npm.io/package/open.md) ^10.0.3
- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [commander](https://npm.io/package/commander.md) ^11.1.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2
- [discord-rpc](https://npm.io/package/discord-rpc.md) ^4.0.1
- [cli-progress](https://npm.io/package/cli-progress.md) ^3.12.0
- [hentairead-js](https://npm.io/package/hentairead-js.md) ^1.0.3
- [terminal-image](https://npm.io/package/terminal-image.md) ^2.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2025-02-01
- 1.0.2 — 2024-07-06
- 1.0.1 — 2024-01-27
- 1.0.0 — 2024-01-25

## README

<div align="center">
  <img src="https://hentairead.com/favicon.ico" />
  <h1>hentairead-cli</h1>
</div>

# 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 <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
```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)

---
_Source: https://npm.io/package/hentairead-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
