Skip to content

Latest commit

 

History

1,697 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PicList Logo

PicList

A powerful cloud storage and image hosting management tool.

Code Style Downloads Release License

简体中文 | English


Repobeats analytics image

📖 Introduction

PicList is an efficient cloud storage and image hosting management tool built upon the foundation of PicGo. It builds on PicGo’s upload workflow with 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

  • 📂 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
Upload Interface
Image
More Views (Gallery, Settings, Task)
Gallery Cloud Storage
Settings Task
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 / PicList-Core

Docker runs the separate PicList-Core upload server. This repository contains the Electron desktop application and its build scripts. For container setup, see PicList-Core and the FAQ.

🔌 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.
  • 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

Uploaders, gallery remote deletion, and cloud management have different capabilities. Uploaders come from PicList-Core and installed plugins; this table reflects the desktop deletion adapters and management clients.

Storage Provider Gallery Remote Delete Cloud Management
AWS S3 (and compatible) ✅ ✅
Aliyun OSS ✅ ✅
Tencent COS ✅ ✅
Qiniu Kodo ✅ ✅
Upyun ✅ ✅
GitHub ✅ ✅
S.EE / Imgur ✅ ✅
WebDAV / SFTP ✅ ✅
Local File System ✅ ✅
Doge Cloud ✅ Via the S3 API client's Doge Cloud option
Lsky Pro / Alist ✅ —
Huawei OBS ✅ —
Another PicList server ✅ —

“—” means there is no dedicated management client. Deletion depends on the uploader ID, credentials, and remote-file metadata stored with the gallery record. Custom API hosts can implement deletion with an onGalleryRemove lifecycle script.

Implementation: deletion registry and management clients. See the FAQ for uploader availability and troubleshooting.

🚀 Development

The contributor and development guide covers the source layout, complete script reference, JSON localization, plugin development, and packaging. See the API guide for main-process services and RPC.

Prerequisites

  • Node.js 22.x, at least 22.13.0 (required by the current core dependency; release CI uses 22.x).
  • Yarn Classic 1.22.x and Git.
  • Native dependencies may need platform build tools. Windows packaging and experimental plugin runtime preparation require Visual Studio C++ Build Tools.

Run from source

git clone https://github.com/Kuingsmile/PicList.git
cd PicList
yarn install --frozen-lockfile

# Start Electron in development mode
yarn dev

# Compile production code without an installer, then preview it
yarn prebuild
yarn preview

Installation downloads themes, installs Husky hooks, and prepares Electron native dependencies. The development server uses the fixed address 127.0.0.1:30303.

yarn build packages with electron-builder; yarn build:win, yarn build:mac, and yarn build:linux select a platform. Follow the contributor guide's platform prerequisites first; Windows also needs yarn prepare:7za. Compiled output goes to out/ and packaged artifacts to dist_electron/.

Before submitting code, use yarn typecheck, yarn lint, and the relevant checks in the guide. yarn test:release tests release tooling and packaging hooks; there is no general test script.

🔗 Related Projects

📄 License

This project is licensed under the MIT License.

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


Star Me! ⭐️

Star History Chart

About

An image upload and manage tool, base on PicGo

Topics

Resources

Code of conduct

Contributing

Stars

3.8k stars

Watchers

14 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages