{"id":19588422,"url":"https://github.com/notstatilko/tgbox-cli","last_synced_at":"2025-04-27T12:31:44.330Z","repository":{"id":110422644,"uuid":"455026242","full_name":"NotStatilko/tgbox-cli","owner":"NotStatilko","description":"CLI interface to the TGBOX","archived":false,"fork":false,"pushed_at":"2024-09-02T18:15:29.000Z","size":588,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-31T11:18:16.905Z","etag":null,"topics":["cli","cloud-storage","python","telegram"],"latest_commit_sha":null,"homepage":"https://github.com/NonProjects/tgbox/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotStatilko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-03T04:14:21.000Z","updated_at":"2024-09-02T18:15:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"33b2a089-fe4b-4120-ae70-d66a0f4d522d","html_url":"https://github.com/NotStatilko/tgbox-cli","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotStatilko%2Ftgbox-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotStatilko%2Ftgbox-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotStatilko%2Ftgbox-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotStatilko%2Ftgbox-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotStatilko","download_url":"https://codeload.github.com/NotStatilko/tgbox-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224069407,"owners_count":17250456,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cloud-storage","python","telegram"],"created_at":"2024-11-11T08:13:42.776Z","updated_at":"2024-11-11T08:13:43.472Z","avatar_url":"https://github.com/NotStatilko.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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/) — an encrypted cloud storage built around the [**Telegram**](https://telegram.org).\n\n![List of the TGBOX-CLI commands](https://github.com/NotStatilko/tgbox-cli/assets/43419673/b84b98e9-1ea1-432f-86d3-07a018d315bc)\n## Installation\n\nTo *build* 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 \u0026 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 \u0026\u0026 . 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 \u0026\u0026 . 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```\n**Please note** that You can also set `TGBOX_CLI_NON_ONEFILE` env variable to build without packing \\\ninto one executable file \u0026 feel 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotstatilko%2Ftgbox-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotstatilko%2Ftgbox-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotstatilko%2Ftgbox-cli/lists"}