natasha026 / tgcf

The ultimate tool to automate telegram message forwarding.

tgcf

The ultimate tool to automate telegram message forwarding.

The key features are:

1. Two modes of operation are past or live for dealing with either existing or upcoming messages.
2. Supports signing in with both telegram bot account as well as user account.
3. Custom Filtering of messages based on whitelist or blacklist.
4. Modification of messages like Text Replacement, Watermarking, OCR etc.
5. Detailed documentation📖 + Video tutorial + Fast help in discussion forum💬.
6. 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 --upgrade 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 in your present directory (from which tgcf is invoked).

• .env : To define your environment variables easily.

• tgcf.config.yml : An yaml file to configure how tgcf behaves.

Start tgcf ✨

In your terminal, just run tgcf live or tgcf past to start tgcf.

For more details run tgcf --help or read docs.

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.

You may click on the platform name (left coloumn) to learn more about the deployment process. Clicking on the "deploy" button (right coloumn) will directly deploy the application to that platform.

Platform	One click deploy
Heroku
Digital Ocean
Google Cloud
Gitpod

If you need to run tgcf in past mode periodically, then you may set a cron job in your computer or 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 on Telegram. (Exception: Sponsors can message me anytime)