{"id":13455903,"url":"https://github.com/F33RNI/GPT-Telegramus","last_synced_at":"2025-03-24T09:30:56.103Z","repository":{"id":65682738,"uuid":"596407360","full_name":"F33RNI/GPT-Telegramus","owner":"F33RNI","description":"💜 The best free Telegram bot for ChatGPT, Microsoft Copilot (aka Bing AI / Sidney / EdgeGPT), Microsoft Copilot Designer (aka BingImageCreator), Gemini and Groq with stream writing, requests with images, multiple languages, admin control, data logging and more!","archived":false,"fork":false,"pushed_at":"2024-05-16T04:53:12.000Z","size":10017,"stargazers_count":343,"open_issues_count":12,"forks_count":104,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-03-21T04:14:20.050Z","etag":null,"topics":["ai","bing","bing-image-creator","bot","chatgpt","dalle","edge-ai","edgegpt","gemini","google","gpt","groq","linux","microsoft","microsoft-copilot-ai","openai","proxy","python","telegram"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/F33RNI.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":"2023-02-02T05:31:12.000Z","updated_at":"2025-03-10T08:13:00.000Z","dependencies_parsed_at":"2023-12-25T06:21:37.040Z","dependency_job_id":"beed7735-f879-4496-b86b-56086b901b76","html_url":"https://github.com/F33RNI/GPT-Telegramus","commit_stats":null,"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F33RNI%2FGPT-Telegramus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F33RNI%2FGPT-Telegramus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F33RNI%2FGPT-Telegramus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F33RNI%2FGPT-Telegramus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/F33RNI","download_url":"https://codeload.github.com/F33RNI/GPT-Telegramus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245243165,"owners_count":20583576,"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":["ai","bing","bing-image-creator","bot","chatgpt","dalle","edge-ai","edgegpt","gemini","google","gpt","groq","linux","microsoft","microsoft-copilot-ai","openai","proxy","python","telegram"],"created_at":"2024-07-31T08:01:13.256Z","updated_at":"2025-03-24T09:30:56.069Z","avatar_url":"https://github.com/F33RNI.png","language":"Python","funding_links":[],"categories":["GitHub projects","Python"],"sub_categories":[],"readme":"# 🤖 GPT-Telegramus v5\n\n| ![GPT-Telegramus logo](logo.png) | \u003ch3\u003eThe best free Telegram bot for ChatGPT, Microsoft Copilot (aka Bing AI / Sidney / EdgeGPT), Microsoft Copilot Designer (aka BingImageCreator), Gemini and Groq with stream writing, requests with images, multiple languages, admin control, data logging and more!\u003c/h3\u003e |\n| -------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n\n\u003cdiv style=\"width:100%;text-align:center;\"\u003e\n    \u003cp align=\"center\"\u003e\n        \u003cimg src=\"https://badges.frapsoft.com/os/v1/open-source.png?v=103\" \u003e\n    \u003c/p\u003e\n\u003c/div\u003e\n\u003cdiv style=\"width:100%;text-align:center;\"\u003e\n    \u003cp align=\"center\"\u003e\n        \u003ca href=\"https://www.youtube.com/@F3RNI\"\u003e\u003cimg alt=\"YouTube\" src=\"https://img.shields.io/badge/-YouTube-red\" \u003e\u003c/a\u003e\n        \u003ca href=\"https://f3rni.bandcamp.com\"\u003e\u003cimg alt=\"Bandcamp\" src=\"https://img.shields.io/badge/-Bandcamp-cyan\" \u003e\u003c/a\u003e\n        \u003ca href=\"https://open.spotify.com/artist/22PQ62alehywlYiksbtzsm\"\u003e\u003cimg alt=\"Spotify\" src=\"https://img.shields.io/badge/-Spotify-green\" \u003e\u003c/a\u003e\n        \u003ca href=\"https://soundcloud.com/f3rni\"\u003e\u003cimg alt=\"SoundCloud\" src=\"https://img.shields.io/badge/-SoundCloud-orange\" \u003e\u003c/a\u003e\n    \u003c/p\u003e\n\u003c/div\u003e\n\u003cdiv style=\"width:100%;text-align:center;\"\u003e\n    \u003cp align=\"center\"\u003e\n        \u003ca href=\"https://aur.archlinux.org/packages/gpt-telegramus\"\u003e\u003cimg alt=\"\" src=\"https://img.shields.io/aur/last-modified/gpt-telegramus?logo=ArchLinux\" \u003e\u003c/a\u003e\n        \u003ca href=\"https://aur.archlinux.org/packages/gpt-telegramus\"\u003e\u003cimg alt=\"\" src=\"https://img.shields.io/aur/version/gpt-telegramus?logo=ArchLinux\" \u003e\u003c/a\u003e\n    \u003c/p\u003e\n\u003c/div\u003e\n\u003cdiv style=\"width:100%;text-align:center;\"\u003e\n    \u003cp align=\"center\"\u003e\n        \u003ca href=\"https://aur.archlinux.org/packages/gpt-telegramus-git\"\u003e\u003cimg alt=\"\" src=\"https://img.shields.io/aur/last-modified/gpt-telegramus-git?logo=ArchLinux\" \u003e\u003c/a\u003e\n        \u003ca href=\"https://aur.archlinux.org/packages/gpt-telegramus-git\"\u003e\u003cimg alt=\"\" src=\"https://img.shields.io/aur/version/gpt-telegramus-git?logo=ArchLinux\" \u003e\u003c/a\u003e\n    \u003c/p\u003e\n\u003c/div\u003e\n\n![Project banner](banner.png)\n\n----------\n\n## 🚧 GPT-Telegramus is under development\n\n\u003e 😔 Currently, GPT-Telegramus doesn't have paid ChatGPT and DALL-E support\n\u003e\n\u003e 📈 GPT-Telegramus v5 is an updated and highly refactored version of the old GPT-Telegramus\n\u003e\n\u003e 📄 Documentation is also under development! Consider reading docstring for now\n\u003e\n\u003e 🐛 If you find a **bug** in GPT-Telegramus, please create an Issue\n\u003e\n\u003e p.s. Due to my studies, I don't have much time to work on the project 😔\n\n----------\n\n## 😋 Support project\n\n\u003e 💜 Please support the project so that I can continue to develop it\n\n- BTC: `bc1qd2j53p9nplxcx4uyrv322t3mg0t93pz6m5lnft`\n- ETH: `0x284E6121362ea1C69528eDEdc309fC8b90fA5578`\n- ZEC: `t1Jb5tH61zcSTy2QyfsxftUEWHikdSYpPoz`\n\n- Or by my music on [🟦 bandcamp](https://f3rni.bandcamp.com/)\n\n- Or message me if you would like to donate in other way 💰\n\n[![Star History Chart](https://api.star-history.com/svg?repos=F33RNI/GPT-Telegramus\u0026type=Date)](https://star-history.com/#F33RNI/GPT-Telegramus\u0026Date)\n\n----------\n\n## 🤗 Contributors\n\n- 💜 [Sprav04ka](https://github.com/Sprav04ka) - *Tofii'skovyi' language, Testing, Super beautiful poster, Project Logo, Motivation*\n- 💜 [Hanssen](https://github.com/Hanssen0) - *Markdown parsing, bard images, /chat command, caption fix, loading emoji, dynamic splitting, code block splitting, Gemini module, Docker fix, GitHub actions fix* **and much much more**\n- 💜 [Sergey Krashevich](https://github.com/skrashevich) - *Docker, GitHub Actions*\n- 💜 [Wahit Fitriyanto](https://github.com/wahitftry) - *Indonesian language*\n- 💜 [Alexander Fadeyev](https://github.com/alfsoft) - *EdgeGPT Fix*\n- 💜 AnthroAsja - *Belarusian language*\n- 💜 Anonymous Samurai - *Ukrainian language*\n- 💜 Dunya Jafari - *Persian language*\n- 💜 [Dedy Rudney](https://github.com/rudney5000) - *French language*\n\n----------\n\n## 📨 Project channel and demo\n\n- You can join official project's Telegram channel \u003chttps://t.me/vestnik_labasera\u003e\n- Also you can test GPT-Telegramus using official bot \u003chttps://t.me/labasyor3000_bot\u003e\n\n⚠️ Please do not overload the bot and use it only as a demo version\n\n----------\n\n## 🏗️ Requirements\n\n- Python **3.10** / **3.11** *(not tested on other versions)*\n- Unblocked access to the telegram bot official API\n- Other requirements specified in the `requirements.txt` file\n\n----------\n\n## 📙 Project based on\n\n- **F33RNI/LMAO API** (Unofficial open APIs): \u003chttps://github.com/F33RNI/LlM-Api-Open\u003e\n- **Groq API** (Official Python API): \u003chttps://github.com/groq/groq-python\u003e\n- **acheong08/EdgeGPT** (API): \u003chttps://github.com/acheong08/EdgeGPT\u003e\n- **jacobgelling/EdgeGPT** (API): \u003chttps://github.com/jacobgelling/EdgeGPT\u003e\n- **acheong08/BingImageCreator** (API): \u003chttps://github.com/acheong08/BingImageCreator\u003e\n- **google/generative-ai-python** (API): \u003chttps://github.com/google/generative-ai-python\u003e\n- **python-telegram-bot** (Telegram bot API): \u003chttps://github.com/python-telegram-bot/python-telegram-bot\u003e\n\n----------\n\n## ❓ Get started\n\nSee **🐧 Running as service on linux**, **🍓 Running on Raspberry Pi (ARM)**, **🐋 Running in Docker** sections for more info\n\n1. Install Python **3.10** / **3.11** *(not tested on other versions)*, `venv` and `pip`\n2. Download source code (clone repo)\n3. Create venv `python -m venv venv` / `python3 -m venv venv` / `python3.10 -m venv venv` / `python3.11 -m venv venv`\n4. Activate venv `source venv/bin/activate` / `venv\\Scripts\\activate.bat`\n5. Check python version using `python --version` command\n6. Install requirements `pip install -r requirements.txt --upgrade`\n7. Carefully change all the settings in `config.json` file and in each `*.json` file inside `module_configs` directory. If you have questions regarding any setting, open an issue, I'll try to add a more detailed description\n8. Run main script `python main.py`\n\n- 💬 **ChatGPT**\n  - Free browser-like Chat-GPT. Currently, without extensions and image requests (text only) (because I don't have a paid account to test it)\n  - Stream response support\n  - Chat history support\n  - See \u003chttps://github.com/F33RNI/LlM-Api-Open\u003e for more info\n- 🟦 **Microsoft Copilot (aka EdgeGPT aka Bing AI aka Sydney)**\n  - Supports conversation style `/style`\n  - Stream response support\n  - Chat history support\n  - Web-browsing (probably) and sources (attributions) support\n  - Accepts image requests (for **lmao_ms_copilot** only)\n  - Send generated images (for **lmao_ms_copilot** only)\n  - Suggestions (for **lmao_ms_copilot** only)\n  - See \u003chttps://github.com/F33RNI/LlM-Api-Open\u003e for more info\n  - **NOTE:** Non-LMAO API (the old one `ms_copilot`) is deprecated! Please use `lmao_ms_copilot` instead\n- 🎨 *Microsoft Copilot Designer* (**DEPRECATED**)\n  - Bing Image Generator. Used as a separate module due to issues with the EdgeGPT module\n  - Free and unlimited\n- ♊ **Gemini**\n  - Google's AI using the Gemini Pro model\n  - Chat history support\n  - Requests with images (you can send an image with text to it)\n  - Requests with images will not be recorded in the chat history since Google hasn't support this\n- 🔴 **Groq**\n  - Official Python API\n  - Chat history support\n  - **Very fast** response\n  - Multiple models (*see `/model` command*)\n\n----------\n\n## 🐧 Running as service on linux\n\n1. Install Python **3.10** / **3.11** *(not tested on other versions)*, `venv` and `pip`\n2. Clone repo\n   1. `git clone https://github.com/F33RNI/GPT-Telegramus.git`\n   2. `cd GPT-Telegramus`\n3. Create venv `python -m venv venv` / `python3 -m venv venv` / `python3.10 -m venv venv` / `python3.11 -m venv venv`\n4. Carefully change all the settings in `config.json` file and in each `*.json` file inside `module_configs` directory\n5. Install systemd\n   1. `sudo apt-get install -y systemd`\n6. Create new service file\n   1. `sudo nano /etc/systemd/system/gpt-telegramus.service`\n\n      ```ini\n      [Unit]\n      Description=GPT-Telegramus service\n      After=multi-user.target\n      \n      [Service]\n      Type=simple\n      Restart=on-failure\n      RestartSec=5\n      \n      WorkingDirectory=YOUR DIRECTORY HERE/GPT-Telegramus\n      ExecStart=YOUR DIRECTORY HERE/GPT-Telegramus/run.sh\n      \n      [Install]\n      WantedBy=multi-user.target\n      \n      ```\n\n7. Reload systemctl daemon\n   1. `sudo systemctl daemon-reload`\n8. Enable and start service\n   1. `sudo systemctl enable gpt-telegramus`\n   2. `sudo systemctl start gpt-telegramus`\n9. Note: Please use `sudo systemctl kill gpt-telegramus` and then `sudo systemctl stop gpt-telegramus` if only `sudo systemctl stop gpt-telegramus` not working\n\n----------\n\n## 🍓 Running on Raspberry Pi (ARM)\n\n1. Install Python 3.11 or later *(not tested)* if not installed\n\n   1. ```shell\n      sudo apt-get update\n      sudo apt-get install -y build-essential tk-dev libncurses5-dev libncursesw5-dev libreadline6-dev libdb5.3-dev libgdbm-dev libsqlite3-dev libssl-dev libbz2-dev libexpat1-dev liblzma-dev zlib1g-dev libffi-dev\n      wget https://www.python.org/ftp/python/3.11.8/Python-3.11.8.tgz\n      sudo tar zxf Python-3.11.8.tgz\n      cd Python-3.11.8\n      sudo ./configure --enable-optimizations\n      sudo make -j 4\n      sudo make altinstall\n      ```\n\n   2. Check version by typing `python3.11 -V`. After this, you should use `python3.11` command instead of `python` or you can add it to the `bashrc` by typing `echo \"alias python=/usr/local/bin/python3.11\" \u003e\u003e ~/.bashrc`\n\n2. Follow the `🐧 Running as service on linux` guide\n\n----------\n\n## 🐋 Running in Docker\n\n### From GitHub Package\n\n1. Clone repo or download [`config.json`](./config.json) and [`module_configs`](./module_configs) and [`langs`](./langs)\n2. Edit the `config.json`, set options in the `files` section to the path in the container (`/app/config/\u003cFILE_NAME\u003e`)\n3. Run the container\n\n   ```shell\n   docker run -d -e TELEGRAMUS_CONFIG_FILE=\"/app/config/config.json\" -v \u003cYOUR_CONFIG_FOLDER\u003e:/app/config --name gpt-telegramus --restart on-failure ghcr.io/f33rni/gpt-telegramus:latest\n   ```\n\n   If you want to try the preview version\n\n   ```shell\n   docker run -d -e TELEGRAMUS_CONFIG_FILE=\"/app/config/config.json\" -v \u003cYOUR_CONFIG_FOLDER\u003e:/app/config --name gpt-telegramus --restart on-failure ghcr.io/f33rni/gpt-telegramus:edge\n   ```\n\n### Build Manually\n\n1. Install Docker\n2. Clone repo\n3. Build container\n\n    ```shell\n    docker buildx build -t telegramus --load -f Dockerfile .\n    ```\n\n4. Run the container\n\n    ```shell\n    docker run -d --name gpt-telegramus --restart on-failure telegramus\n    ```\n\n   or if you want to use a custom config\n\n   ```shell\n   docker run -d -e TELEGRAMUS_CONFIG_FILE=\"/app/config/config.json\" -v \u003cYOUR_CONFIG_FOLDER\u003e:/app/config --name gpt-telegramus --restart on-failure telegramus\n   ```\n\n----------\n\n## 🌐 Bot messages\n\n### Currently available languages\n\n- 🇺🇸 English\n- 🇷🇺 Русский\n- ‍☠️ Тофийсковый\n- 🇮🇩 Bahasa Indonesia\n- 🇨🇳 简体中文\n- 🇧🇾 Беларуская\n- 🇺🇦 Українська\n- فارسی 🇮🇷\n- 🇪🇸 Español\n- 🇻🇳 Vietnamese\n- 🇫🇷 Français\n\nYou can add **a new language**. For that:\n\n1. Copy any existing language file (inside `langs` directory)\n2. Rename it according to `Set2/T` (3-letters code) **ISO 639** \u003chttps://en.wikipedia.org/wiki/List_of_ISO_639_language_codes\u003e\n3. Translate each entry\n4. Create a pull request 💜\n\n\u003e You can add new lines by adding `\\n`\n\u003e\n\u003e ⚠️ Please make sure you haven't messed up the string formatting structure `{this_type}`\n\n----------\n\n## 🤖 Telegram bot commands\n\n- 📄 `/start` - Welcome message and bot version\n- ❓ `/help` - Show help message\n- ↕️ `/module` - Change module to chat with\n- 🧹 `/clear` - Clear chat history\n- 🌎 `/lang` - Change the language\n- 🆔 `/chatid` - Show your chat_id\n- ⚙️ `/model` - Change model of module (Currently for 🔴 Groq module only)\n- `/style` - Bing AI conversation style\n- `/chat` - Send request in group chat\n- Other direct module commands (please check automatically-generated list of commands inside bot)\n\n### Admin commands\n\n- 💬 `/queue` - Show requests queue\n- 🔃 `/restart [module name, optional]` - Restart specific module (**and it's config**) or every module and all configs, languages and bot commands\n  - Please see `bot_command_restart` function in `bot_handler.py` file for more info\n- 👤 `/users` - Show list of all users\n- 🔨 `/ban \u003cid\u003e [reason]` - Ban a user by their id with reason (optional)\n- 🔓 `/unban \u003cid\u003e` - Unban a user by their id\n- 📢 `/broadcast \u003cmessage\u003e` - Send text message to everyone except banned users\n\n----------\n\n## 📜 Data collecting\n\nGPT-Telegramus has a built-in data collecting function (saves requests and responses in a files)\n\n- **For text requests / responses** will be saved as plain text\n- **For image requests / responses** will be saved as Base64-encoded image (in the same text file)\n\nYou can enable and configure data collection in `config.json` in `data_collecting` section\n\n\u003e ⚠️ Please make sure you notify your bot users that you're collecting data\n\n----------\n\n## 📝 TODO\n\n- Paid version of ChatGPT\n- DALL-E (from OpenAI)\n- Some other LLMs (and maybe some free GPT-4 model)\n\n----------\n\n## ✨ Contribution\n\n- Anyone can contribute! Just create a **pull request**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FF33RNI%2FGPT-Telegramus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FF33RNI%2FGPT-Telegramus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FF33RNI%2FGPT-Telegramus/lists"}