---

English / 简体中文

PixivFE is an open-source, self-hostable alternative front-end for pixiv that prioritizes accessibility, privacy, and freedom.

The quickest way to use PixivFE is through our official public instance, or by using a community-maintained one.

For self-hosting, we maintain a setup guide and provide multi-arch OCI images for linux/amd64 and linux/arm64. We also offer pre-compiled binaries for Linux, macOS (Apple Silicon), FreeBSD, OpenBSD, and Windows.

For more information, installation guides, and our development roadmap, visit our documentation.

For support, questions, or feedback, join our Matrix room or use the issue tracker. You can also contact VnPower directly.

Why should I use it?

PixivFE lets you enjoy content on pixiv without needing an account or dealing with age restrictions. All processing happens server-side, and you never interact with pixiv's tracking services or third-party analytics.

The interface uses progressive enhancement to function without JavaScript while adding optional features when available. Text contrast follows WCAG standards, and the responsive design includes touch-optimized controls for mobile devices.

What PixivFE is not

PixivFE is not a product developed by pixiv, nor is it intended as a content scraping tool. It's also not a complete pixiv client replacement - many features are still missing. Check our roadmap and scope to understand current limitations and planned features.

Localizing UI

We use GNU gettext to translate PixivFE's UI to languages other than English.

To translate

1. Wrap strings to translate inside i18n. functions (see ./i18n/doc.go)
2. Generate translation source (./po/pixivfe.pot) by running ./build.sh i18n_extract i18n_validate
3. Modify the translation target of a specific language (./po/<lang>.po)
   • edit the file directly
   • edit in Weblate (web interface)

For more detals, see ./docs/dev/i18n.md.

Building

To build PixivFE, you need Go 1.24.0 or higher.

To build the binary, run ./build.sh build_binary.

Development

To contribute to frontend development, you will need to install the standalone executable for Tailwind CSS CLI.

For internationalization, developers should refer to the package documentation in i18n/doc.go for API usage.

For project management, we use Gitlab issues and boards.

Note that the project is hosted on two synchronized repositories. Codeberg is our primary repository where all issues and pull requests should be submitted. GitLab handles our CI/CD pipelines. Commits to either repository automatically sync with the other.

To run PixivFE in development mode, run the following script:

export PIXIVFE_DEV=true PIXIVFE_SAVE_RESPONSES=true
export PIXIVFE_TOKEN=<YOUR_PIXIV_USER_TOKEN>
./build.sh run

To see all available build commands, use ./build.sh help.

We also offer several alternative methods to create a development environment:

• Nix: nix-shell
• GNU Guix: guix shell go python python-requests -- ./build.sh run

Controlling the CI/CD pipeline

The behavior of the CI/CD pipeline can be altered by including specific commands in a Git commit message. The following commands are available:

Command	Description
[skip ci]	Prevents the entire pipeline from running.
[skip build]	Skips the jobs for building and publishing binaries.
[skip docs]	Skips the jobs for building and publishing documentation.
[rebuild builder]	Forces a rebuild of the builder OCI image.
[rebuild docs-builder]	Forces a rebuild of the docs-builder OCI image.
[rebuild wrangler-builder]	Forces a rebuild of the wrangler-builder OCI image.
[rebuild CI images]	Forces a rebuild of all CI OCI images.

License

PixivFE is free software licensed under the GNU Affero General Public License v3.0 only.

Copyright 2023 - 2025, VnPower and the PixivFE contributors.

SPDX-License-Identifier: AGPL-3.0-only