piclist
Version:
Modified PicGo core, A tool for picture uploading
250 lines (167 loc) • 6.1 kB
Markdown
# PicList-Core
English | [简体中文](./README_cn.md)
A powerful tool for image uploading with both CLI & API support. PicList-Core extends PicGo-Core with additional features while maintaining plugin compatibility. Check out [Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo) for a collection of powerful plugins.
You can refer to the [DeepWiki of PiclList-Core](https://deepwiki.com/Kuingsmile/PicList-Core/) for more information.
**Natively supports Typora integration**.
## Enhanced Features
- **Image processing capabilities**:
- Add watermarks, compress images, and convert formats
- Configure via `picgo set buildin watermark` and `picgo set buildin compress` CLI commands
- Processing happens during beforeTransform phase, ensuring compatibility with all plugins
- **Advanced renaming**:
- Set custom rename rules via `picgo set buildin rename`
- **Additional built-in image hosting services**:
- WebDAV, SFTP, Local path, AWS S3
- Improved Imgur support with account-based uploads
- **Built-in server**:
- Similar to PicList-Desktop server
- Launch with `picgo-server` command
- **Bug fixes**:
- Addresses several issues from the original PicGo-Core
## Installation
PicList requires Node.js >= 16
### Prerequisites
PicList depends on [sharp](https://sharp.pixelplumbing.com/). Install it first:
```bash
npm config set sharp_binary_host "https://npmmirror.com/mirrors/sharp"
npm config set sharp_libvips_binary_host "https://npmmirror.com/mirrors/sharp-libvips"
npm install sharp
```
### Global install
```bash
npm install piclist -g
# or
yarn global add piclist
```
### Local install
```bash
npm install piclist -D
# or
yarn add piclist -D
```
## Usage
### Docker
You can use docker to run PicList-Core.
#### docker run
Change the `./piclist` to your own path, this path is where you put your `config.json` file, and change the `piclist123456` to your own secret key.
```bash
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 this repo, or copy the following content to `docker-compose.yml`:
```yaml
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 `./piclist` to your own path, this path is where you put your `config.json` file, and change the `command` to your own secret key.
Then run:
```bash
docker-compose up -d
```
#### Install plugins in docker
You can use `docker exec` to install plugins in docker.
```bash
docker exec -it piclist sh
picgo install picgo-plugin-xxx
```
#### Change config in docker
You can use `docker exec` to change config in docker.
```bash
docker exec -it piclist sh
picgo set xxx
```
### Server
You can use `picgo-server` to start a server, default port is `36677`.
Start server:
```bash
picgo-server
node ./bin/picgo-server
```
> It's highly recommended to add `--key` to avoid unauthorized access. Example: `picgo-server --key 123456`，
Show help:
```bash
$ picgo-server -h
Usage: picgo-server [options]
Options:
-h, --help Print this help message
-c, --config Set config path
-p, --port Set port, default port is 36677
--host Set host, default host is 0.0.0.0
-k, --key Set secret key to avoid unauthorized access
-v, --version Print version number
Examples:
picgo-server -c /path/to/config.json
picgo-server -k 123456
picgo-server -c /path/to/config.json -k 123456
```
#### endpoints
- `/upload?picbed=xxx&key=xxx` upload picture, `picbed` to set pic-bed, `key` to set secret key
- `/heartbeat` heartbeat
### Use in CLI
> PicList-Core uses `SM.MS` as the default upload pic-bed.
Show help:
```bash
$ picgo -h
Usage: picgo [options] [command]
Options:
-v, --version output the version number
-d, --debug debug mode
-s, --silent silent mode
-c, --config <path> set config path
-h, --help output usage information
Commands:
install|add <plugins...> install picgo plugin
uninstall|rm <plugins...> uninstall picgo plugin
update <plugins...> update picgo plugin
set|config <module> [name] configure config of picgo modules
upload|u [input...] upload, go go go
use [module] use modules of picgo
init [options] <template> [project] create picgo plugin\'s development templates
```
#### Upload a picture from path
```bash
picgo upload /xxx/xx/xx.jpg
```
#### Upload a picture from clipboard
> picture from clipboard will be converted to `png`
```bash
picgo upload
```
### Use in node project
#### Common JS
```js
const { PicGo } = require('piclist')
```
#### ES Module
```js
import { PicGo } from 'piclist'
```
#### API usage example
```js
const picgo = new PicGo()
// upload a picture from path
picgo.upload(['/xxx/xxx.jpg'])
// upload a picture from clipboard
picgo.upload()
```
## Documentation
For more details, you can checkout [documentation of PicGo-Core](https://picgo.github.io/PicGo-Core-Doc/).