https://github.com/firestreaker2/pixiv-cli
CLI tool for pixiv
https://github.com/firestreaker2/pixiv-cli
cli pixiv
Last synced: 10 months ago
JSON representation
CLI tool for pixiv
- Host: GitHub
- URL: https://github.com/firestreaker2/pixiv-cli
- Owner: FireStreaker2
- License: mit
- Created: 2024-07-09T23:00:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-20T22:04:24.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T04:20:11.542Z (over 1 year ago)
- Topics: cli, pixiv
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/pixiv-cli
- Size: 32.2 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
pixiv-cli
# About
pixiv-cli is an easy way to interact with pixiv through a terminal. It supports most read only actions, via the usage of [pixiv-node](https://github.com/FireStreaker2/pixiv-node).
https://github.com/user-attachments/assets/6f429187-69ab-4680-aed4-d99340eafb35
# Usage
## Installation
```bash
$ npm i -g pixiv-cli
```
## Commands
```console
Usage: pixiv [options] [command]
CLI tool for pixiv
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
download|d [options] Download a specific post
info|i [options] Get info on a specific post
login|l Login to pixiv with your browser cookie
search|s [options] Search pixiv for a post
user|u [options] Get the info of a user
help [command] display help for command
```
## Images
pixiv-cli supports displaying preview images if the terminal supports the [Kitty Graphics Protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/). To enable it, use the `-i`/`--image` flag with the info or search command.
## Example
```bash
$ pixiv login $PIXIV_COOKIE
$ pixiv search "gawr gura" -aim "r18"
$ pixiv info 119640517 -i
$ pixiv download 119640517 -d homework
```
# Development
```bash
$ git clone https://github.com/FireStreaker2/pixiv-cli.git
$ cd pixiv-cli
$ npm i
$ npm run build
```
# License
[MIT](https://github.com/FireStreaker2/hentairead-cli/blob/main/README.md)