A Command Line Interface to the TGBOX

This is a CLI implementation of the TGBOX — an encrypted cloud storage built around the Telegram.

TGBOX-CLI supports all features of the tgbox protocol, adding additional ones
like basic Encrypted Chat and support for unlimited file size (4GB+) uploads.

Installation

Install with PIP

If you have Python 3 on your machine, you can install latest stable release of the tgbox-cli from PyPI:

# Drop [fast] to obtain *slow*, pure-Python build
pip install -U tgbox-cli[fast]

Clone & Install

Alternatively, you can clone this repository and install from the source. This may give you more control over the code:

python -m venv tgbox-cli-env
cd tgbox-cli-env && . bin/activate

git clone https://github.com/NotStatilko/tgbox-cli
pip install ./tgbox-cli[fast]

Builds

We provide GitHub actions repository designed specifically to build the tgbox-cli executables. You
can either get your builds there, or consult the Manual Build chapter.

Manual Build

To build tgbox-cli, you need to have at least Python 3.9 installed on your machine. It is not required, but we use FFmpeg to make previews and extract duration of media files. If you want your executable to support these features, — you should download ffmpeg executable and place it in specific directory before build. We have GitHub Actions repository that is created specifically for building the minimal FFmpeg executables. You can either use them (recommended), or download a build for your machine from official FFMpeg website.

python -m venv tgbox-cli-env
cd tgbox-cli-env && . bin/activate

pip install pyinstaller

git clone https://github.com/NonProjects/tgbox
cd tgbox/tgbox/other # Place ffmpeg executable here

cd ../../.. # Move back

git clone https://github.com/NotStatilko/tgbox-cli
pip install ./tgbox-cli

pip install ./tgbox[fast]

cd tgbox-cli/pyinstaller
pyinstaller tgbox_cli.spec

# Run the executable and show info
dist/tgbox-cli cli-info 

Please note that You can also set TGBOX_CLI_NON_ONEFILE env variable to build without packing
into one executable file. You can freely remove the tgbox-cli-env folder after build is complete.

Usage

TGBOX-CLI is your typical Command-Line application. You can run it just by typing executable name in Terminal:

tgbox-cli

This should return you a list of commands. The help command will give you a full course over TGBOX-CLI.
Use it (as well as --help option on every command) if you don't know anything about this application:

tgbox-cli help

Bug reports

Feel free to report some bugs (I believe there can be many) on the GitHub Issue tab. Any encountered error should be written to the logfile. Use the logfile-open command and attach its contents to the bug report (make sure nothing private is in there).

Thanks.