📖 Introduction

PicList is an efficient cloud storage and image hosting management tool built upon the foundation of PicGo. It retains all the features of PicGo while adding comprehensive cloud storage management capabilities, various practical functions, and a brand-new lightweight scripting system.

Whether you need to organize your cloud files, sync markdown images, or manage multiple storage platforms effortlessly, PicList is designed to streamline your workflow with a beautiful interface and robust plugin system.

✨ Key Features

• 📂 comprehensive Cloud Management: Browse, search, cloud-delete, and batch rename files in your cloud storage.
• 🔄 Advanced Sync: Cloud-sync album deletion and configuration/gallery synchronization across multiple devices (via WebDAV/Git).
• 🎨 Built-in Image Tools: Watermark, compress, scale, rotate, and format conversion out of the box, controllable at individual image bed level.
• 📝 Scripting System: Customize lifecycle scripts to meet advanced user needs without requiring a node environment.
• 🌈 Theme Support: Multiple built-in themes, theme repository PicList ThemeHub, also supports custom themes and backgrounds.
• 🔌 Wide Compatibility: Compatible with Typora, Obsidian, and most existing PicGo plugins.
• 🛠️ Power User Features: Regex-based batch renaming, upload queues, local/sftp hosting, and more.
• 🌐 Web & Mobile: Support for form uploads and integration with the mobile app PicHoro.

📸 Screenshots

Upload Interface

More Views (Gallery, Settings, Task)

📥 Download & Install

💻 Desktop Applications

OS	Method	Command / Link
Windows	Winget	winget install Kuingsmile.PicList
	Scoop	scoop bucket add lemon https://github.com/hoilc/scoop-lemon scoop install lemon/piclist
	Installer	Download .exe
macOS	Homebrew	brew install piclist --cask
	DMG	Download .dmg
Linux	Installer	Download AppImage/Snap/Deb

🐳 Docker

Run PicList with docker or docker-compose.

docker pull kuingsmile/piclist:latest

docker run -d \
  --name piclist \
  --restart always \
  -p 36677:36677 \
  -v "./piclist:/root/.piclist" \
  kuingsmile/piclist:latest \
  node /usr/local/bin/picgo-server -k piclist123456

🔌 Integrations

PicList integrates seamlessly with your favorite markdown editors.

VSCode

Install the VS-PicList extension for full integration.

Typora

• Version ≥ 1.6.0: Select PicList directly in the Image settings settings.
• Version < 1.6.0: Set 'Image Upload' -> 'PicGo(app)' and point the path to your PicList executable.

Obsidian

1. Install Image Auto Upload Plugin.
2. Set Default Uploader to PicGo(app).
3. API Endpoint: http://127.0.0.1:36677/upload

☁️ Supported Platforms

PicList supports a wide range of storage providers.

Storage Provider	Album Delete	Cloud Management
AWS S3 (and compatible)	✅	✅
Aliyun OSS	✅	✅
Tencent COS	✅	✅
GitHub / Gitee	✅	✅
S.EE / Imgur	✅	✅
WebDAV / SFTP	✅	✅
Local File System	✅	✅
Lsky Pro / Doge Cloud	✅	✅

Note: The cloud delete feature for custom API image hosts requires implementation via PicList's scripting system based on the specific API.

🚀 Development

We welcome contributions! Please see Contributing Guide for details.

Prerequisites

• Node.js 20+
• Git
• Xcode (macOS) or Visual Studio (Windows) for native modules

Build from Source

# 1. Clone the repository
git clone https://github.com/Kuingsmile/PicList.git
cd PicList

# 2. Install dependencies
yarn

# 3. specific start dev mode
yarn run dev

# 4. Build for production
yarn run build

🔗 Related Projects

• PicList ThemeHub: A theme repository for PicList.
• PicList ScriptsHub: A script repository for PicList.
• PicList-Core: The CLI core of PicList.
• PicHoro: Android mobile client.

📄 License

This project is licensed under the MIT License.

Copyright (c) 2017-present Molunerfinn Copyright (c) 2023-present Kuingsmile

---