# images-upload-cli
> Upload images via APIs
[](https://pypi.org/project/images-upload-cli)
[](https://aur.archlinux.org/packages/python-images-upload-cli)
[](https://github.com/deadnews/images-upload-cli/releases/latest)
[](https://deadnews.github.io/images-upload-cli)
[](https://results.pre-commit.ci/latest/github/deadnews/images-upload-cli/main)
[](https://github.com/deadnews/images-upload-cli/actions/workflows/main.yml)
[](https://app.codecov.io/gh/deadnews/images-upload-cli)
**[Installation](#installation)** • **[Hostings](#hostings)** • **[Usage](#usage)** • **[Env Variables](#env-variables)**
## Installation
PyPI
```sh
pipx install images-upload-cli
# or
pip install images-upload-cli
```
AUR
```sh
yay -S python-images-upload-cli
```
Windows executable is attached to the GitHub release.
## Hostings
| host | key required | return example |
| :------------------------------------ | :----------: | :--------------------------------------------------- |
| [anhmoe](https://anh.moe/) | - | `https://cdn.anh.moe/c/{id}.png` |
| [beeimg](https://beeimg.com/) | - | `https://beeimg.com/images/{id}.png` |
| [catbox](https://catbox.moe/) | - | `https://files.catbox.moe/{id}` |
| [fastpic](https://fastpic.org/) | - | `https://i120.fastpic.org/big/2022/0730/d9/{id}.png` |
| [filecoffee](https://file.coffee/) | - | `https://file.coffee/u/{id}.png` |
| [freeimage](https://freeimage.host/) | - | `https://iili.io/{id}.png` |
| [gyazo](https://gyazo.com/) | + | `https://i.gyazo.com/{id}.png` |
| [imageban](https://imageban.ru/) | + | `https://i2.imageban.ru/out/2022/07/30/{id}.png` |
| [imagebin](https://imagebin.ca/) | - | `https://ibin.co/{id}.png` |
| [imgbb](https://imgbb.com/) | + | `https://i.ibb.co/{id}/image.png` |
| [imgchest](https://imgchest.com/) | + | `https://cdn.imgchest.com/files/{id}.png` |
| [imgur](https://imgur.com/) | - | `https://i.imgur.com/{id}.png` |
| [lensdump](https://lensdump.com/) | + | `https://i.lensdump.com/i/{id}.png` |
| [pixeldrain](https://pixeldrain.com/) | + | `https://pixeldrain.com/api/file/{id}` |
| [pixhost](https://pixhost.to/) | - | `https://img75.pixhost.to/images/69/{id}_img.png` |
| [ptpimg](https://ptpimg.me/) | + | `https://ptpimg.me/{id}.png` |
| [smms](https://sm.ms/) | + | `https://s2.loli.net/2022/07/30/{id}.png` |
| [sxcu](https://sxcu.net/) | - | `https://sxcu.net/{id}.png` |
| [telegraph](https://telegra.ph/) | - | `https://telegra.ph/file/{id}.png` |
| [thumbsnap](https://thumbsnap.com/) | + | `https://thumbsnap.com/i/{id}.png` |
| [tixte](https://tixte.com/) | + | `https://{domain}.tixte.co/r/{id}.png` |
| [up2sha](https://up2sha.re/) | + | `https://up2sha.re/media/raw/{id}.png` |
| [uplio](https://upl.io/) | + | `https://upl.io/i/{id}.png` |
| [uploadcare](https://uploadcare.com/) | + | `https://ucarecdn.com/{id}/img.png` |
| [vgy](https://vgy.me/) | + | `https://i.vgy.me/{id}.png` |
## Usage
[CLI Reference](https://deadnews.github.io/images-upload-cli/reference-cli/)
```sh
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
```ini
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`
Raw data
{
"_id": null,
"home_page": "https://github.com/DeadNews/images-upload-cli",
"name": "images-upload-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "cli, imgur, image-upload, upload-images, upload-pictures",
"author": "DeadNews",
"author_email": "deadnewsgit@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4a/ce/a3cd90641d227eda5446de187c244f8e2278e35360d73ee43e35da8326b0/images_upload_cli-3.0.4.tar.gz",
"platform": null,
"description": "# images-upload-cli\n\n> Upload images via APIs\n\n[](https://pypi.org/project/images-upload-cli)\n[](https://aur.archlinux.org/packages/python-images-upload-cli)\n[](https://github.com/deadnews/images-upload-cli/releases/latest)\n[](https://deadnews.github.io/images-upload-cli)\n[](https://results.pre-commit.ci/latest/github/deadnews/images-upload-cli/main)\n[](https://github.com/deadnews/images-upload-cli/actions/workflows/main.yml)\n[](https://app.codecov.io/gh/deadnews/images-upload-cli)\n\n**[Installation](#installation)** \u2022 **[Hostings](#hostings)** \u2022 **[Usage](#usage)** \u2022 **[Env Variables](#env-variables)**\n\n## Installation\n\nPyPI\n\n```sh\npipx install images-upload-cli\n# or\npip install images-upload-cli\n```\n\nAUR\n\n```sh\nyay -S python-images-upload-cli\n```\n\nWindows executable is attached to the GitHub release.\n\n## Hostings\n\n| host | key required | return example |\n| :------------------------------------ | :----------: | :--------------------------------------------------- |\n| [anhmoe](https://anh.moe/) | - | `https://cdn.anh.moe/c/{id}.png` |\n| [beeimg](https://beeimg.com/) | - | `https://beeimg.com/images/{id}.png` |\n| [catbox](https://catbox.moe/) | - | `https://files.catbox.moe/{id}` |\n| [fastpic](https://fastpic.org/) | - | `https://i120.fastpic.org/big/2022/0730/d9/{id}.png` |\n| [filecoffee](https://file.coffee/) | - | `https://file.coffee/u/{id}.png` |\n| [freeimage](https://freeimage.host/) | - | `https://iili.io/{id}.png` |\n| [gyazo](https://gyazo.com/) | + | `https://i.gyazo.com/{id}.png` |\n| [imageban](https://imageban.ru/) | + | `https://i2.imageban.ru/out/2022/07/30/{id}.png` |\n| [imagebin](https://imagebin.ca/) | - | `https://ibin.co/{id}.png` |\n| [imgbb](https://imgbb.com/) | + | `https://i.ibb.co/{id}/image.png` |\n| [imgchest](https://imgchest.com/) | + | `https://cdn.imgchest.com/files/{id}.png` |\n| [imgur](https://imgur.com/) | - | `https://i.imgur.com/{id}.png` |\n| [lensdump](https://lensdump.com/) | + | `https://i.lensdump.com/i/{id}.png` |\n| [pixeldrain](https://pixeldrain.com/) | + | `https://pixeldrain.com/api/file/{id}` |\n| [pixhost](https://pixhost.to/) | - | `https://img75.pixhost.to/images/69/{id}_img.png` |\n| [ptpimg](https://ptpimg.me/) | + | `https://ptpimg.me/{id}.png` |\n| [smms](https://sm.ms/) | + | `https://s2.loli.net/2022/07/30/{id}.png` |\n| [sxcu](https://sxcu.net/) | - | `https://sxcu.net/{id}.png` |\n| [telegraph](https://telegra.ph/) | - | `https://telegra.ph/file/{id}.png` |\n| [thumbsnap](https://thumbsnap.com/) | + | `https://thumbsnap.com/i/{id}.png` |\n| [tixte](https://tixte.com/) | + | `https://{domain}.tixte.co/r/{id}.png` |\n| [up2sha](https://up2sha.re/) | + | `https://up2sha.re/media/raw/{id}.png` |\n| [uplio](https://upl.io/) | + | `https://upl.io/i/{id}.png` |\n| [uploadcare](https://uploadcare.com/) | + | `https://ucarecdn.com/{id}/img.png` |\n| [vgy](https://vgy.me/) | + | `https://i.vgy.me/{id}.png` |\n\n## Usage\n\n[CLI Reference](https://deadnews.github.io/images-upload-cli/reference-cli/)\n\n```sh\nUsage: images-upload-cli [OPTIONS] IMAGES...\n\n Upload images via APIs.\n\nOptions:\n -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]\n [default: imgur]\n -f, --format [plain|bbcode|html|markdown]\n The format of the links to be generated. [default: plain]\n -t, --thumbnail Create captioned thumbnails. By default, in bbcode format.\n -n, --notify Send desktop notification on completion. Required libnotify.\n --clipboard / --no-clipboard Copy the result to the clipboard. [default: clipboard]\n --env-file FILE The path to the environment file. Takes precedence over the default config file.\n --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]\n Use DEBUG to show debug logs. Use CRITICAL to suppress all logs. [default: INFO]\n --version Show the version and exit.\n --help Show this message and exit.\n```\n\n## Env variables\n\n```ini\nCAPTION_FONT= # The default font is system dependent.\n\nFREEIMAGE_KEY=\nGYAZO_TOKEN=\nIMAGEBAN_TOKEN=\nIMGBB_KEY=\nIMGCHEST_KEY=\nIMGUR_CLIENT_ID=\nLENSDUMP_KEY=\nPIXELDRAIN_KEY=\nPTPIMG_KEY=\nSMMS_KEY=\nTHUMBSNAP_KEY=\nTIXTE_KEY=\nUP2SHA_KEY=\nUPLIO_KEY=\nUPLOADCARE_KEY=\nVGY_KEY=\n```\n\nYou can set these in environment variables, or in `.env` file:\n\n- Unix: `~/.config/images-upload-cli/.env`\n- MacOS: `~/Library/Application Support/images-upload-cli/.env`\n- Windows: `C:\\Users\\<user>\\AppData\\Roaming\\images-upload-cli\\.env`\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Upload images via APIs",
"version": "3.0.4",
"project_urls": {
"Documentation": "https://deadnews.github.io/images-upload-cli",
"Homepage": "https://github.com/DeadNews/images-upload-cli",
"Repository": "https://github.com/DeadNews/images-upload-cli"
},
"split_keywords": [
"cli",
" imgur",
" image-upload",
" upload-images",
" upload-pictures"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a8314ad5cd98e0cd4392d99c623828e91fa2857a2ea9fbb60aa3fc90323cefc",
"md5": "9d92dedc454f2ae944be27dc7b566975",
"sha256": "c974f9258be5bbf57af4dc7ddd2519739fc1fe0dadae9264e622d24ae7ce1a10"
},
"downloads": -1,
"filename": "images_upload_cli-3.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d92dedc454f2ae944be27dc7b566975",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 13483,
"upload_time": "2024-10-11T16:06:15",
"upload_time_iso_8601": "2024-10-11T16:06:15.289851Z",
"url": "https://files.pythonhosted.org/packages/7a/83/14ad5cd98e0cd4392d99c623828e91fa2857a2ea9fbb60aa3fc90323cefc/images_upload_cli-3.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4acea3cd90641d227eda5446de187c244f8e2278e35360d73ee43e35da8326b0",
"md5": "39871ef94fe290c06d8878b647dc5eda",
"sha256": "2b98086dc5b3355d9ddbf3934dbd488820c25cb05dd07954e980cc80e191ac4a"
},
"downloads": -1,
"filename": "images_upload_cli-3.0.4.tar.gz",
"has_sig": false,
"md5_digest": "39871ef94fe290c06d8878b647dc5eda",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 13602,
"upload_time": "2024-10-11T16:06:16",
"upload_time_iso_8601": "2024-10-11T16:06:16.498357Z",
"url": "https://files.pythonhosted.org/packages/4a/ce/a3cd90641d227eda5446de187c244f8e2278e35360d73ee43e35da8326b0/images_upload_cli-3.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 16:06:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DeadNews",
"github_project": "images-upload-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "images-upload-cli"
}
JSON
