# A *C*ommand *L*ine *I*nterface to the TGBOX
This is a [**CLI**](https://en.wikipedia.org/wiki/Command-line_interface) implementation of the [**TGBOX**](https://github.com/NonProjects/tgbox/) — an encrypted cloud storage built around the [**Telegram**](https://telegram.org).
## Installation
To install 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**](https://github.com/NotStatilko/tgbox-cli/releases) or navigate to the [**official TGBOX dev.channel**](https://t.me/nontgbox)
### Build the TGBOX-CLI
To make all features work, you will also need the [**FFmpeg**](https://ffmpeg.org/download.html) 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](https://pypi.org/project/tgbox-cli):
```bash
# 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:
```bash
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:
```bash
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``):
```bash
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
```
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:
```bash
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:
```bash
tgbox-cli help
```
## Bug reports
Feel free to report some problems (i believe there can be many) on the [**GitHub Issue tab**](https://github.com/NotStatilko/tgbox-cli/issues). Any encountered error should be written to the logfile. Use the **logfile-open** command and **attach** its content to the bug report.
**Thanks**.
Raw data
{
"_id": null,
"home_page": "https://github.com/NotStatilko/tgbox-cli",
"name": "tgbox-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Telegram,Cloud-Storage,Cloud,Non-official",
"author": "NotStatilko",
"author_email": "thenonproton@pm.me",
"download_url": "https://files.pythonhosted.org/packages/b3/6c/dbb8baea7a486f41dfd7f35b7c0ead33b3656d03a99cf1396893f89b05c1/tgbox-cli-1.2.1.tar.gz",
"platform": null,
"description": "# A *C*ommand *L*ine *I*nterface to the TGBOX\n\nThis is a [**CLI**](https://en.wikipedia.org/wiki/Command-line_interface) implementation of the [**TGBOX**](https://github.com/NonProjects/tgbox/) \u2014 an encrypted cloud storage built around the [**Telegram**](https://telegram.org).\n\n\n## Installation\n\nTo install the **TGBOX-CLI** you will need to have **at least** Python 3.8.\n\n### Windows builds (.EXE)\n\nYou can use already created executable builds if you're on Windows.\\\nSee [**Releases GitHub page**](https://github.com/NotStatilko/tgbox-cli/releases) or navigate to the [**official TGBOX dev.channel**](https://t.me/nontgbox)\n\n### Build the TGBOX-CLI\n\nTo make all features work, you will also need the [**FFmpeg**](https://ffmpeg.org/download.html) installed in your system (it should\\\nbe also accessible by the simple ``ffmpeg`` command from your Terminal, in other words: in ``PATH``).\n\n#### Install with PIP\n\nYou can install latest *stable* release of the ``tgbox-cli`` from [PyPI](https://pypi.org/project/tgbox-cli):\n```bash\n# Drop [fast] to obtain *slow*, pure-Python build\npip install -U tgbox-cli[fast]\n```\n\n#### Clone & Install\n\nAlternatively, you can clone this repository and build from the source. This may give you more control over the code:\n```bash\npython -m venv tgbox-cli-env\ncd tgbox-cli-env && . bin/activate\n\ngit clone https://github.com/NotStatilko/tgbox-cli\npip install ./tgbox-cli[fast]\n```\n#### PyInstaller\n\nIf you want to make your own .EXE build *with FFmpeg*, you *will need* to download\\\nit and place inside the ``tgbox/other`` directory (on Windows only). See this:\n```bash\npython -m venv tgbox-cli-env\ncd tgbox-cli-env && . bin/activate\n\npip install pyinstaller\n\ngit clone https://github.com/NonProjects/tgbox\ncd tgbox/tgbox/other # Make sure to place here ffmpeg.exe\n```\n(after you dropped the ``ffmpeg.exe`` to the ``tgbox/other``):\n```bash\ncd ../../.. # Move back\npip install ./tgbox[fast]\n\ngit clone https://github.com/NotStatilko/tgbox-cli\npip install ./tgbox-cli[fast]\n\ncd tgbox-cli/pyinstaller\npyinstaller tgbox_cli.spec\n\n# Run the executable and show info\ndist/tgbox-cli.exe cli-info\n```\nFeel free to remove the ``tgbox-cli-env`` folder after work was done.\n\n## Usage\n\nThe TGBOX-CLI is a typical Command-Line application. After install, it can be ran as follows:\n```bash\ntgbox-cli\n```\nThis should output you a list of **commands**. The **help** command will give you a full course over **TGBOX-CLI**.\\\nUse it (as well as ``--help`` *option* on every **command**) if you don't know anything about this application:\n```bash\ntgbox-cli help\n```\n\n## Bug reports\n\nFeel free to report some problems (i believe there can be many) on the [**GitHub Issue tab**](https://github.com/NotStatilko/tgbox-cli/issues). Any encountered error should be written to the logfile. Use the **logfile-open** command and **attach** its content to the bug report. \n\n**Thanks**.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Command Line Interface to the TGBOX",
"version": "1.2.1",
"project_urls": {
"Download": "https://github.com/NotStatilko/tgbox-cli/archive/refs/tags/v1.2.1.tar.gz",
"Homepage": "https://github.com/NotStatilko/tgbox-cli"
},
"split_keywords": [
"telegram",
"cloud-storage",
"cloud",
"non-official"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "daa98e911b9bd25e2a603e16d98ea05d8748d690c9e8aec53ec188590651dcb6",
"md5": "a78ef669230901da9403b4c88f69ac52",
"sha256": "0aff4c3f5baa7de9bf360bc98456ddbd984faebc01fe155da907a69fc27f92d5"
},
"downloads": -1,
"filename": "tgbox_cli-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a78ef669230901da9403b4c88f69ac52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 55744,
"upload_time": "2024-02-15T20:28:04",
"upload_time_iso_8601": "2024-02-15T20:28:04.792397Z",
"url": "https://files.pythonhosted.org/packages/da/a9/8e911b9bd25e2a603e16d98ea05d8748d690c9e8aec53ec188590651dcb6/tgbox_cli-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b36cdbb8baea7a486f41dfd7f35b7c0ead33b3656d03a99cf1396893f89b05c1",
"md5": "67ef366bcf5d54a7418a552f3a62fc1f",
"sha256": "6dc1da65e11935f510633767980c4f4ced6e20029b3aa6274b9a365df67e83a8"
},
"downloads": -1,
"filename": "tgbox-cli-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "67ef366bcf5d54a7418a552f3a62fc1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 56974,
"upload_time": "2024-02-15T20:28:23",
"upload_time_iso_8601": "2024-02-15T20:28:23.774649Z",
"url": "https://files.pythonhosted.org/packages/b3/6c/dbb8baea7a486f41dfd7f35b7c0ead33b3656d03a99cf1396893f89b05c1/tgbox-cli-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 20:28:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NotStatilko",
"github_project": "tgbox-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tgbox-cli"
}
JSON
