piclist 1.9.10 → 1.9.11

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## :tada: 1.9.11 (2025-02-27)
+
+
+### :sparkles: Features
+
+* **custom:** optimize getconfig to hot-reload ([da65a05](https://github.com/Kuingsmile/PicList-Core/commit/da65a05))
+
+
+### :bug: Bug Fixes
+
+* **custom:** fix alist output url bug ([3270f67](https://github.com/Kuingsmile/PicList-Core/commit/3270f67))
+
+
+### :pencil: Documentation
+
+* **custom:** add chinease readme.md ([08386c3](https://github.com/Kuingsmile/PicList-Core/commit/08386c3))
+
+
+
 ## :tada: 1.9.10 (2024-12-27)
 
 

package/README.md

@@ -1,5 +1,7 @@
 # PicList-Core
 
+English | [简体中文](./README_cn.md)
+
 ![standard](https://img.shields.io/badge/code%20style-standard-green.svg?style=flat-square)
 ![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)
 ![node](https://img.shields.io/badge/node-%3E%3D16.0.0-blue?style=flat-square)
@@ -8,7 +10,7 @@
 
 A tool for picture uploading. Both CLI & api supports. It also supports plugin system, please check [Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo) to find powerful plugins.
 
-Based on Picgo-Core and add more features.
+Based on PicGo-Core with additional features.
 
 **Typora support natively**.
 
@@ -18,7 +20,7 @@ Based on Picgo-Core and add more features.
   - Set watermark and compress parameters through `picgo set buildin watermark` and `picgo set buildin compress` under CLI command
   - Image processing is beforeTransform, which does not conflict with any plugin
 - Add support for advanced rename, you can set the rename rule through `picgo set buildin rename` under the CLI command
-- Add new built-in picbed: WebDAV, SFTP, Local path
+- Add new built-in picbed: WebDAV, SFTP, Local path, AWS S3
 - Adds support for imgur account uploads
 - Built-in server just like PicList-Desktop server, you can use `picgo-server` to start the server
 - Fix several bugs of PicGo-Core
@@ -113,6 +115,15 @@ 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`.

package/README_cn.md

@@ -0,0 +1,239 @@
+# PicList-Core
+
+[English](./README.md) | 简体中文
+
+![standard](https://img.shields.io/badge/code%20style-standard-green.svg?style=flat-square)
+![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)
+![node](https://img.shields.io/badge/node-%3E%3D16.0.0-blue?style=flat-square)
+
+![picgo-core](https://cdn.jsdelivr.net/gh/Molunerfinn/test/picgo/picgo-core-fix.jpg)
+
+一个用于图片上传的工具。同时支持CLI和API调用。它还支持插件系统，请查看[Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo)获取强大的插件。
+
+基于PicGo-Core并添加了更多功能。
+
+**原生支持Typora**。
+
+## 新增功能
+
+- 增加水印、压缩和转换图片格式功能
+  - 通过CLI命令`picgo set buildin watermark`和`picgo set buildin compress`设置水印和压缩参数
+  - 图像处理在beforeTransform阶段进行，不会与任何插件冲突
+- 增加高级重命名支持，你可以通过CLI命令`picgo set buildin rename`设置重命名规则
+- 新增内置图床：WebDAV、SFTP、本地路径、AWS S3
+- 增加对imgur账户上传的支持
+- 内置服务器功能，与PicList-Desktop服务器相似，你可以使用`picgo-server`启动服务器
+- 修复了PicGo-Core的多个错误
+
+## 安装
+
+PicList需要node.js >= 16版本
+
+### 安装前准备
+
+由于PicList依赖[sharp](https://sharp.pixelplumbing.com/)，你需要在安装PicList前先安装sharp。
+
+```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
+```
+
+### 全局安装
+
+```bash
+npm install piclist -g
+
+# 或者
+
+yarn global add piclist
+```
+
+### 本地安装
+
+```bash
+npm install piclist -D
+
+# 或者
+
+yarn add piclist -D
+```
+
+## 使用方法
+
+### Docker
+
+你可以使用Docker运行PicList-Core。
+
+#### docker run
+
+将`./piclist`更改为你自己的路径，该路径是放置`config.json`文件的位置，并将`piclist123456`更改为你自己的密钥。
+
+```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
+
+从本仓库下载`docker-compose.yml`，或将以下内容复制到`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
+```
+
+你可以将`./piclist`更改为你自己的路径，该路径是放置`config.json`文件的位置，并在`command`中更改密钥。
+
+然后运行:
+
+```bash
+docker-compose up -d
+```
+
+#### 在Docker中安装插件
+
+你可以使用`docker exec`在Docker中安装插件。
+
+```bash
+docker exec -it piclist sh
+picgo install picgo-plugin-xxx
+```
+
+#### 在Docker中更新配置
+
+你可以使用`docker exec`在Docker中更新配置。
+
+```bash
+docker exec -it piclist sh
+picgo set xxx
+```
+
+### 服务器
+
+你可以使用`picgo-server`启动服务器，默认端口为`36677`。
+
+启动服务器:
+
+```bash
+picgo-server
+node ./bin/picgo-server
+```
+
+> 强烈建议添加`--key`参数以避免未经授权的访问。例如：`picgo-server --key 123456`
+
+显示帮助:
+
+```bash
+$ picgo-server -h
+
+  Usage: picgo-server [options]
+
+  Options:
+
+    -h, --help          显示帮助信息
+    -c, --config        设置配置路径
+    -p, --port          设置端口，默认端口为36677
+    --host              设置主机，默认主机为0.0.0.0
+    -k, --key           设置密钥以避免未经授权的访问
+    -v, --version       显示版本号
+
+  Examples:
+    picgo-server -c /path/to/config.json
+    picgo-server -k 123456
+    picgo-server -c /path/to/config.json -k 123456
+```
+
+#### 接口
+
+- `/upload?picbed=xxx&key=xxx` 上传图片，`picbed`用于设置图床，`key`用于设置密钥
+- `/heartbeat` 心跳检测
+
+### CLI使用
+
+> PicList-Core使用`SM.MS`作为默认上传图床。
+
+显示帮助:
+
+```bash
+$ picgo -h
+
+  Usage: picgo [options] [command]
+
+  Options:
+
+    -v, --version                 输出版本号
+    -d, --debug                   调试模式
+    -s, --silent                  静默模式
+    -c, --config <path>           设置配置路径
+    -h, --help                    输出使用信息
+
+  Commands:
+
+    install|add <plugins...>             安装picgo插件
+    uninstall|rm <plugins...>            卸载picgo插件
+    update <plugins...>                  更新picgo插件
+    set|config <module> [name]           配置picgo模块
+    upload|u [input...]                  上传，开始上传
+    use [module]                         使用picgo模块
+    init [options] <template> [project]  创建picgo插件的开发模板
+```
+
+#### 从路径上传图片
+
+```bash
+picgo upload /xxx/xx/xx.jpg
+```
+
+#### 从剪贴板上传图片
+
+> 从剪贴板获取的图片将被转换为`png`格式
+
+```bash
+picgo upload
+```
+
+### 在Node项目中使用
+
+#### CommonJS
+
+```js
+const { PicGo } = require('piclist')
+```
+
+#### ES模块
+
+```js
+import { PicGo } from 'piclist'
+```
+
+#### API使用示例
+
+```js
+const picgo = new PicGo()
+
+// 从路径上传图片
+picgo.upload(['/xxx/xxx.jpg'])
+
+// 从剪贴板上传图片
+picgo.upload()
+```
+
+## 文档
+
+获取更多详细信息，请查看[PicGo-Core文档](https://picgo.github.io/PicGo-Core-Doc/)。

package/bin/picgo

@@ -1,25 +1,25 @@
-#!/usr/bin/env node
-const path = require('path')
-const minimist = require('minimist')
-const os = require('os')
-
-const argv = minimist(process.argv.slice(2))
-let configPath = argv.c || argv.config || ''
-if (configPath !== true && configPath !== '') {
-  configPath = configPath.replace(/^~/, os.homedir())
-  configPath = path.resolve(configPath)
-} else {
-  configPath = ''
-}
-const { PicGo } = require('..')
-const picgo = new PicGo(configPath)
-picgo.registerCommands()
-
-try {
-  picgo.cmd.program.parse(process.argv)
-} catch (e) {
-  picgo.log.error(e)
-  if (process.argv.includes('--debug')) {
-    Promise.reject(e)
-  }
-}
+#!/usr/bin/env node
+const path = require('path')
+const minimist = require('minimist')
+const os = require('os')
+
+const argv = minimist(process.argv.slice(2))
+let configPath = argv.c || argv.config || ''
+if (configPath !== true && configPath !== '') {
+  configPath = configPath.replace(/^~/, os.homedir())
+  configPath = path.resolve(configPath)
+} else {
+  configPath = ''
+}
+const { PicGo } = require('..')
+const picgo = new PicGo(configPath)
+picgo.registerCommands()
+
+try {
+  picgo.cmd.program.parse(process.argv)
+} catch (e) {
+  picgo.log.error(e)
+  if (process.argv.includes('--debug')) {
+    Promise.reject(e)
+  }
+}