CLI to Upload Files to a ShareX Server using a ShareX Custom Uploader (.sxcu) Configuration File.
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
ShareX CLI
Command Line Interface to Upload Files to a ShareX Server using a ShareX Custom Uploader .sxcu configuration.
Upload any file, multiple files, directories, use globs, create archives and much more...
To get started Install the app, Configure your server and view the Usage.
If you run into any issues or have any questions, support is available.
Features
- Use a ShareX Custom Uploader
*.sxcuconfig. - 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
uv tool install sharex-cli
From GitHub: https://github.com/cssnr/sharex-cli
pip install git+https://github.com/cssnr/sharex-cli.git
uv tool install git+https://github.com/cssnr/sharex-cli.git
Download a Binary: https://github.com/cssnr/sharex-cli/releases/latest
Configure
To configure you need your server's ShareX Custom Uploader *.sxcu configuration JSON.
The --config command allows you to enter the file path, or open a text editor.
sharex --config
Or pass the config path directly to --config.
sharex --config path/to/config.sxcu
Usage
To use run the sharex command with the path to the file to upload.
sharex file.txt
sharex file1.txt file2.txt
sharex file.txt -n name.txt
Directories can be uploaded as files using a glob (default *) or as an archive.
sharex dir1 # non-recursive
sharex dir1 -g '**' # recursive
sharex dir1 -a # create an archive
Tip: you will be shown a confirmation before files are uploaded.
Support
If you run into any issues or need help getting started, please do one of the following:
- Report an Issue: https://github.com/cssnr/sharex-cli/issues
- Q&A Discussion: https://github.com/cssnr/sharex-cli/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/sharex-cli/issues/new?template=1-feature.yaml
- Request Server Support: https://github.com/cssnr/sharex-cli/issues/new?template=2-server.yaml
- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
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.
For a full list of current projects visit: https://cssnr.github.io/
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
