https://github.com/picgo/picgo-core
:zap:A tool for pictures uploading. Both CLI & API supports.
https://github.com/picgo/picgo-core
picgo picture-upload upload-pictures
Last synced: 4 months ago
JSON representation
:zap:A tool for pictures uploading. Both CLI & API supports.
- Host: GitHub
- URL: https://github.com/picgo/picgo-core
- Owner: PicGo
- License: mit
- Created: 2018-09-17T07:26:44.000Z (almost 8 years ago)
- Default Branch: dev
- Last Pushed: 2026-02-04T03:45:59.000Z (4 months ago)
- Last Synced: 2026-02-04T13:54:21.546Z (4 months ago)
- Topics: picgo, picture-upload, upload-pictures
- Language: TypeScript
- Homepage: https://docs.picgo.app/core/
- Size: 618 KB
- Stars: 932
- Watchers: 6
- Forks: 97
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/funding.yml
- License: License
- Codeowners: .github/CODEOWNERS
- Agents: AGENTS.md
Awesome Lists containing this project
README
Special thanks to:
### [Warp, the intelligent terminal for developers](https://go.warp.dev/picgo)
[Available for MacOS, Linux, & Windows](https://go.warp.dev/picgo)
---
# PicGo-Core
[](https://actions-badge.atrox.dev/picgo/picgo-core/goto?ref=master)
[](https://github.com/PicGo/bump-version)
A tool for image uploading. Both CLI & api supports. It also supports plugin system, please check [Awesome-PicGo](https://github.com/PicGo/Awesome-PicGo) to find powerful plugins.
More details please see the [Homepage](https://picgo.app/) of PicGo.
**Typora supports PicGo-Core natively**.
## Installation
PicGo requires Node.js >= 20.19.0 or >= 22.12.0. For older PicGo versions (<= v1.5.x), Node.js >= 16 is sufficient. Cause we need the [stability of ES Module support](https://joyeecheung.github.io/blog/2025/12/30/require-esm-in-node-js-from-experiment-to-stability/).
### Global install
```bash
npm install picgo -g
# or
yarn global add picgo
```
### Local install
```bash
npm install picgo -D
# or
yarn add picgo -D
```
## Usage
### Use in CLI
> PicGo uses `SM.MS(S.EE)` as the default upload image host.
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 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
i18n [lang] change picgo language
uploader manage uploader configurations
server [options] run PicGo as a standalone server
login [token] login to cloud.picgo.app
logout logout from cloud.picgo.app
help [command] display help for command
```
#### 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
```
Thanks to [vs-picgo](https://github.com/Spades-S/vs-picgo) && [Spades-S](https://github.com/Spades-S) for providing the method to upload picture from clipboard.
#### Run as a server
```bash
picgo server -p 36677 -h 127.0.0.1
```
#### Login to PicGo Cloud
```bash
picgo login
# or
picgo login
```
#### Logout from PicGo Cloud
```bash
picgo logout
```
#### Manage uploader configs
Since v1.8.0, PicGo-Core supports multiple configurations per uploader. Just like the configuration of the Electron version of PicGo.
You can use `picgo set uploader [configName]` to configure different uploader configurations.
And you can use `picgo use uploader [configName]` to switch between different uploader configurations.
For example:
```bash
picgo set uploader github Test
picgo use uploader github Test
```
For more details, you can use `picgo uploader -h` to check the help of uploader management:
```bash
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
```
#### Init a picgo plugin template
Note: the plugin's template initializer has moved to the standalone [picgo-init](https://github.com/PicGo/PicGo-Init) package.
You can use the following command to init a picgo plugin template:
```bash
npx picgo-init plugin
```
### Use in node project
#### Common JS
```js
const { PicGo } = require('picgo')
```
#### ES Module
```js
import { PicGo } from 'picgo'
```
#### 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](https://docs.picgo.app/core/).