PicList is an efficient cloud storage and image hosting platform management tool. Building upon the foundation of PicGo, it has been deeply modified and enhanced. Not only does it retain all of PicGo's features, but it also adds many new ones. For instance, the album now supports synchronized deletion of files in the cloud. Built-in image hosting options have been expanded to include WebDav, local image hosting, and SFTP. Additionally, PicList introduces comprehensive cloud storage management functions, including cloud directory viewing, file search, batch uploading, downloading, and file deletion, copying links in various formats, and previews for images, markdown, text, and videos. Moreover, it boasts a more powerful album function and numerous other improvements and enhancements.
How to migrate from PicGo
PicList V1.5.0
and above versions provide the one-click migration
function. Enter the Settings
page, and then click the right button on the Migrate from PicGo
option to migrate. Please restart the application to take effect after migration.
PicList-Core
The core of PicList uses PicList-Core, which is modified based on the original PicGo-Core, and adapted for cloud-deleting feature, etc. At the same time, new features have been added, such as watermark adding, image compression/scaling/rotation/format conversion, which can be called through CLI command line, support starting the built-in upload server through picgo-server
,and some other functional changes.
If you want to use PicList-Core, please go to https://github.com/Kuingsmile/PicList-Core, or go to the official npm address for installation instructions.
Features
- Retains all the features of PicGo and is compatible with the vast majority of existing PicGo plugins, including integrations with software like Typora and Obsidian.
- Added multiple built-in image hosting platforms, such as S3 API compatible platforms, WebDav, Lsky Pro, local image hosting, SFTP. The original built-in imgur image host now also supports account login for uploading.
- Within the album, you can synchronize the deletion of cloud images. This is supported across all built-in image hosts and multiple plugins.
- The album now offers advanced search and sorting features, as well as batch URL modification.
- Built-in tools for adding watermarks, compressing images, scaling images, rotating images, and converting image formats are now available. Advanced renaming is also supported.
- Upload interface supports form upload files, can be shared by multiple computers
- Configuration can be synchronized to Github/Gitee/Gitea repositories.
- Manages over ten types of image hosting platforms, allowing online viewing of cloud directories, file searching, batch uploading, batch downloading, file deletion, and more.
- Support previewing multiple formats of files, including pictures, videos, plain text files and markdown files, etc.
- Supports the use of regular expressions for batch renaming of cloud files.
- For private storage buckets, pre-signed link copying for sharing is available.
- Software auto-updates are available, along with multiple startup modes, and many other feature details have been added and optimized.
- The PicGo interface has been enhanced, window size restrictions have been unlocked, and some interface layouts have been beautified.
- The installation package for the Mac platform is now signed, addressing the recurring issue on PicGo where the installation package was reported as damaged.
How to use
How to use in Typora
Typora 1.6.0-dev and above
Typora 1.6.0-dev and above now natively supports PicList
If your Typora version is lower than 1.8.0, you need to set the upload service PicList and PicGo (app) to the installation path of PicList at the same time.
Download address:
Typora 1.6.0 version and below
For windows, enter the Typora settings page, select the image, set the upload service to PicGo(app)
, and then fill in the installation path of PicList in PicGo path
, as shown below:
Or, you can also use the npm install piclist
command to install PicList-core, and then set the upload service to PicGo-Core(command line)
.
How to use in Obsidian
In the community plugins, search for and install the Image auto upload Plugin. Next, go to the plugin settings page and change the default uploader to PicGo(app). Set the PicGo server to http://127.0.0.1:36677/upload
as shown in the image below. Additionally, this plugin also supports cloud-based deletion through PicList. To use this feature, enter http://127.0.0.1:36677/delete
in the deletion interface.
How to use in docker
docker run
Change the ./piclist
to your own path, and change the piclist123456
to your own secret key.
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
docker-compose
download docker-compose.yml
from piclist-core repo, or copy the following content to docker-compose.yml
:
version: '3.3'
services:
node:
image: 'kuingsmile/piclist:latest'
container_name: piclist
restart: always
ports:
- 36677:36677
volumes:
- './piclist:/root/.piclist'
command: node /usr/local/bin/picgo-server -k piclist123456
You can change the volumes
to your own path and change the command
to your own secret key.
Then run:
docker-compose up -d
Supported platforms
Platform | Album Cloud-deleting | Cloud Storage Management |
---|---|---|
SMMS | ✔️ | ✔️ |
Github | ✔️ | ✔️ |
Imgur | ✔️ | ✔️ |
Tencent COS V5 | ✔️ | ✔️ |
Ali Cloud OSS | ✔️ | ✔️ |
Upyun | ✔️ | ✔️ |
Qiniu Cloud | ✔️ | ✔️ |
S3 API compatible | ✔️ | ✔️ |
WebDAV | ✔️ | ✔️ |
local path | ✔️ | ✔️ |
Built-in SFTP | ✔️ | ✔️ |
Doge Cloud | ✔️ | ✔️ |
Lsky Pro | ✔️ | ✔️ |
PicList-Server | ✔️ | ✔️ |
Custom API platform | × | × |
Plugin | Album Cloud-deleting |
---|---|
picgo-plugin-s3 | ✔️ |
picgo-plugin-alist | ✔️ |
picgo-plugin-huawei-uploader | ✔️ |
picgo-plugin-dogecloud | ✔️ |
Download and install
Github release
https://github.com/Kuingsmile/PicList/releases/latest
Scoop
scoop bucket add lemon https://github.com/hoilc/scoop-lemon
scoop install lemon/piclist
homebrew cask
brew install piclist --cask
download from CDN
Windows
Linux
Mac
App screenshots
Development
- You need to have Node, Git environment and knowledge of npm.
- Clone the project by running
git clone https://github.com/Kuingsmile/PicList.git
and navigate into the project. - Install dependencies by running
yarn
. Note that if you don't have yarn installed, please download and install it from the official website before using it. Usingnpm install
may result in unknown errors! - Xcode environment is required for Mac, and VS environment is required for Windows.
- If you want to contribute to the code, you can refer to the contributing guidelines.
Dev mode
Enter yarn run dev
to enter development mode, which has hot reloading feature. However, it should be noted that development mode is unstable and there may be process crashes. At this time, you need to:
ctrl+c
# Exit development mode yarn run dev
# Re-enter development mode
Note: After running the development mode in Windows, the PicList application icon will appear in the application area at the bottom right of the taskbar.
Build
If you need to build it yourself, you can use yarn run build
to start the build process. After a successful build, the corresponding installation files will appear in the dist_electron
directory.
Note: If your network environment is not very good, it may fail to download the electron binary file of electron-builder. In this case, you need to specify the electron source as a domestic source before running npm run electron:build
:
export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"
On Windows, you can use set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
(without quotes)
Related projects
- PicList-Core : PicGo-Core based core library for CLI operation and project development
- PicHoro: PicList companion mobile APP
- VS-PicList: A VScode plugin that works with PicList
Contributors
License
This project is open source under the MIT license. We welcome everyone to use and contribute to the code, and we are grateful to the original author Molunerfinn for their spirit of open source.
Copyright (c) 2017-present, Molunerfinn
Copyright (c) 2023-present Kuingsmile