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/user-attachments/assets/6f429187-69ab-4680-aed4-d99340eafb35

Usage

Installation

$ npm i -g pixiv-cli

Commands

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] <id>   Download a specific post
  info|i [options] <id>       Get info on a specific post
  login|l <cookie>            Login to pixiv with your browser cookie
  search|s [options] <query>  Search pixiv for a post
  user|u [options] <id>       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. To enable it, use the -i/--image flag with the info or search command.

Example

$ pixiv login $PIXIV_COOKIE
$ pixiv search "gawr gura" -aim "r18"
$ pixiv info 119640517 -i
$ pixiv download 119640517 -d homework

Development

$ git clone https://github.com/FireStreaker2/pixiv-cli.git
$ cd pixiv-cli
$ npm i
$ npm run build

License

MIT