tgbox-cli 1.3

A Command Line Interface to the TGBOX

A Command Line Interface to the TGBOX

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

Installation

To build the TGBOX-CLI you will need to have at least Python 3.8.

Windows builds (.EXE)

You can use already created executable builds if you're on Windows.
See Releases GitHub page or navigate to the official TGBOX dev.channel

Build the TGBOX-CLI

To make all features work, you will also need the FFmpeg installed in your system (it should
be also accessible by the simple ffmpeg command from your Terminal, in other words: in PATH).

Install with PIP

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 build 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]

PyInstaller

If you want to make your own .EXE build with FFmpeg, you will need to download
it and place inside the tgbox/other directory (on Windows only). See this:

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 # Make sure to place here ffmpeg.exe

(after you dropped the ffmpeg.exe to the tgbox/other):

cd ../../.. # Move back
pip install ./tgbox[fast]

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

cd tgbox-cli/pyinstaller
pyinstaller tgbox_cli.spec

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

Please note that You can also set TGBOX_CLI_NON_ONEFILE env variable to build without packing
into one executable file & feel free to remove the tgbox-cli-env folder after work was done.

Usage

The TGBOX-CLI is a typical Command-Line application. After install, it can be ran as follows:

tgbox-cli

This should output 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 problems (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 content to the bug report.

Thanks.