Skip to content
Telegram Terminal Application
Python
Branch: development
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode added "tgcli bot send message" and "tgcli bot send document" tests Sep 19, 2019
docs
resources
tests added tests for "bot send location" Sep 19, 2019
tgcli
.coveragerc
.gitignore relativized dependencies Apr 21, 2019
.travis.yml removed tgcli from travis Sep 19, 2019
CHANGELOG.md updated metadata Sep 22, 2019
LICENSE.txt added docs Jan 16, 2019
MANIFEST.in removed tgcli from travis Jan 18, 2019
README.md added explanation to install section about auto update Oct 20, 2019
conftest.py added pytest configurations Apr 19, 2019
dev.requirements.txt added "tgcli bot send message" and "tgcli bot send document" tests Sep 19, 2019
mkdocs.yml added travisci sub to travisci section on docs Sep 19, 2019
pytest.ini added pytest configurations Apr 19, 2019
requirements.txt removed appdirs Apr 24, 2019
setup.py migrated "bot" subcommand to "tgcli.cli.bot" package Sep 18, 2019

README.md

tgcli

PyPI PyPI PyPI PyPI Telegram Code Style

tgcli is a Python cli app for Telegram.

Build Coverage
Master Travis (.com) master
Development Travis (.com) development

Installing

pip (No auto-update)

Install via pip:

pip install tgcli

tgcli (Auto-update, Arch-based)

Also available as a package in AUR.

# assuming you use yay
yay -S tgcli

Rationale

A similar project, built on Python, was created by @vysheng, but it has not been updated since 2016 and considered abandoned. This tool is not a fork of the mentioned project, it is built from ground up.

Example

For now, the use case is pretty simple. To send a message:

tgcli bot --token "BotToken" send --receiver "UserID" message "Your message"

You don't need to expose your token as flag. If you set TELEGRAM_BOT_TOKEN environment variable, you do not need to set --token flag. Just set it before using tgcli:

export TELEGRAM_BOT_TOKEN="BotToken"

You can get more information by doing:

tgcli bot send --help

Also, this repository uses notification from a private bot, you can see the example Travis configuration here. Private TELEGRAM_BOT_TOKEN and TELEGRAM_RECEIVER environment variables were set.

This application serves a really small purpose for now. It might face breaking changes in the future.

Documentation

Documentation has an intensive amount of information about how to use tgcli. Refer to the documentation.

coogger logo

Documentation is provided by Coogger. Coogger is an open-source service that provides technical documentations. While it has its own domain, you can also use it as a self-hosted solution.

Donations

tgcli is a free (as in beer and speech) software that I have built in my leisure time and been maintaining it. If you like to use it, please consider a small donation.

How do I donate?

I accept donations in:

  • MiliBitcoin (mBTC)
  • Monero (XMR)

You can donate predefined (almost $1) or custom donation by clicking or scanning below.

Predefined (Almost $1) How Much You Wish
MiliBitcoin (mBTC) mBTC predefined mBTC custom
Monero (XMR) XMR predefined XMR custom
You can’t perform that action at this time.