pixiv-cli

Pixiv CLI · MCP stdio server · Go SDK

English · 简体中文

Install · Quick start · Interfaces · Documentation · Contributing

pixiv-cli brings the Pixiv ecosystem to the terminal: discover works and creators, manage accounts and collections, follow artists, bookmark artworks, and download visual works. It is an independent, unofficial third-party CLI, MCP server, and public Go SDK; it is not affiliated with or endorsed by Pixiv Inc. The CLI and MCP server both call the same public Go SDK, with the Pixiv App API as the authenticated source of truth. Use it in accordance with Pixiv's terms and applicable law.

Why pixiv-cli?

• One capability surface — keyword search, details, rankings, recommendations, users, bookmarks, follows, downloads, and ugoira across CLI, MCP, and SDK; reverse-image search is integrated into the CLI/MCP surface.
• Read-only FANBOX access — authenticate with FANBOXSESSID, inspect creators, posts, home/supporting feeds, tags, and first-party file resources through the CLI, MCP, or sdk/fanbox.
• Composable visual pipelines — visual lists automatically emit canonical NDJSON when piped; use --filter for typed local artwork rules and pass matching records straight to download.
• Local account pools — enable database-backed scheduling for read workloads with pixiv auth pool status|enable|disable; selection honors Pixiv Retry-After responses without exposing credentials.
• Guided account sign-in — complete browser OAuth with pixiv auth login, then use auth list, auth use, and auth check to manage local multi-account access.
• Ugoira output modes — choose GIF or APNG; invalid or empty filename templates use a stable default and remain observable as warnings.
• Explicit download reporting — select image quality and closed page ranges, use allowlisted Pixiv CDN URLs as direct sources, and keep completed files, warnings, and failures observable.
• Authenticated App API discovery — read R18 details, pages, ugoira metadata, and all 16 ranking modes through the App API; artwork search/detail retains available viewer state and series metadata, and unfiltered deep search pages start at the target raw offset. See the CLI reference.
• Useful search filters — rating, content type, AI mode, aspect ratio, resolution, and a versioned drawing-tool catalog; reverse-image search can query SauceNAO or ascii2d from a local file or URL.
• Direct Pixiv references — paste supported artwork URLs into detail or download; authenticated profile and artworks URLs expand to that creator's visual works.
• Local multi-account OAuth — browser login, account selection, refresh-token rotation, and an optional cross-machine callback relay.
• Automation-ready integration — typed SDK errors, JSON output, clean MCP stdio, signed release updates, and complete result reporting.

Install

Installer scripts (Windows, Linux, and macOS)

Linux/macOS (sh):

curl -fsSLo /tmp/pixiv-install.sh https://github.com/FlanChanXwO/pixiv-cli/releases/latest/download/install.sh && sh /tmp/pixiv-install.sh --add-to-path

Windows Command Prompt (cmd.exe, no PowerShell):