README.md

images-upload-cli

Upload images via APIs

Installation • Hostings • Usage • Env Variables

Installation

PyPI

pipx install images-upload-cli
# or
pip install images-upload-cli

AUR

yay -S python-images-upload-cli

Windows executable is attached to the GitHub release.

Hostings

host	key required	return example
anhmoe	-	https://cdn.anh.moe/c/{id}.png
beeimg	-	https://beeimg.com/images/{id}.png
catbox	-	https://files.catbox.moe/{id}
fastpic	-	https://i120.fastpic.org/big/2022/0730/d9/{id}.png
filecoffee	-	https://file.coffee/u/{id}.png
freeimage	-	https://iili.io/{id}.png
gyazo	+	https://i.gyazo.com/{id}.png
imageban	+	https://i2.imageban.ru/out/2022/07/30/{id}.png
imagebin	-	https://ibin.co/{id}.png
imgbb	+	https://i.ibb.co/{id}/image.png
imgchest	+	https://cdn.imgchest.com/files/{id}.png
imgur	-	https://i.imgur.com/{id}.png
lensdump	+	https://i.lensdump.com/i/{id}.png
pixeldrain	+	https://pixeldrain.com/api/file/{id}
pixhost	-	https://img75.pixhost.to/images/69/{id}_img.png
ptpimg	+	https://ptpimg.me/{id}.png
smms	+	https://s2.loli.net/2022/07/30/{id}.png
sxcu	-	https://sxcu.net/{id}.png
telegraph	-	https://telegra.ph/file/{id}.png
thumbsnap	+	https://thumbsnap.com/i/{id}.png
tixte	+	https://{domain}.tixte.co/r/{id}.png
up2sha	+	https://up2sha.re/media/raw/{id}.png
uplio	+	https://upl.io/i/{id}.png
uploadcare	+	https://ucarecdn.com/{id}/img.png
vgy	+	https://i.vgy.me/{id}.png

Usage

CLI Reference

Usage: images-upload-cli [OPTIONS] IMAGES...

  Upload images via APIs.

Options:
  -h, --hosting [anhmoe|beeimg|catbox|fastpic|filecoffee|freeimage|gyazo|imageban|imagebin|imgbb|imgchest|imgur|lensdump|pixeldrain|pixhost|ptpimg|smms|sxcu|telegraph|thumbsnap|tixte|up2sha|uplio|uploadcare|vgy]
                                  [default: imgur]
  -f, --format [plain|bbcode|html|markdown]
                                  The format of the links to be generated.  [default: plain]
  -t, --thumbnail                 Create captioned thumbnails. By default, in bbcode format.
  -n, --notify                    Send desktop notification on completion. Required libnotify.
  --clipboard / --no-clipboard    Copy the result to the clipboard.  [default: clipboard]
  --env-file FILE                 The path to the environment file. Takes precedence over the default config file.
  --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                  Use DEBUG to show debug logs. Use CRITICAL to suppress all logs.  [default: INFO]
  --version                       Show the version and exit.
  --help                          Show this message and exit.

Env variables

CAPTION_FONT= # The default font is system dependent.

FREEIMAGE_KEY=
GYAZO_TOKEN=
IMAGEBAN_TOKEN=
IMGBB_KEY=
IMGCHEST_KEY=
IMGUR_CLIENT_ID=
LENSDUMP_KEY=
PIXELDRAIN_KEY=
PTPIMG_KEY=
SMMS_KEY=
THUMBSNAP_KEY=
TIXTE_KEY=
UP2SHA_KEY=
UPLIO_KEY=
UPLOADCARE_KEY=
VGY_KEY=

You can set these in environment variables, or in .env file:

• Unix: ~/.config/images-upload-cli/.env
• MacOS: ~/Library/Application Support/images-upload-cli/.env
• Windows: C:\Users\<user>\AppData\Roaming\images-upload-cli\.env