The ultimate tool to automate telegram message forwarding.
Project description
tgcf
The ultimate tool to automate telegram message forwarding.
The key features are:
- Two modes of operation are past or live for dealing with either existing or upcoming messages.
- Supports signing in with both telegram bot account as well as user account.
- Custom Filtering of messages based on whitelist or blacklist.
- Modification of messages like Text Replacement, Watermarking, OCR etc.
- Detailed documentation📖 + Video tutorial + Fast help in discussion forum💬.
- If you are a python developer, writing plugins🔌 is like stealing candy from a baby.
What are you waiting for? Star 🌟 the repo and click Watch 🕵 to recieve updates.
You can also join the official Telegram Channel, to recieve updates without any ads.
Video Tutorial 📺
A youtube video is coming soon. Subscribe to get notified.
Run Locally 🔥
Note: Make sure you have Python 3.8 or above installed. Go to python.org to download python.
Platform | Supported |
---|---|
Windows | ✅ |
Mac | ✅ |
Linux | ✅ |
Android | ✅ |
If you are familiar with Docker, you may go that way for an easier life.
Open your terminal (command prompt) and run the following commands.
pip install pipx
pipx install tgcf
To check if the installation succeeded, run
tgcf --version
If you see an error, that means installation failed.
Configuration ⚙️
Configuring tgcf
is easy. You just need two files.
-
.env
: You heard it right! Just.env
. This file is for storing your secret credentials for signing into Telegram. This file is for defining the environment variables. You can do so by other methods also. -
tgcf.config.yml
: Anyaml
file to configure howtgcf
behaves.
Run on cloud 🌩️
Deploying to a cloud server is an easier alternative if you cannot install on your own machine. Cloud servers are very reliable and great for running tgcf
in live mode.
When you are deploying on a cloud platform, you can configure tgcf
using environment variables. The contents of tgcf.config.yml
can be put inside the environment variable called TGCF_CONFIG
.
How to ? |
---|
If you need to run tgcf
in past mode periodically, then you can use GitHub Actions to run a scheduled workflow.
Getting Help 💁🏻
- First of all read the wiki and [watch the videos.
- If you still have doubts, you can try searching your problem in discussion forum or the issue tracker.
- Feel free to ask your questions in the Discussion forum.
- For reporting bugs or requesting a feature please use the issue tracker for this repo.
Please do not send me direct messages in Telegram. (Exception: Sponsors can message me anytime)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tgcf-0.1.15.tar.gz
.
File metadata
- Download URL: tgcf-0.1.15.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.4 Linux/5.8.0-50-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f44d36ad21bc6a00735d4f0ec17d5704df8a2e9dc76bc43e4d0b2081e22f3c18 |
|
MD5 | 94457efa5769820ffd9d428ae7888102 |
|
BLAKE2b-256 | dfe4f1a1d51ce917fca3c1a26393b9c1a726840a5c6684df5f78c3fa9087f720 |
File details
Details for the file tgcf-0.1.15-py3-none-any.whl
.
File metadata
- Download URL: tgcf-0.1.15-py3-none-any.whl
- Upload date:
- Size: 10.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.4 Linux/5.8.0-50-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c723682c6c5d0d5d11849af49bdf7d217aaf559616167ae12809d0f04b06cd66 |
|
MD5 | f035fc43bf111bea26c68327bf6570ae |
|
BLAKE2b-256 | e96aa2d1a2a28ec3079d9ca046293b18af902d5deb9b2765646b76a588815954 |