图片上传引擎PicGo/PicGo-Core

特别感谢：

NocoBase，AI + 无代码构建可靠的业务系统

PicGo-Core

standard
GitHub
Build Status
npm
PicGo Convention
node

picgo-core

一个用于上传图片的工具。同时支持 CLI 和 API。它还支持插件系统，请查看 Awesome-PicGo 以寻找强大的插件。

更多详情请参见 PicGo 的主页。

Typora 原生支持 PicGo-Core。

安装

PicGo 需要 Node.js >= 20.19.0 或 >= 22.12.0。对于较旧的 PicGo 版本（= 16 即可。因为我们需要 ES Module 支持的稳定性。

全局安装

npm install picgo -g

或者

yarn global add picgo

本地安装

npm install picgo -D

或者

yarn add picgo -D

使用方法

在 CLI 中使用

PicGo 使用 SM.MS(S.EE) 作为默认的上传图片图床。

显示帮助：

$ picgo -h

Usage: picgo [options] [command]

Options:
-v, --version                            output the version number
-d, --debug                              debug mode
-s, --silent                             silent mode
-c, --config                       set config path
-p, --proxy                         set proxy for uploading
-h, --help                               display help for command

Commands:
install|add [options]        install picgo plugin
uninstall|rm                 uninstall picgo plugin
update [options]             update picgo plugin
set  [name] [configName]         configure config of picgo modules (uploader/transformer/plugin)
upload|u [input...]                      upload, go go go
use [module] [name] [configName]         use module (uploader/transformer/plugin) of picgo
get                                       获取当前 picgo 模块配置（上传器/转换器/插件）
i18n [lang]                              更改 picgo 语言
uploader                                 管理上传器配置
server [options]                         将 PicGo 作为独立服务器运行
login [token]                            登录 cloud.picgo.app
logout                                   退出登录 cloud.picgo.app
cloud                                    管理 PicGo Cloud
help [command]                           显示命令帮助

从路径上传图片

picgo upload /xxx/xx/xx.jpg

从剪贴板上传图片

来自剪贴板的图片将被转换为 png

picgo upload

感谢 vs-picgo 和 Spades-S 提供了从剪贴板上传图片的方法。

作为服务器运行

picgo server -p 36677 -h 127.0.0.1

登录 PicGo Cloud

picgo login
或
picgo login

退出登录 PicGo Cloud

picgo logout

检查 PicGo Cloud 登录状态

使用 picgo cloud auth status 检查当前 PicGo Cloud 登录状态，而不会触发交互式登录。该检查是非阻塞的：当本地没有 token 时，它会立即返回，不会发起任何网络请求。

picgo cloud auth status

机器可读输出
picgo cloud auth status --format json

该命令会设置进程退出码，因此可以在脚本中使用：

| 状态          | 含义                                             | 退出码    |
| ------------- | ------------------------------------------------ | --------- |
| logged_in   | Token 有效                                       | 0       |
| logged_out  | 没有本地 token                                   | 1       |
| invalid     | Token 存在但被服务器拒绝（401）                  | 2       |
| error       | 探测失败（网络/服务器错误）                      | 3       |

--format json 输出为单行，例如：

{"status":"logged_in","loggedIn":true,"user":"someone","plan":1}

检查当前模块配置

使用 picgo get 读取当前选中的 picgo 模块。每个子命令都支持 --format pretty|json（默认为 pretty）。

当前上传器类型（按 picBed.uploader -> picBed.current -> picgo-cloud 解析）
picgo get uploader

当前转换器（默认为 path）
picgo get transformer

已安装插件及其启用/禁用状态
picgo get plugins

机器可读输出
picgo get uploader --format json
picgo get plugins --format json

在 json 模式下，每个命令都会输出一行可解析内容，例如：

{"uploader":"github"}
{"transformer":"path"}
{"plugins":[{"name":"picgo-plugin-xxx","enabled":true}]}

管理上传器配置
自 v1.8.0 起，PicGo-Core 支持每个上传器配置多个配置。就像 Electron 版 PicGo 的配置一样。

你可以使用 picgo set uploader  [configName] 来配置不同的上传器配置。

并且你可以使用 picgo use uploader  [configName] 在不同的上传器配置之间切换。

例如：

picgo set uploader github Test

picgo use uploader github Test

如需了解更多详情，你可以使用 picgo uploader -h 查看上传器管理的帮助：

Usage: picgo uploader [options] [command]

Options:
-h, --help                                display help for command

Commands:
list [type]                               list uploader configurations
rename            rename a config
copy     copy a config (does not switch current uploader)
rm                      remove a config

初始化 picgo 插件模板

注意：插件的模板初始化器已移至独立的 picgo-init 包。

你可以使用以下命令初始化 picgo 插件模板：

npx picgo-init plugin

在 node 项目中使用

Common JS

const { PicGo } = require('picgo')

ES Module

import { PicGo } from 'picgo'

API 使用示例

const picgo = new PicGo()

// upload a picture from path
picgo.upload(['/xxx/xxx.jpg'])

// upload a picture from clipboard
picgo.upload()

文档

如需了解更多详情，你可以查看文档。