pixivflow 2.0.41 → 2.1.0

package/README_EN.md

@@ -1,1571 +1,119 @@
-# 🎨 PixivFlow
+# PixivFlow
 
-<div align="center">
+**English** | [中文](https://github.com/redtidev1918/PixivFlow/blob/master/README.md)
 
-**Intelligent Pixiv Automation Downloader | 智能的 Pixiv 自动化下载工具**
+Pixiv batch download and scheduled collection tool. Bulk-download
+illustrations and novels, search by tag, filter by bookmarks and dates,
+and run recurring collection jobs on a schedule. CLI and WebUI included.
+Built with TypeScript and Node.js; runs on Windows, macOS, Linux and Docker.
 
-Make Pixiv artwork collection elegant and efficient | 让 Pixiv 作品收集变得优雅而高效
+[![Version](https://img.shields.io/npm/v/pixivflow?style=flat-square)](https://www.npmjs.com/package/pixivflow)
+[![Node](https://img.shields.io/badge/Node.js-18%2B_LTS-green.svg?style=flat-square&logo=node.js)](https://nodejs.org/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE)
+[![Documentation](https://img.shields.io/badge/Docs-redtidev1918.github.io-6366f1?style=flat-square)](https://redtidev1918.github.io/PixivFlow/)
 
-[![GitHub stars](https://img.shields.io/github/stars/zoidberg-xgd/pixivflow?style=for-the-badge&logo=github)](https://github.com/zoidberg-xgd/pixivflow/stargazers)
-[![GitHub forks](https://img.shields.io/github/forks/zoidberg-xgd/pixivflow?style=for-the-badge&logo=github)](https://github.com/zoidberg-xgd/pixivflow/network/members)
-[![GitHub issues](https://img.shields.io/github/issues/zoidberg-xgd/pixivflow?style=for-the-badge&logo=github)](https://github.com/zoidberg-xgd/pixivflow/issues)
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0)
+## Install
 
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.6+-blue.svg?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)
-[![Node.js](https://img.shields.io/badge/Node.js-18%2B%20LTS-green.svg?style=flat-square&logo=node.js)](https://nodejs.org/)
-[![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg?style=flat-square)](https://github.com/zoidberg-xgd/pixivflow)
-[![Maintenance](https://img.shields.io/badge/Maintained-yes-green.svg?style=flat-square)](https://github.com/zoidberg-xgd/pixivflow/graphs/commit-activity)
-
-[Features](#features) • [Quick Start](#quick-start) • [CLI Commands](#cli-commands) • [Scripts](#script-tools) • [Use Cases](#use-cases)
-
-[📖 Full Documentation](https://zoidberg-xgd.github.io/PixivFlow/) | [English](README_EN.md) | [中文](README.md)
-
-</div>
-
----
-
-<a id="table-of-contents"></a>
-## Table of Contents
-
-<details>
-<summary><b>Click to expand full table of contents</b></summary>
-
-<br>
-
-**Getting Started**
-- [💡 What is PixivFlow?](#what-is-pixivflow)
-  - [🌟 Why Choose PixivFlow?](#why-choose-pixivflow)
-  - [🎯 Core Philosophy](#core-philosophy)
-- [✨ Features](#features)
-  - [🚀 Core Features](#core-features)
-  - [🎁 Additional Advantages](#additional-advantages)
-- [🚀 Quick Start](#quick-start)
-  - [📋 Requirements](#requirements)
-  - [🎬 Quick Start (Recommended)](#quick-start-recommended)
-  - [🎯 Manual Setup](#manual-setup)
-  - [🌐 API Server (Optional)](#api-server-optional)
-  - [🐳 Using Docker (Recommended)](#using-docker-recommended)
-
-**Tools & Documentation**
-- [🎨 CLI Commands](#cli-commands)
-  - [🚀 Core Commands](#core-commands)
-  - [⚙️ Configuration Management](#configuration-management)
-  - [📊 Monitoring and Maintenance](#monitoring-and-maintenance)
-- [🛠️ Script Tools](#script-tools)
-  - [🎯 Main Control Script (Most Used)](#main-control-script-most-used)
-  - [🔐 Login Management](#login-management)
-  - [🐳 Docker Management](#docker-management)
-- [📚 Documentation](#documentation)
-  - [🌟 Must Read for Beginners](#must-read-for-beginners)
-  - [📘 Advanced Documentation](#advanced-documentation)
-  - [🐳 Docker Documentation](#docker-documentation)
-  - [📄 Project Documentation](#project-documentation)
-
-**Usage & Configuration**
-- [🎯 Use Cases](#use-cases)
-  - [Scenario 1: Daily Auto Collection](#scenario-1-daily-auto-collection-of-inspiration-materials)
-  - [Scenario 2: Server Scheduled Collection](#scenario-2-server-scheduled-collection-of-specific-tags)
-  - [Scenario 3: Quick Experience](#scenario-3-quick-experience---random-download)
-  - [Scenario 4: One-Time Batch Download](#scenario-4-onetime-batch-download)
-- [📁 Project Structure](#project-structure)
-- [⚙️ Core Configuration](#core-configuration)
-  - [Authentication Configuration](#authentication-configuration)
-  - [Download Targets](#download-targets)
-  - [Scheduled Tasks](#scheduled-tasks)
-  - [Storage Configuration](#storage-configuration)
-
-**Troubleshooting & Advanced**
-- [🐛 FAQ](docs/USAGE.md)
-- [🔒 Security Tips](docs/USAGE.md)
-- [📊 Download Record Management](docs/USAGE.md)
-- [🚀 Advanced Usage](docs/USAGE.md)
-  - [Deploy on Server](docs/DOCKER.md)
-  - [Configure Multiple Download Tasks](docs/CONFIG.md)
-  - [Using Proxy](docs/USAGE.md)
-
-**Project Information**
-- [📄 Open Source License](#open-source-license)
-- [🙏 Acknowledgments](#acknowledgments)
-- [📮 Get Help](#get-help)
-- [📈 Project Statistics](#project-statistics)
-- [🤝 Contributing](#contributing)
-- [📝 Changelog](#changelog)
-- [Support the Project](#support-the-project)
-
-</details>
-
----
-
-<a id="what-is-pixivflow"></a>
-## What is PixivFlow?
-
-**PixivFlow** is a **fully standalone** Pixiv artwork batch downloader designed for automation. No browser extension required, can run automatically in command line or on servers, supports scheduled tasks, intelligent deduplication, resume download, and more.
-
-As a professional **Pixiv downloader**, PixivFlow supports the following core features:
-- 📥 **Batch Download Pixiv Illustrations and Novels**: Supports batch downloading artworks by tags, users, bookmarks, and other conditions
-- 🔗 **Direct URL Download**: Supports direct input of Pixiv URLs for download without modifying configuration files
-- 🎯 **Single Artwork Download**: Supports downloading single illustrations or novels by artwork ID
-- ⏰ **Scheduled Automatic Download**: Uses Cron expressions to configure scheduled tasks for automated downloads
-
-<a id="why-choose-pixivflow"></a>
-### Why Choose PixivFlow?
-
-Compared to other Pixiv downloaders, PixivFlow focuses on **automation** and **server deployment** scenarios:
-
-| Advantage | Description |
-|-----------|-------------|
-| 🚀 **Fully Standalone** | No browser extension required, pure CLI tool that can run in any environment (servers, Docker, CI/CD) |
-| 🤖 **True Automation** | Set once, run forever. Supports Cron scheduled tasks, no manual intervention needed |
-| 🖥️ **Server Friendly** | Designed for servers, supports background running, process management, log rotation |
-| 🔐 **Secure & Reliable** | Uses OAuth 2.0 PKCE standard flow to ensure account security, avoids password leakage risks |
-| 📦 **Lightweight Deployment** | Low resource usage, no additional services needed (like databases, Redis), SQLite is enough |
-| 🛠️ **Out of the Box** | Rich script tools and setup wizard, get started in 3 steps |
-
-<a id="core-philosophy"></a>
-### Core Philosophy
-
-- **Automation First**: Set once, run automatically, no manual intervention
-- **Intelligent Management**: Auto deduplication, resume download, error retry
-- **Simple & Easy**: 3 steps to get started, setup wizard guides you through
-- **Out of the Box**: Rich script tools, no need to remember complex commands
-
----
-
-<a id="features"></a>
-## Features
-
-<a id="core-features"></a>
-### Core Features
-
-| Feature | Description |
-|---------|-------------|
-| **📥 Batch Download** | Supports batch download of illustrations and novels, configurable download count and filters |
-| **🔗 Direct URL Download** | Supports direct input of Pixiv URLs for download without modifying configuration files |
-| **🎯 Single Artwork Download** | Supports downloading single illustrations or novels by artwork ID |
-| **🏷️ Tag Search** | Search artworks by tags, supports exact match, partial match, and other modes |
-| **🎲 Random Download** | One-click download random popular tag artworks for quick experience |
-| **⏰ Scheduled Tasks** | Cron expression configuration, supports daily, weekly, monthly automatic downloads |
-| **🔍 Smart Filtering** | Multi-dimensional filtering by bookmarks, date range, artwork type, etc. |
-| **💾 Auto Deduplication** | SQLite database records history, automatically skips already downloaded artworks |
-| **🔄 Resume Download** | Automatically resumes after interruption, no need to restart |
-| **🛡️ Error Handling** | Auto retry, error recovery, smart skip deleted/private artworks |
-| **📡 RESTful API** | Complete REST API with authentication, configuration, download, and statistics |
-| **🔌 WebSocket** | Real-time log streaming and download status updates |
-| **📊 Statistics Reports** | Detailed run logs and download statistics |
-
-<a id="additional-advantages"></a>
-### Additional Advantages
-
-- ✅ **Fully Standalone**: No browser required, pure CLI tool
-- ✅ **API Server**: Provides RESTful API and WebSocket, can integrate with any frontend
-- ✅ **npm Package**: Can be installed as npm package, supports global and local installation
-- ✅ **Lightweight**: Low resource usage, suitable for long-term server running
-- ✅ **Open Source**: GPL-3.0 license, free to customize and distribute
-- ✅ **Type Safe**: Written in TypeScript with complete type hints
-- ✅ **Well Documented**: Detailed documentation and tutorials
-
----
-
-<a id="quick-start"></a>
-## Quick Start
-
-<a id="requirements"></a>
-### Requirements
-
-- **Node.js 18+** and **npm 9+** (Recommended: LTS versions 18.x, 20.x, 22.x, or 24.x)
-- **Pixiv account**
-- **Windows users**: Recommended to use WSL (`wsl --install`) or Git Bash
-
-> ⚠️ **Node.js Version Note**:
-> - Recommended to use **LTS (Long Term Support) versions**: 18.x, 20.x, 22.x, or 24.x
-> - Avoid using odd-numbered versions (e.g., 19.x, 21.x, 23.x), as these may not be supported by all dependencies
-> - If you see `EBADENGINE` warnings, consider switching to an LTS version
-> 
-> 💡 **Login Note**: The project uses Node.js library for login by default, **Python is not required**. Python gppt is only used as a fallback option (optional).  
-> 📖 **Detailed Guide**: See [Quick Start Guide](docs/QUICKSTART.md)
-
-<a id="quick-start-recommended"></a>
-### Quick Installation (Recommended ⭐)
-
-#### Method 1: Install from npm (Easiest)
+Requires Node.js 18 or later (LTS).
 
 ```bash
-# Install globally from npm
 npm install -g pixivflow
-
-# Verify installation
 pixivflow --help
-
-# Login to account
-pixivflow login
-
-# Start downloading
-pixivflow download
-```
-
-#### Method 2: Install from Source
-
-```bash
-# 1. Clone the repository
-git clone https://github.com/zoidberg-xgd/pixivflow.git
-cd pixivflow
-
-# 2. Install dependencies
-npm install
-
-# 3. Login to account
-npm run login
-
-# 4. Start downloading
-npm run download
-```
-
-**Or use one-click script** (automatically completes all setup):
-
-```bash
-./scripts/quick-start.sh
-```
-
----
-
-### 🌐 Global Installation (Optional)
-
-If you want to use `pixivflow` command from any directory, you can install it globally:
-
-#### Method 1: Install from npm (Recommended ⭐)
-
-```bash
-# Install globally from npm
-npm install -g pixivflow
 ```
 
-#### Method 2: Install from Local Directory
+For servers, prefer the Docker Compose setup described in
+[DOCKER.md](docs/DOCKER.md). To build from source:
 
 ```bash
-# 1. Clone the repository
-git clone https://github.com/zoidberg-xgd/pixivflow.git
-cd pixivflow
-
-# 2. Install dependencies
+git clone https://github.com/redtidev1918/PixivFlow.git
+cd PixivFlow
 npm install
-
-# 3. Build the project
 npm run build
-
-# 4. Install globally
-npm install -g .
-```
-
-#### Method 3: Install Directly from GitHub Repository
-
-```bash
-# Install globally from GitHub repository
-npm install -g git+https://github.com/zoidberg-xgd/pixivflow.git
-
-# Note: After installation, you may need to build
-# Find the global installation directory (usually in npm root -g's parent directory/bin)
-# Or reinstall with build script specified
 ```
 
-#### Verify Global Installation
-
-After installation, you can use the `pixivflow` command from any directory:
-
-```bash
-# View help
-pixivflow --help
-
-# Check installation location
-which pixivflow
-
-# Login to account
-pixivflow login
-
-# Execute download
-pixivflow download
-
-# Start scheduled task
-pixivflow scheduler
-
-# Normalize and reorganize downloaded files
-pixivflow normalize
-pixivflow normalize --dry-run      # Preview changes without applying
-
-# Migrate configuration paths (convert absolute to relative)
-pixivflow migrate-config
-pixivflow migrate-config --dry-run # Preview migration changes
-```
+Termux / Android: see [TERMUX_INSTALL.md](docs/TERMUX_INSTALL.md).
 
-#### Configuration After Global Installation
+## Quick start
 
-After global installation, the configuration file location:
-- Configuration file: `~/.pixivflow/config/standalone.config.json` (if using default path)
-- Or use `--config` parameter to specify configuration file path
+Sign in to your Pixiv account (creates OAuth credentials, one time):
 
 ```bash
-# Use custom configuration file
-pixivflow download --config /path/to/config.json
-
-# Login (will automatically create configuration file)
-pixivflow login
+pixivflow login                 # desktop with a browser
+pixivflow login-headless        # headless server
 ```
 
-#### Update Global Installation
-
-If you need to update the globally installed version:
+Download something — paste any Pixiv link (artwork, novel, series, or a user
+profile are all recognized):
 
 ```bash
-# Method 1: Reinstall (from local directory)
-cd /path/to/pixivflow
-npm run build
-npm install -g .
-
-# Method 2: Update from GitHub
-npm install -g git+https://github.com/zoidberg-xgd/pixivflow.git
+pixivflow download --url https://www.pixiv.net/artworks/123456789
 ```
 
-> **💡 Tips**:
-> - After global installation, you can use the `pixivflow` command directly from any directory
-> - First use requires running `pixivflow login` to login
-> - Configuration file will be automatically created in user home directory or project directory
-> - npm package: https://www.npmjs.com/package/pixivflow
-
----
-
-### 🎯 Manual Setup
-
-If you want to manually control each step:
-
-#### 1️⃣ Install Dependencies
+Bulk-download from your configured targets and start the scheduler:
 
 ```bash
-npm install
-```
-
-#### 2️⃣ Login to Pixiv Account
-
-```bash
-# Simplest way: Enter username and password in terminal (recommended)
-npm run login
-
-# Or use setup wizard (pure terminal login, interactive config)
-./scripts/easy-setup.sh
-# or
-npm run setup
-```
-
-**Login Notes**:
-- ✅ **Default login mode**: Uses Node.js library for login (no Python required)
-- ✅ **Python fallback option**: Python gppt can be used as a fallback option (optional)
-- ✅ Auto update config: Automatically updates refresh token in config after successful login
-- ✅ Setup wizard: Use `npm run setup` for interactive configuration
-
-#### 3️⃣ Configure Download Options (Optional)
-
-If using `npm run login` to login, you can configure download options later:
-
-```bash
-# Run setup wizard
-./scripts/easy-setup.sh
-# or
-npm run setup
-```
-
-The setup wizard will automatically complete all settings, including:
-- ⚙️ Configure download options (tags, quantity, filters, etc.)
-- ⏰ Scheduled task settings
-
-#### 4️⃣ Start Downloading
-
-```bash
-# Test download (recommended for first use)
-./scripts/pixiv.sh test
-
-# Execute one download
-./scripts/pixiv.sh once
-
-# Start scheduled task
-./scripts/pixiv.sh run
-```
-
-That's it! 🎉
-
-> **💡 Tip**: For first use, it's recommended to run `test` to download 1-2 artworks first, confirm the configuration is correct before formal use.
-> 
-
----
-
-<a id="api-server-optional"></a>
-### WebUI Backend API (Optional)
-
-PixivFlow provides a WebUI backend API service that supports management through RESTful API and WebSocket:
-
-```bash
-# Start WebUI backend API service
-pixivflow webui                    # Default port 3000
-
-# Or specify port via environment variable
-PORT=8080 pixivflow webui
-```
-
-**Main Features**:
-- **Authentication API**: Login, logout, Token management
-- **Configuration Management API**: View, edit, backup, restore configuration
-- **Download Management API**: Start/stop downloads, view task status
-- **Statistics API**: Download statistics, file list
-- **Logs API**: View running logs (supports WebSocket real-time push)
-- **File Management API**: File list, preview, operations
-
-> **Note**:
-> - PixivFlow only provides backend API, does not include frontend interface
-> - **Frontend Project**: Modern React frontend interface, see [pixivflow-webui](https://github.com/zoidberg-xgd/pixivflow-webui)
-> - Can be called directly via API, or connect to other frontend projects
-> - **API Documentation**: See [Usage Guide](docs/USAGE.md) for detailed API usage
-
-
----
-
-<a id="using-docker-recommended"></a>
-### Using Docker (Recommended)
-
-PixivFlow supports Docker deployment, no need to install Node.js environment:
-
-#### Quick Start
-
-```bash
-# 1. Prepare configuration file
-cp config/standalone.config.example.json config/standalone.config.json
-
-# 2. Login to Pixiv account (on host)
-npm run login
-
-# 3. Start scheduled task service
-docker-compose up -d pixivflow
-
-# Or start WebUI service
-docker-compose up -d pixivflow-webui
-
-# Or start both services
-docker-compose up -d
-```
-
-#### Using Script Tools
-
-```bash
-# 1. Initialize Docker environment
-./scripts/pixiv.sh docker setup
-
-# 2. Login to Pixiv account
-./scripts/pixiv.sh docker login
-
-# 3. Build and deploy
-./scripts/pixiv.sh docker deploy
-
-# 4. Check status
-./scripts/pixiv.sh docker status
-
-# 5. View logs
-./scripts/pixiv.sh docker logs -f
-```
-
-#### Docker Services
-
-`docker-compose.yml` provides two services:
-
-1. **pixivflow** - Scheduled task service (default)
-   - Automatically executes scheduled download tasks
-   - Runs continuously in background
-
-2. **pixivflow-webui** - WebUI management interface (optional)
-   - Provides modern web management interface
-   - Access address: http://localhost:3000
-   - Supports file browsing, statistics viewing, task management, etc.
-
-#### Docker Common Commands
-
-```bash
-# Start scheduled task service
-docker-compose up -d pixivflow
-
-# Start WebUI service
-docker-compose up -d pixivflow-webui
-
-# Start both services
-docker-compose up -d
-
-# View logs
-docker-compose logs -f pixivflow
-docker-compose logs -f pixivflow-webui
-
-# Stop services
-docker-compose stop
-
-# Stop and remove containers
-docker-compose down
-
-# Rebuild images
-docker-compose build
-```
-
-#### Docker Script Commands
-
-- `docker setup` - Initialize Docker environment
-- `docker build` - Build Docker image
-- `docker deploy` - Deploy service (build + start)
-- `docker up` - Start service
-- `docker down` - Stop service
-- `docker status` - View service status
-- `docker logs` - View logs
-- `docker login` - Login to account in container
-- `docker random` - Random download artwork (for testing)
-
-> 📖 **Detailed Instructions**: See [Docker Usage Guide](docs/DOCKER.md)
-
----
-
-<a id="cli-commands"></a>
-## CLI Commands
-
-> 💡 **Recommended**: After global installation, you can directly use the `pixivflow` command without relying on scripts in the project directory.
-
-<a id="core-commands"></a>
-### Core Commands
-
-```bash
-# Use after global installation
-pixivflow login                      # Login to Pixiv account
-pixivflow download                   # Execute download
-pixivflow download --url <url>       # Download directly from URL (supports illustration/novel/series) ⭐
-pixivflow random                     # Random download
-pixivflow scheduler                  # Start scheduled task
-pixivflow normalize                  # Normalize files
-pixivflow migrate-config             # Migrate config
-pixivflow health                     # Health check (recommended ⭐)
-pixivflow status                     # View download statistics and recent records
-pixivflow logs                       # View run logs
-pixivflow setup                      # Interactive setup wizard (first time use) ⭐
-pixivflow dirs                       # View directory information (where files are saved) ⭐
-```
-
-**URL Download Examples**:
-```bash
-# Download illustration
-pixivflow download --url "https://www.pixiv.net/artworks/12345678"
-
-# Download novel
-pixivflow download --url "https://www.pixiv.net/novel/show.php?id=26132156"
-
-# Download novel series
-pixivflow download --url "https://www.pixiv.net/novel/series/14690617"
-
-# Download all works from a user
-pixivflow download --url "https://www.pixiv.net/users/123456"
-```
-
-<a id="configuration-management"></a>
-### Configuration Management
-
-```bash
-pixivflow config                     # Config management (view/edit/backup/restore) ⭐
-pixivflow config show                # View config
-pixivflow config set <key> <value>   # Set config value (e.g., storage.downloadDirectory) ⭐
-pixivflow config backup              # Backup config
-pixivflow config restore             # Restore config
-pixivflow config validate            # Validate config
-pixivflow config edit                # Edit config
-```
-
-**Config Set Examples**:
-```bash
-# Set download directory
-pixivflow config set storage.downloadDirectory ./my-downloads
-
-# Set illustration directory
-pixivflow config set storage.illustrationDirectory ./my-illustrations
-
-# Set novel directory
-pixivflow config set storage.novelDirectory ./my-novels
-```
-
-<a id="monitoring-and-maintenance"></a>
-### Monitoring and Maintenance
-
-```bash
-pixivflow monitor                    # Real-time monitoring of process status and performance metrics ⭐
-pixivflow maintain                   # Auto maintenance (clean logs, optimize database, etc.) ⭐
-pixivflow backup                     # Auto backup config and data ⭐
-```
-
-> 📖 **Detailed Instructions**: See [Script Usage Guide](docs/SCRIPTS.md)
-
----
-
-<a id="script-tools"></a>
-## Script Tools
-
-PixivFlow provides rich script tools so you don't need to remember complex npm commands. All scripts directly call built-in CLI functions for better performance and faster response.
-
-<a id="main-control-script-most-used"></a>
-### Main Control Script (Most Used)
-
-```bash
-./scripts/pixiv.sh <command>
-```
-
-| Command | Description |
-|---------|-------------|
-| `setup` | Interactive setup wizard (must run first time) |
-| `login` | Login to Pixiv account (interactive, directly calls built-in CLI) |
-| `test` | Test download (download small amount to verify config) |
-| `once` | Execute one download |
-| `random` | Random download one popular tag artwork (supports `--novel` for novels) |
-| `run` | Start scheduled task (runs continuously in background) |
-| `stop` | Stop running scheduled task |
-| `status` | View current running status |
-| `check` | Environment check (supports `--fix` for auto-fix) ⭐ New |
-| `update` | One-click update and fix (update code, dependencies, fix errors) ⭐ New |
-| `health` | Health check (check config, network, etc.) |
-| `logs` | View run logs |
-
-**💡 Tip**: 
-- All commands directly call built-in CLI, no need to go through npm scripts, faster response.
-- **New Features**: `check --fix` and `update` commands support automatic fixing of common issues.
-
-<a id="login-management"></a>
-### Login Management
-
-```bash
-# Method 1: Use main control script (recommended)
-./scripts/pixiv.sh login
-
-# Method 2: Use login script (supports more options)
-./scripts/login.sh
-
-# Method 3: Use npm command
-npm run login
-
-# Headless login (provide username and password via parameters)
-./scripts/pixiv.sh login -u your_username -p your_password
-```
-
-### ⚙️ Configuration Management
-
-```bash
-# Interactive setup wizard
-./scripts/easy-setup.sh
-
-# Configuration path migration (auto-fix absolute paths, for project migration)
-pixivflow migrate-config              # Execute migration
-pixivflow migrate-config --dry-run     # Preview changes
-pixivflow migrate-config --json        # JSON format output
-# Or use npm command
-npm run start migrate-config          # Execute migration
-npm run start migrate-config --dry-run # Preview changes
-```
-
-### 🔧 Environment Check and Auto-Fix ⭐ New Feature
-
-```bash
-# Basic environment check
-./scripts/pixiv.sh check
-
-# Auto-fix environment issues (recommended ⭐)
-./scripts/pixiv.sh check --fix
-
-# One-click update and fix (update code, dependencies, fix errors)
-./scripts/pixiv.sh update
-
-# Or use alias
-./scripts/pixiv.sh fix
+pixivflow download
+pixivflow scheduler             # long-running cron collection
 ```
 
-**New Feature Description**:
-- ✅ `check --fix`: Automatically install missing dependencies, create config, compile code
-- ✅ `update`: One-click update code, dependencies, and fix common errors
-- ✅ Smart detection: Automatically detect if build artifacts are outdated
-- ✅ Unified error handling: Provide clear error messages and fix suggestions
+## Download targets
 
-### Deployment and Backup
+Define what to collect in the `targets` section of your config. Conditions
+combine:
 
-```bash
-# Auto deploy to server
-./scripts/auto-deploy.sh
-```
+| Field | Meaning | Example |
+| --- | --- | --- |
+| `type` | `illustration` or `novel` | `illustration` |
+| `tag` | Search tag(s); multiple tags are OR'ed | `"風景"` / `["watercolor","impasto"]` |
+| `limit` | Max items per run | `20` |
+| `minBookmarks` | Minimum bookmark count | `500` |
+| `startDate` / `endDate` | Publish date range | `"2025-01-01"` |
 
-<a id="docker-management"></a>
-### Docker Management
+Downloaded items are tracked in a SQLite database and skipped automatically;
+files that exist without a database record are reconciled, so the two never
+conflict.
 
-```bash
-# Use main control script
-./scripts/pixiv.sh docker <command>
+Interactive configuration wizard: `pixivflow setup`.
 
-# Or directly use Docker script
-./scripts/docker.sh <command>
-```
+## Common commands
 
-**Common Commands**:
-- `docker setup` - Initialize Docker environment
-- `docker build` - Build image
-- `docker deploy` - Deploy service
-- `docker up` - Start service
-- `docker down` - Stop service
-- `docker status` - View status
-- `docker logs` - View logs
-- `docker login` - Login to account
-- `docker test` - Test download
+| Command | Purpose |
+| --- | --- |
+| `pixivflow download` | Run downloads per config |
+| `pixivflow download --url <url>` | Direct download via URL |
+| `pixivflow random` | Random popular artwork |
+| `pixivflow scheduler` | Start scheduled jobs |
+| `pixivflow config` | Manage config (view / edit / backup / restore) |
+| `pixivflow status` | Download stats and recent records |
+| `pixivflow health` | Health check: config, directories, connectivity |
 
-> 📖 **Detailed Instructions**: See [Docker Usage Guide](docs/DOCKER.md)
+More commands in [CLI_MIGRATION_SUMMARY.md](docs/CLI_MIGRATION_SUMMARY.md).
 
----
-
-<a id="documentation"></a>
 ## Documentation
 
-> 📖 **Complete Documentation Index**: See [Documentation Navigation](docs/README.md) for a complete list and classification of all documents
-
-<a id="must-read-for-beginners"></a>
-### Must Read for Beginners (Read in Order)
+Full tutorial site: <https://redtidev1918.github.io/PixivFlow/>
 
 | Document | Description |
-|----------|-------------|
-| [⚡ QUICKSTART](docs/QUICKSTART.md) | **3-minute quick start** - Fastest way to get started |
-| [🔐 LOGIN](docs/LOGIN.md) | **Login process details** - Login problem solutions |
-| [📖 USAGE](docs/USAGE.md) | **Usage guide** - Feature usage instructions |
-
-<a id="feature-guides"></a>
-### Feature Guides
-
-| Document | Description |
-|----------|-------------|
-| [📋 CONFIG](docs/CONFIG.md) | **Configuration file usage guide** - All configuration options explained |
-| [🛠️ SCRIPTS](docs/SCRIPTS.md) | **Script usage guide** - All scripts detailed instructions |
-
-<a id="deployment-and-environment"></a>
-### Deployment and Environment
-
-| Document | Description |
-|----------|-------------|
-| [🐳 DOCKER](docs/DOCKER.md) | **Docker usage guide** - Docker deployment and usage (includes solutions for common issues) |
-
-<a id="project-documentation"></a>
-### Project Documentation
-
-| Document | Description |
-|----------|-------------|
-| [🏗️ ARCHITECTURE](docs/ARCHITECTURE.md) | **Architecture documentation** - Project architecture and technical implementation details |
-| [🔄 CLI_MIGRATION](docs/CLI_MIGRATION_SUMMARY.md) | **CLI command migration summary** - CLI command migration and feature comparison |
-| [📝 CHANGELOG](docs/project/CHANGELOG.md) | Version changelog |
-| [🤝 CONTRIBUTING](docs/project/CONTRIBUTING.md) | Contributing guide |
-
----
-
-<a id="use-cases"></a>
-## Use Cases
-
-<a id="scenario-1-daily-auto-collection-of-inspiration-materials"></a>
-### Scenario 1: Daily Auto Collection of Inspiration Materials
-
-**Requirement**: Automatically download high-quality landscape and illustration artworks daily as design materials
-
-**Configuration Example**:
-
-```json
-{
-  "targets": [
-    {
-      "type": "illustration",
-      "tag": "風景",
-      "limit": 50,
-      "minBookmarks": 1000
-    },
-    {
-      "type": "illustration",
-      "tag": "イラスト",
-      "limit": 30,
-      "minBookmarks": 5000
-    }
-  ],
-  "scheduler": {
-    "enabled": true,
-    "cron": "0 2 * * *"
-  }
-}
-```
-
-> Tip: `tagRelation: "or"` is supported. When set to `or`, the `tag` string is split by spaces, tags are queried sequentially, results are merged and deduplicated by item `id`, then sorted by `sort` and truncated by `limit`. It's recommended to increase `download.requestDelay` (e.g., 1500–3000ms) in this mode to reduce rate limiting.
-
-**Example 1b: Multi-tag OR search (sequential per-tag queries and merge)**
-```json
-{
-  "targets": [
-    {
-      "type": "novel",
-      "tag": "風景 イラスト オリジナル",
-      "tagRelation": "or",
-      "limit": 10,
-      "mode": "search",
-      "searchTarget": "partial_match_for_tags",
-      "sort": "popular_desc"
-    }
-  ]
-}
-```
-
-**Run Method**:
-
-```bash
-./scripts/pixiv.sh run
-```
-
----
-
-<a id="scenario-2-server-scheduled-collection-of-specific-tags"></a>
-### Scenario 2: Server Scheduled Collection of Specific Tags
-
-**Requirement**: Weekly collect popular artworks of specific tags on server
-
-**Configuration Example**:
-
-```json
-{
-  "targets": [
-    {
-      "type": "illustration",
-      "tag": "原神",
-      "limit": 100,
-      "searchTarget": "partial_match_for_tags"
-    }
-  ],
-  "scheduler": {
-    "enabled": true,
-    "cron": "0 0 * * 0",
-    "timezone": "Asia/Shanghai"
-  }
-}
-```
-
-**Deployment Method**:
-
-```bash
-# Use auto deploy script
-./scripts/auto-deploy.sh
-
-# Or use PM2 to manage process
-pm2 start "npm run scheduler" --name pixivflow
-```
-
----
-
-<a id="scenario-3-quick-experience---random-download"></a>
-### Scenario 3: Quick Experience - Random Download
-
-**Requirement**: Quick experience tool, download one random artwork
-
-**Run Method**:
-
-```bash
-# Random download illustration (default)
-npm run random
-
-# Random download novel
-npm run random -- --novel
-# or
-npm run random -- -n
-
-# Explicitly specify download illustration
-npm run random -- --illustration
-# or
-npm run random -- -i
-
-# Or use main program (if pixivflow is globally installed)
-pixivflow random
-pixivflow random --novel
-```
-
-**Feature Description**:
-- 🎲 **Random Tag Selection**: Randomly select from popular tags (illustrations: 風景, イラスト, オリジナル, etc.; novels: 小説, オリジナル, ホラー, etc.)
-- 🔍 **Random Artwork Selection**: Randomly select one artwork from search results
-- 🔐 **Auto Login**: If not logged in, will automatically guide login
-- 📥 **Quick Experience**: Download 1 random artwork, quickly understand tool features
-- 📚 **Type Support**: Supports random download of both illustrations and novels
-
----
-
-<a id="scenario-4-onetime-batch-download"></a>
-### Scenario 4: One-Time Batch Download
-
-**Requirement**: One-time download artworks of specified tags
-
-**Configuration Example**:
-
-```json
-{
-  "targets": [
-    {
-      "type": "illustration",
-      "tag": "art",
-      "limit": 500
-    }
-  ]
-}
-```
-
-**Run Method**:
-
-```bash
-# Use convenient script (recommended)
-./scripts/pixiv.sh once
-
-# Or use npm command
-npm run download
-
-# Or use main program (if pixivflow is globally installed)
-pixivflow download
-```
-
-> 💡 **Tip**: All download tasks are implemented through configuration files, no need to modify source code. See [Configuration File Usage Guide](docs/CONFIG.md) for details.
-
----
-
-<a id="project-structure"></a>
-## Project Structure
-
-```
-pixivflow/
-├── 📄 Configuration Files
-│   ├── config/
-│   │   ├── standalone.config.json           # Main config (create yourself)
-│   │   └── standalone.config.example.json   # Config template
-│
-├── 💻 Source Code
-│   ├── src/
-│   │   ├── index.ts                 # Main program entry
-│   │   ├── setup-wizard.ts          # Setup wizard
-│   │   ├── config.ts                # Config management
-│   │   ├── logger.ts                # Logging system
-│   │   ├── pixiv/                   # Pixiv API
-│   │   │   ├── AuthClient.ts        # Auth client
-│   │   │   └── PixivClient.ts       # API client
-│   │   ├── download/                # Download module
-│   │   │   ├── DownloadManager.ts   # Download manager
-│   │   │   └── FileService.ts       # File service
-│   │   ├── storage/                 # Data persistence
-│   │   │   └── Database.ts          # SQLite database
-│   │   └── scheduler/               # Scheduled tasks
-│   │       └── Scheduler.ts         # Task scheduler
-│
-├── 🛠️ Script Tools
-│   ├── scripts/
-│   │   ├── pixiv.sh                 # Main control script (recommended)
-│   │   ├── easy-setup.sh            # Setup wizard (backup)
-│   │   └── auto-deploy.sh           # Auto deploy
-│   │
-│   │   ⚠️ Note: The following features have been migrated to CLI commands (use after global install):
-│   │   - Config management: `pixivflow config`
-│   │   - Health check: `pixivflow health`
-│   │   - Auto monitor: `pixivflow monitor`
-│   │   - Auto maintenance: `pixivflow maintain`
-│   │   - Auto backup: `pixivflow backup`
-│
-├── 📦 Output Directories (auto created)
-│   ├── dist/                        # Compiled output
-│   ├── downloads/                   # Download directory
-│   │   ├── illustrations/           # Illustrations
-│   │   └── novels/                  # Novels
-│   └── data/                        # Data directory
-│       ├── pixiv-downloader.db      # SQLite database
-│       ├── pixiv-downloader.log     # Run logs
-│       └── metadata/                # Metadata directory (auto created)
-│           └── *.json               # Artwork metadata JSON files
-│
-└── 📚 Documentation
-    └── docs/                        # Documentation directory
-        ├── README.md                # Documentation index
-        ├── QUICKSTART.md            # Quick start guide
-        ├── LOGIN.md                 # Login guide
-        ├── CONFIG.md                # Configuration guide
-        ├── USAGE.md                 # Usage guide
-        ├── SCRIPTS.md               # Script guide
-        ├── ARCHITECTURE.md          # Architecture documentation
-        ├── CLI_MIGRATION_SUMMARY.md  # CLI migration summary
-        ├── DOCKER.md                # Docker guide
-        └── project/                 # Project documentation
-            ├── CHANGELOG.md         # Changelog
-            └── CONTRIBUTING.md      # Contributing guide
-```
-
----
-
-## ⚙️ Core Configuration
-
-Configuration file is located at `config/standalone.config.json`. Below are key configuration items:
-
-### Authentication Configuration
-
-```json
-{
-  "pixiv": {
-    "refreshToken": "your_refresh_token_here",
-    "clientId": "MOBrBDS8blbauoSck0ZfDbtuzpyT",
-    "clientSecret": "lsACyCD94FhDUtGTXi3QzcFE2uU1hqtDaKeqrdwj",
-    "userAgent": "PixivAndroidApp/5.0.234 (Android 11; Pixel 6)"
-  }
-}
-```
-
-> ⚠️ `refreshToken` is automatically obtained through setup wizard, no need to manually fill
-
-### Download Targets
-
-```json
-{
-  "targets": [
-    {
-      "type": "illustration",              // Type: illustration or novel
-      "tag": "風景",                       // Search tag
-      "limit": 20,                         // Download limit
-      "searchTarget": "partial_match_for_tags",
-      "minBookmarks": 500,                 // Minimum bookmarks
-      "startDate": "2024-01-01",          // Start date (optional)
-      "endDate": "2024-12-31"             // End date (optional)
-    }
-  ]
-}
-```
-
-### Scheduled Tasks
-
-```json
-{
-  "scheduler": {
-    "enabled": true,                      // Whether enabled
-    "cron": "0 3 * * *",                 // Cron expression
-    "timezone": "Asia/Shanghai"           // Timezone
-  }
-}
-```
-
-#### Cron Expression Quick Reference
-
-| Expression | Description |
-|------------|-------------|
-| `0 * * * *` | Every hour |
-| `0 */6 * * *` | Every 6 hours |
-| `0 2 * * *` | Daily at 2:00 |
-| `0 0 * * 0` | Weekly on Sunday at 0:00 |
-| `0 0 1 * *` | Monthly on 1st at 0:00 |
-
-### Storage Configuration
-
-```json
-{
-  "storage": {
-    "databasePath": "./data/pixiv-downloader.db",
-    "downloadDirectory": "./downloads",
-    "illustrationDirectory": "./downloads/illustrations",
-    "novelDirectory": "./downloads/novels",
-    "illustrationOrganization": "byAuthorAndTag",
-    "novelOrganization": "byDateAndAuthor"
-  }
-}
-```
-
-#### Directory Organization Modes
-
-| Mode | Description | Directory Structure Example |
-|------|-------------|----------------------------|
-| `flat` | Flat structure (default) | `illustrations/123456_Title_1.jpg` |
-| `byAuthor` | Organize by author | `illustrations/AuthorName/123456_Title_1.jpg` |
-| `byTag` | Organize by tag | `illustrations/TagName/123456_Title_1.jpg` |
-| `byDate` | Organize by date | `illustrations/2024-12/123456_Title_1.jpg` |
-| `byAuthorAndTag` | By author and tag | `illustrations/AuthorName/TagName/123456_Title_1.jpg` |
-| `byDateAndAuthor` | By date and author | `illustrations/2024-12/AuthorName/123456_Title_1.jpg` |
-
-> 💡 **Tip**: Using organization modes can make downloaded files more organized, easier to manage and find.
-
-> 💡 **Tip**: Paths support auto-fix, the project will automatically detect and fix path issues on startup. Use `pixivflow migrate-config` to manually migrate configuration paths.  
-> 📚 **Complete Configuration Guide**: See [Configuration Guide](docs/CONFIG.md)
-
----
-
-## 🐛 FAQ
-
-### ❓ Setup Wizard Login Failed?
-
-**Symptoms**: Login fails after running `npm run setup`
-
-**Solutions**:
-1. Confirm you correctly entered Pixiv username and password in terminal
-2. Check network connection and proxy settings
-3. Re-run setup wizard: `npm run setup`
-
----
-
-### ❓ Authentication Failed or Token Expired?
-
-**Symptoms**: "Authentication failed" or "401 Unauthorized" when downloading
-
-**Solutions**:
-
-```bash
-# Method 1: Use login script (recommended, simplest)
-npm run login
-
-# Method 2: Re-run setup wizard
-./scripts/easy-setup.sh
-# or
-npm run setup
-```
-
----
-
-### ❓ No Matching Artworks Found?
-
-**Symptoms**: Search results empty or download count is 0
-
-**Possible Causes**:
-- Tag spelling error or doesn't exist
-- Filter conditions too strict
-- Network connection issues
-
-**Solutions**:
-1. Try common tags: `イラスト`, `風景`, `art`
-2. Lower `minBookmarks` value
-3. Check network connection and firewall settings
-4. Search on Pixiv website to confirm tag exists
-
----
-
-### ❓ Scheduled Task Not Running?
-
-**Symptoms**: Scheduled task set but not auto downloading
-
-**Solutions**:
-
-```bash
-# 1. Environment check and auto-fix (recommended ⭐)
-./scripts/pixiv.sh check --fix
-
-# 2. One-click update and fix
-./scripts/pixiv.sh update
-
-# 3. Check configuration
-pixivflow config validate
-
-# 4. View running status
-./scripts/pixiv.sh status
-
-# 5. Check logs
-./scripts/pixiv.sh logs
-
-# 6. Ensure program keeps running
-# Use PM2 to manage process
-pm2 start "npm run scheduler" --name pixivflow
-pm2 save
-pm2 startup
-```
-
----
-
-### ❓ Slow Download Speed or Frequent Failures?
-
-**Possible Causes**: Unstable network connection or Pixiv server rate limiting
-
-**Solutions**:
-1. Check network connection
-2. Reduce concurrent download count
-3. Increase retry count and timeout
-4. Use proxy server (if needed)
-
----
-
-### ❓ Encountered Deleted or Private Artworks?
-
-**Symptoms**: Some artworks cannot be downloaded during download process
-
-**Description**:
-PixivFlow has built-in comprehensive error handling that automatically handles the following:
-
-- ✅ **Auto Skip Deleted Artworks**: If artwork is deleted by author, will auto skip and continue downloading others
-- ✅ **Auto Skip Private Artworks**: If artwork is set to private or requires special permissions, will auto skip
-- ✅ **Auto Skip Inaccessible Artworks**: If artwork cannot be accessed for other reasons (e.g., 404 error), will auto skip
-- ✅ **Record Skip Count**: Will display skipped artwork count after download completes
-- ✅ **Won't Interrupt Flow**: Single artwork download failure won't affect entire download task
-
-**Log Example**:
-
-```
-[INFO] Skipped 3 novel(s) (deleted, private, or inaccessible)
-[INFO] Illustration tag 風景 completed, { downloaded: 47 }
-```
-
-**Description**:
-- 404 errors use `debug` level logs (silently skipped)
-- Other errors use `warn` level logs (recorded but continue)
-- All skipped artwork counts will be displayed at task end
-
----
-
-### 🔍 View Detailed Logs
-
-```bash
-# View run logs
-./scripts/pixiv.sh logs
-
-# Or directly view log file
-tail -f data/pixiv-downloader.log
-```
-
----
-
-## 🔒 Security Tips
-
-> ⚠️ **Important**: Configuration files contain sensitive information, please pay attention to security
-
-### 🛡️ Security Recommendations
-
-| Recommendation | Description |
-|----------------|-------------|
-| ✅ **Don't Share Config Files** | `config/standalone.config.json` contains sensitive authentication info |
-| ✅ **Don't Commit to Git** | Ensure config file is in `.gitignore` (excluded by default) |
-| ✅ **Regular Backups** | Use `pixivflow backup` to backup config and data |
-| ✅ **Use Strong Passwords** | Protect your Pixiv account |
-| ✅ **HTTPS Encryption** | All API requests use HTTPS secure transmission |
-| ✅ **Regular Token Updates** | Regularly re-run setup wizard to update authentication info |
-
-### 🔐 About refresh_token
-
-`refresh_token` is equivalent to your account password, having it allows access to your Pixiv account.
-
-**If refresh_token is leaked**:
-1. Immediately revoke authorization in Pixiv account settings
-2. Change Pixiv account password
-3. Re-run setup wizard to get new token
-
----
-
-## 📊 Download Record Management
-
-All download records are saved in SQLite database (`data/pixiv-downloader.db`), including:
-
-- Artwork ID, title, author info
-- Download time, file path
-- Artwork statistics (views, bookmarks, etc.)
-
-### View Download Records
-
-```bash
-# Use SQLite command line tool
-sqlite3 data/pixiv-downloader.db "SELECT * FROM downloaded_artworks LIMIT 10;"
-
-# Or use GUI tools
-# - DB Browser for SQLite
-# - SQLiteStudio
-```
-
-### Clean Download Records
-
-```bash
-# Use maintenance command (recommended)
-pixivflow maintain
-
-# Or manually delete database (will re-download all artworks)
-rm data/pixiv-downloader.db
-```
-
----
-
-## 🚀 Advanced Usage
-
-### Deploy on Server
-
-#### Method 1: Use Docker (Recommended ⭐)
-
-```bash
-# Docker mode deployment
-./scripts/auto-deploy.sh production docker
-
-# Or use Docker management script
-./scripts/pixiv.sh docker deploy
-```
-
-#### Method 2: Use Auto Deploy Script (Native Mode)
-
-```bash
-./scripts/auto-deploy.sh
-```
-
-#### Method 3: Use PM2 Management
-
-```bash
-# Install PM2
-npm install -g pm2
-
-# Start scheduled task
-pm2 start "npm run scheduler" --name pixivflow
-
-# Save PM2 config
-pm2 save
-
-# Set auto start on boot
-pm2 startup
-```
-
-#### Method 4: Use systemd
-
-Create service file `/etc/systemd/system/pixivflow.service`:
-
-```ini
-[Unit]
-Description=PixivFlow Automation Downloader
-After=network.target
-
-[Service]
-Type=simple
-User=your-username
-WorkingDirectory=/path/to/pixivflow
-ExecStart=/usr/bin/node dist/index.js scheduler
-Restart=on-failure
-RestartSec=10
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Start service:
-
-```bash
-sudo systemctl enable pixivflow
-sudo systemctl start pixivflow
-sudo systemctl status pixivflow
-```
-
----
-
-### Configure Multiple Download Tasks
-
-You can add multiple targets in the `targets` array:
-
-```json
-{
-  "targets": [
-    {
-      "type": "illustration",
-      "tag": "風景",
-      "limit": 50
-    },
-    {
-      "type": "illustration",
-      "tag": "イラスト",
-      "limit": 30,
-      "minBookmarks": 1000
-    },
-    {
-      "type": "novel",
-      "tag": "小説",
-      "limit": 10
-    }
-  ]
-}
-```
-
----
-
-### Using Proxy
-
-If you need to access Pixiv through proxy, there are two methods:
-
-#### Method 1: Use Environment Variables (Recommended ⭐)
-
-Program automatically reads proxy config from environment variables, no need to modify config file:
-
-```bash
-# Set proxy environment variables (priority: all_proxy > https_proxy > http_proxy)
-export all_proxy=socks5://127.0.0.1:6153
-# or
-export https_proxy=http://127.0.0.1:6152
-# or
-export http_proxy=http://127.0.0.1:6152
-
-# Then run program
-npm run download
-```
-
-**Supported Proxy Protocols**:
-- `http://` - HTTP proxy
-- `https://` - HTTPS proxy
-- `socks5://` - SOCKS5 proxy
-- `socks4://` - SOCKS4 proxy
-
-**Environment Variable Priority**:
-1. `all_proxy` or `ALL_PROXY` (highest priority)
-2. `https_proxy` or `HTTPS_PROXY`
-3. `http_proxy` or `HTTP_PROXY`
-
-#### Method 2: Config File Settings
-
-```json
-{
-  "network": {
-    "proxy": {
-      "enabled": true,
-      "host": "127.0.0.1",
-      "port": 7890,
-      "protocol": "http"
-    }
-  }
-}
-```
-
-**Note**: If proxy is enabled in config file, environment variables won't override config file settings.
-
----
-
-## 📄 Open Source License
-
-This project is open source under [GPL-3.0-or-later](LICENSE) license.
-
-**This means**:
-- ✅ Free to use, modify and distribute
-- ✅ Modified code must also be open source
-- ✅ Must retain original author info and license notice
-
----
-
-## 🙏 Acknowledgments
-
-### Inspiration Sources
-
-- [PixivBatchDownloader](https://github.com/xuejianxianzun/PixivBatchDownloader) - Browser extension version
-- [get-pixivpy-token](https://github.com/eggplants/get-pixivpy-token) - OAuth authentication implementation reference
-
-### Thanks to All Contributors 🎉
-
----
-
-## 📮 Get Help
-
-Having issues? Here are multiple ways to get help:
-
-| Type | Channel | Description |
-|------|---------|-------------|
-| 🐛 **Bug Report** | [GitHub Issues](https://github.com/zoidberg-xgd/pixivflow/issues) | Report issues and bugs |
-| 💡 **Feature Suggestion** | [GitHub Discussions](https://github.com/zoidberg-xgd/pixivflow/discussions) | Propose new feature ideas |
-| 📖 **Usage Questions** | [View Documentation](docs/README.md) | Read complete documentation |
-| 🔧 **Auto-Fix Issues** | `./scripts/pixiv.sh check --fix` | Auto-fix environment issues ⭐ New |
-| 🔄 **Update & Fix** | `./scripts/pixiv.sh update` | One-click update and fix ⭐ New |
-| ✅ **Environment Check** | `./scripts/pixiv.sh health` | Run health check |
-| 💬 **Community Discussion** | [Discussions](https://github.com/zoidberg-xgd/pixivflow/discussions) | Discuss with other users |
-| 🔍 **FAQ** | [FAQ](#-faq) | View FAQ |
-
-### Search Keywords
-
-If you're looking for similar tools, these keywords might help:
-
-- `pixiv downloader` - Pixiv downloader
-- `pixiv batch download` - Pixiv batch download
-- `pixiv automation` - Pixiv automation
-- `pixiv cli` - Pixiv CLI tool
-- `pixiv api` - Pixiv API client
-- `pixiv scheduler` - Pixiv scheduled tasks
-- `pixiv artwork downloader` - Pixiv artwork downloader
-- `pixiv novel downloader` - Pixiv novel downloader
-
-### Before Asking:
-
-1. 🔍 Check [FAQ](#-faq) section
-2. 📖 Read relevant documentation
-3. ✅ Run health check `pixivflow health`
-4. 📋 View run logs `./scripts/pixiv.sh logs`
-
----
-
-## 📈 Project Statistics
-
-<div align="center">
-
-### Project Data
-
-![GitHub repo size](https://img.shields.io/github/repo-size/zoidberg-xgd/pixivflow?style=flat-square)
-![GitHub language count](https://img.shields.io/github/languages/count/zoidberg-xgd/pixivflow?style=flat-square)
-![GitHub top language](https://img.shields.io/github/languages/top/zoidberg-xgd/pixivflow?style=flat-square)
-![GitHub last commit](https://img.shields.io/github/last-commit/zoidberg-xgd/pixivflow?style=flat-square)
-
-</div>
-
-### Performance Metrics
-
-- ⚡ **Startup Speed**: < 2 seconds
-- 📦 **Package Size**: < 5 MB (excluding dependencies)
-- 💾 **Memory Usage**: < 100 MB (runtime)
-- 🔄 **Download Speed**: Supports concurrent downloads, auto rate limiting
-- 📊 **Database**: SQLite, lightweight, no additional service needed
-
----
-
-## 🤝 Contributing
-
-We welcome all forms of contributions! Whether it's reporting bugs, proposing features, or submitting code, we're very grateful.
-
-### How to Contribute
-
-1. **Fork the Project**
-2. **Create Feature Branch** (`git checkout -b feature/AmazingFeature`)
-3. **Commit Changes** (`git commit -m 'Add some AmazingFeature'`)
-4. **Push to Branch** (`git push origin feature/AmazingFeature`)
-5. **Open Pull Request**
-
-### Contributing Guide
-
-See [CONTRIBUTING.md](docs/project/CONTRIBUTING.md) for detailed contributing guide, including:
-- Code of Conduct
-- Development environment setup
-- Code standards
-- Commit standards
-- Pull Request process
-
----
-
-## 📝 Changelog
-
-See [CHANGELOG.md](docs/project/CHANGELOG.md) for detailed version update records.
-
----
-
-## Support the Project
-
-If this project helps you, please consider:
-
-- ⭐ **Give the Project a Star** - Let more people discover this project
-- 🍴 **Fork the Project** - Create your own version
-- 🐛 **Report Bugs** - Help us improve
-- 💡 **Propose Suggestions** - Share your ideas
-- 📢 **Share with More People** - Let more people benefit
-- 💻 **Contribute Code** - Participate in project development
-
-<div align="center">
-
-### ⭐ Star This Project
-
-**[⭐ Star on GitHub](https://github.com/zoidberg-xgd/pixivflow)** - Let more people discover PixivFlow!
-
----
-
-**Related Links**:
-- [npm Package](https://www.npmjs.com/package/pixivflow)
-- [GitHub Repository](https://github.com/zoidberg-xgd/PixivFlow)
-- [Frontend Project (pixivflow-webui)](https://github.com/zoidberg-xgd/pixivflow-webui)
-- [Full Documentation](docs/README.md)
-- [Issue Tracker](https://github.com/zoidberg-xgd/PixivFlow/issues)
-- [Discussions](https://github.com/zoidberg-xgd/PixivFlow/discussions)
-
----
+| --- | --- |
+| [QUICKSTART](docs/QUICKSTART.md) | Get running in three minutes |
+| [CONFIG](docs/CONFIG.md) | All configuration options |
+| [USAGE](docs/USAGE.md) | Feature reference |
+| [LOGIN](docs/LOGIN.md) | Account sign-in details |
+| [DOCKER](docs/DOCKER.md) | Container deployment |
+| [ARCHITECTURE](docs/ARCHITECTURE.md) | Architecture notes |
+| [RELEASING](docs/RELEASING.md) | npm release workflow |
+| [CHANGELOG](docs/project/CHANGELOG.md) | Version history |
 
-Made with ❤️ by [zoidberg-xgd](https://github.com/zoidberg-xgd)
+Chinese version: [README.md](README.md).
 
-**PixivFlow** - Make Pixiv artwork collection elegant and efficient
+## Feedback
 
-[⬆ Back to Top](#-pixivflow)
+Bugs and feature requests go to
+[Issues](https://github.com/redtidev1918/PixivFlow/issues); please run
+`pixivflow health` first and include its output (strip tokens and other
+secrets before sharing). Security issues are handled privately — see
+[SECURITY.md](SECURITY.md).
 
-</div>
+## License
 
+[MIT](LICENSE)