Skip to main content

CLI to Upload Files to a ShareX Server using a ShareX Custom Uploader (.sxcu) Configuration File.

Project description

PyPI Version GitHub Release Version TOML Python Version PyPI Downloads Pepy Total Downloads Codecov Workflow Lint Workflow Test Deployment PyPi Deployment Docs GitHub Last Commit GitHub Repo Size GitHub Top Language GitHub Contributors GitHub Issues GitHub Discussions GitHub Forks GitHub Repo Stars GitHub Org Stars Discord Ko-fi

ShareX CLI

ShareX CLI

Command Line Interface to Upload Files to a ShareX Server using a ShareX Custom Uploader .sxcu configuration file.

Upload any file, multiple files, directories, use globs, create archives and much more...

To get started Install the app and view the Usage.

If you run into any issues or have any questions, support is available.

View Documentation

Features

  • Use a ShareX Custom Uploader *.sxcu config.
  • Upload a file or multiple files.
  • Specify a custom file name.
  • Upload files in a directory with optional glob.
  • Upload a directory as an archive.
  • Automatically open the URL in browser.
  • Automatically copy the URL to the clipboard.
  • Display confirmation before uploading multiple files.
  • Override all options with flags or env vars.

Install

From PyPI: https://pypi.org/p/sharex-cli

pip install sharex-cli

From GitHub.

pip install git+https://github.com/cssnr/sharex-cli.git

From source.

git clone https://github.com/cssnr/sharex-cli.git
pip install sharex-cli

View Install Guide

Setup

To configure you need your server's ShareX Custom Uploader *.sxcu configuration JSON.

The app will automatically enter configuration on the first run.

sharex

This allows you to enter a file path, or open a text editor to enter the contents.

You can reconfigure with --config and pass a path to the config file.

sharex --config path/to/config.sxcu

View Setup Guide

Usage

Once the configuration is saved you can upload a file, or multiple.

sharex file1.txt /path/to/file2.txt

You can upload the contents of a directory, default glob is *.

sharex dir1

Or create an archive of the directory (no glob support).

sharex /path/to/dir2 -a

View Uploading Guide

Support

For general help or to request a feature, see:

If you are experiencing an issue/bug or getting unexpected results, you can:

Features Issues Discussions Discord

Contributing

If you would like to submit a PR, please review the CONTRIBUTING.md.

Please consider making a donation to support the development of this project and additional open source projects.

Ko-fi

For a full list of current projects visit: https://cssnr.github.io/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sharex_cli-0.0.1.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sharex_cli-0.0.1-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file sharex_cli-0.0.1.tar.gz.

File metadata

  • Download URL: sharex_cli-0.0.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sharex_cli-0.0.1.tar.gz
Algorithm Hash digest
SHA256 7455da4d17eaf46e923ac2526f80b9e16f9d4c64cb5ce5c3a0954b2c02e6bda4
MD5 e2690beeea90746175a07559212d27d6
BLAKE2b-256 5081f2d66a58f188e42ae84de0f7adc006f0d3f9c4bf6c974adc1ab693169455

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharex_cli-0.0.1.tar.gz:

Publisher: release.yaml on cssnr/sharex-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sharex_cli-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: sharex_cli-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sharex_cli-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b0316022fadf81bea7b15160944aca5e61d17e1cf48562c5945b25f7c2b73139
MD5 2ddae72907a6bc4a19cb192da8c990de
BLAKE2b-256 c3e4f44f9e83306506e827d995c8b053bf85e38b104478144e55076a78cc3420

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharex_cli-0.0.1-py3-none-any.whl:

Publisher: release.yaml on cssnr/sharex-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page