https://github.com/ttionya/picgo-plugin-lychee

PicGo plugin for uploading to Lychee.
https://github.com/ttionya/picgo-plugin-lychee

lychee picgo picgo-plugin

Last synced: 3 months ago
JSON representation

PicGo plugin for uploading to Lychee.

• Host: GitHub
• URL: https://github.com/ttionya/picgo-plugin-lychee
• Owner: ttionya
• License: mit
• Created: 2023-08-16T11:58:07.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-06-01T06:49:33.000Z (5 months ago)
• Last Synced: 2024-06-06T16:10:03.957Z (5 months ago)
• Topics: lychee, picgo, picgo-plugin
• Language: TypeScript
• Homepage:
• Size: 329 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-PicGo - picgo-plugin-lychee

README

        
# picgo-plugin-lychee

[![npm](https://img.shields.io/npm/v/picgo-plugin-lychee?label=NPM&logo=npm)](https://www.npmjs.com/package/picgo-plugin-lychee) [![npm](https://img.shields.io/npm/dm/picgo-plugin-lychee?label=Downloads&logo=npm)](https://www.npmjs.com/package/picgo-plugin-lychee) [![npm](https://img.shields.io/npm/l/picgo-plugin-lychee?label=License&logo=npm)](https://github.com/ttionya/picgo-plugin-lychee/blob/master/LICENSE)

[PicGo](https://github.com/PicGo/PicGo-Core) plugin for uploading to [Lychee](https://github.com/LycheeOrg/Lychee).




## Install

- for GUI: search `lychee` and install

- for Core: run `picgo add lychee`

- for Typora: See [here](#for-typora)




## Configuration

For Core user, you can run `picgo set uploader lychee` to enter interactive configuration.

For GUI user, you can configure in `Picbeds Settings`.

### `url`

- `Required`

- Example: `https://mylychee.com`

Lychee web URL, including the protocol.

### `token`

- `Required`

- Example: `xxxxxxxxxxxxx`

Lychee API token.

You can generate an API Token from the settings.

![](https://raw.githubusercontent.com/ttionya/picgo-plugin-lychee/master/assets/20230820144556.png)

### `albumId`

- Default: `unsorted`

- Example: `mTmo_j9SVEie3ETcCMY3YruI`

Album ID, you can only use regular `Album`, **not** `Tag Album`.

After entering the album, you can find the album ID in the URL.

![](https://raw.githubusercontent.com/ttionya/picgo-plugin-lychee/master/assets/20230820145149.png)

### `uniqueImage`

- Default: `false`

If you want to ensure that identical images in the album are unique, you can enable this option.

Enabling this option will result in additional requests and hash calculations during upload, which may consume more network and system resources.

### `uniqueImageSizeLimit`

- Default: `100m`

- Example: `1g` `500k` `1048576` `1m`

This setting only takes effect when `uniqueImage` is enabled.

It further prevents excessive system resource usage when calculating hashes for large images. Images larger than this value will no longer be guaranteed to be unique in the album.




## For Typora

The internally packaged PicGo-Core in Typora uses Node.js `v12.13.0` and PicGo-Core `v1.4.7`. This version is outdated and cannot be compatible with the new APIs required by this tool.

**Please download the latest version of [PicGo-Core](https://github.com/PicGo/PicGo-Core) on your own and use a `custom command` in Typora to specify the use of the latest version of PicGo-Core.**




## LICENSE

MIT