Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: about 1 month 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 (about 6 years ago)
Default Branch: dev
Last Pushed: 2024-07-16T14:53:28.000Z (5 months ago)
Last Synced: 2024-10-31T08:03:33.845Z (about 1 month ago)
Topics: picgo, picture-upload, upload-pictures
Language: TypeScript
Homepage: https://picgo.github.io/PicGo-Core-Doc/
Size: 525 KB
Stars: 828
Watchers: 8
Forks: 83
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License

Awesome Lists containing this project

awesome-web-cn - PicGo-Core - 一个可以让你上传文件到指定图床的 Javascript 库 (Uncategorized / Uncategorized)
jimsghstars - PicGo/PicGo-Core - :zap:A tool for pictures uploading. Both CLI & API supports. (TypeScript)

README

        # PicGo-Core

![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)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fpicgo%2Fpicgo-core%2Fbadge%3Fref%3Dmaster&style=flat-square)](https://actions-badge.atrox.dev/picgo/picgo-core/goto?ref=master)

![npm](https://img.shields.io/npm/v/picgo.svg?style=flat-square)

[![PicGo Convention](https://img.shields.io/badge/picgo-convention-blue.svg?style=flat-square)](https://github.com/PicGo/bump-version)

![node](https://img.shields.io/badge/node-%3E%3D12.0.0-blue?style=flat-square)

![picgo-core](https://cdn.jsdelivr.net/gh/Molunerfinn/test/picgo/picgo-core-fix.jpg)

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.

**Typora supports PicGo-Core natively**. If you like PicGo-Core and have time, welcome to help me translate the documentation of PicGo-Core into English.

## Installation

PicGo should be installed with node.js >= 12 (v1.5.0-alpha.4 and small) & node.js >= 16 (since v1.5.0-alpha.5).

### 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` 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            set config path

    -h, --help                    output usage information

  Commands:

    install|add              install picgo plugin

    uninstall|rm             uninstall picgo plugin

    update                   update picgo plugin

    set|config  [name]           configure config of picgo modules

    upload|u [input...]                  upload, go go go

    use [module]                         use modules of picgo

    init [options]  [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

```

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.

### 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://picgo.github.io/PicGo-Core-Doc/).