{"id":15169633,"url":"https://github.com/simatwa/python-tgpt","last_synced_at":"2025-05-16T06:04:48.757Z","repository":{"id":214783999,"uuid":"737281810","full_name":"Simatwa/python-tgpt","owner":"Simatwa","description":"AI Chat in Terminal + Package + REST-API","archived":false,"fork":false,"pushed_at":"2025-05-03T07:42:31.000Z","size":6187,"stargazers_count":159,"open_issues_count":1,"forks_count":20,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-11T02:42:48.572Z","etag":null,"topics":["ai","blackboxai","chatgp","chatgpt","fastapi","gemini","gpt","koboldai","llama","llama2","novita","openai","perplexity","poe","python-tgpt","terminal-gpt","tgpt"],"latest_commit_sha":null,"homepage":"https://python-tgpt.onrender.com","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/Simatwa.png","metadata":{"files":{"readme":"docs/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,"zenodo":null}},"created_at":"2023-12-30T13:15:44.000Z","updated_at":"2025-05-03T07:42:34.000Z","dependencies_parsed_at":"2024-01-01T19:18:38.478Z","dependency_job_id":"d156870c-f28d-48c7-81b8-1ab4e811cb95","html_url":"https://github.com/Simatwa/python-tgpt","commit_stats":{"total_commits":396,"total_committers":6,"mean_commits":66.0,"dds":"0.015151515151515138","last_synced_commit":"cb558871ddef6a35d56eae9871c0d08f0511d23d"},"previous_names":["simatwa/tgpt2","simatwa/python-tgpt"],"tags_count":95,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simatwa%2Fpython-tgpt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simatwa%2Fpython-tgpt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simatwa%2Fpython-tgpt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simatwa%2Fpython-tgpt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Simatwa","download_url":"https://codeload.github.com/Simatwa/python-tgpt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478187,"owners_count":22077676,"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","blackboxai","chatgp","chatgpt","fastapi","gemini","gpt","koboldai","llama","llama2","novita","openai","perplexity","poe","python-tgpt","terminal-gpt","tgpt"],"created_at":"2024-09-27T07:04:13.383Z","updated_at":"2025-05-16T06:04:48.726Z","avatar_url":"https://github.com/Simatwa.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/Simatwa/python-tgpt/blob/main/assets/py-tgpt.png?raw=true\" width='40%'\u003e\n\u003c/p\u003e\n\n\u003c!-- \u003ch1 align=\"center\"\u003e python-tgpt \u003c/h1\u003e --\u003e\n\u003cp align=\"center\"\u003e\n\u003c!--\n\u003ca href=\"https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml\"\u003e\u003cimg src=\"https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml/badge.svg\" alt=\"Python Test\"/\u003e\u003c/a\u003e\n--\u003e\n\u003ca href=\"https://github.com/Simatwa/python-tgpt/blob/main/LICENSE\"\u003e\u003cimg alt=\"License\" src=\"https://img.shields.io/static/v1?logo=GPL\u0026color=Blue\u0026message=MIT\u0026label=License\"/\u003e\u003c/a\u003e\n\u003ca href=\"\"\u003e\u003cimg alt=\"Python version\" src=\"https://img.shields.io/pypi/pyversions/python-tgpt\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://pypi.org/project/python-tgpt\"\u003e\u003cimg alt=\"PyPi\" src=\"https://img.shields.io/pypi/v/python-tgpt?color=green\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/psf/black\"\u003e\u003cimg alt=\"Black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://python-tgpt.onrender.com\"\u003e\u003cimg alt=\"Website status\" src=\"https://img.shields.io/website?url=https://python-tgpt.onrender.com\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml\"\u003e\u003cimg alt=\"Python Package flow\" src=\"https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml/badge.svg?branch=master\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://pepy.tech/project/python-tgpt\"\u003e\u003cimg src=\"https://static.pepy.tech/personalized-badge/python-tgpt?period=total\u0026units=international_system\u0026left_color=grey\u0026right_color=blue\u0026left_text=Downloads\" alt=\"Downloads\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Simatwa/python-tgpt/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/downloads/Simatwa/python-tgpt/total?label=Asset%20Downloads\u0026color=success\" alt=\"Downloads\"\u003e\u003c/img\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Simatwa/python-tgpt/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/Simatwa/python-tgpt?color=success\u0026label=Release\u0026logo=github\" alt=\"Latest release\"\u003e\u003c/img\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Simatwa/python-tgpt/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/release-date/Simatwa/python-tgpt?label=Release date\u0026logo=github\" alt=\"release date\"\u003e\u003c/img\u003e\u003c/a\u003e\n\u003ca href=\"https://hits.seeyoufarm.com\"\u003e\u003cimg src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com/Simatwa/python-tgpt\"/\u003e\u003c/a\u003e      \n\u003ca href=\"https://wakatime.com/badge/github/Simatwa/tgpt2\"\u003e\u003cimg src=\"https://wakatime.com/badge/github/Simatwa/tgpt2.svg\" alt=\"wakatime\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003e\npython-tgpt\n\u003c/h3\u003e \n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/Simatwa/python-tgpt/blob/main/assets/demo-1.gif?raw=True\" width='80%'/\u003e\n\u003c/p\u003e\n\n\n```python\n\u003e\u003e\u003e import pytgpt.phind as phind\n\u003e\u003e\u003e bot = phind.PHIND()\n\u003e\u003e\u003e bot.chat('hello there')\n'Hello! How can I assist you today?'\n\n```\n\n```python\nfrom pytgpt.imager import Imager\nimg = Imager()\ngenerated_images = img.generate(prompt=\"Cyberpunk\", amount=3, stream=True)\nimg.save(generated_images)\n```\n\nThis project enables seamless interaction with over **45 free LLM providers** without requiring an API Key and generating images as well.\n\nThe name *python-tgpt* draws inspiration from its parent project [tgpt](https://github.com/aandrew-me/tgpt), which operates on [Golang](https://go.dev/). Through this Python adaptation, users can effortlessly engage with a number of free LLMs available, fostering a smoother AI interaction experience.\n\n### Features\n\n- 🐍 Python package\n- [🌐 FastAPI for web integration](https://python-tgpt.onrender.com)\n- ⌨️ Command-line interface\n- 🧠 Multiple LLM providers - **45+**\n- 🌊 Stream and non-stream response\n- 🚀 Ready to use (No API key required)\n- 🎯 Customizable script generation and execution\n- 🔌 Offline support for Large Language Models\n- 🎨 Image generation capabilities\n- 🎤 Text-to-audio conversion capabilities\n- ⛓️ Chained requests via proxy\n- 🗨️ Enhanced conversational chat experience\n- 💾 Capability to save prompts and responses (Conversation)\n- 🔄 Ability to load previous conversations\n- 🚀 Pass [awesome-chatgpt prompts](https://github.com/f/awesome-chatgpt-prompts) easily\n- 🤖 [Telegram bot](https://t.me/pytgpt_bot) - interface\n- 🔄 Asynchronous support for all major operations.\n\n\n## Providers\n\nThese are simply the hosts of the LLMs, they include:\n\n- [Phind](https://www.phind.com)\n- [Perplexity](https://www.perplexity.ai)\n- [Blackboxai](https://www.blackbox.ai)\n- [Koboldai](https://koboldai-koboldcpp-tiefighter.hf.space)\n- [Ai4chat](https://www.ai4chat.co/)\n- [gpt4all](https://gpt4all.io) *(Offline)*\n- [Poe](https://poe.com) - Poe|Quora *(Session ID required)*\n- [Groq](https://console.groq.com/playground) *(API Key required)*\n- [OpenAI](https://chat.openai.com) *(API key required)*\n- [DeepSeek](https://deepseek.com) *(API key required)*\n\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\n\n41+ providers proudly offered by [gpt4free](https://github.com/xtekky/gpt4free).\n\n\u003c/summary\u003e\n\n- To list working providers run:\n   ```sh\n   $ pytgpt gpt4free test -y\n   ```\n\u003c/details\u003e\n\n## Prerequisites\n\n- [x] [Python\u003e=3.10](https://python.org)\n\n## Installation and Usage\n\n### Installation\n\n1. Developers:\n\n   ```sh\n   pip install --upgrade python-tgpt\n   ```\n\n2. Commandline:\n\n   ```sh\n   pip install --upgrade \"python-tgpt[cli]\"\n   ```\n\n3. Full installation:\n\n   ```sh\n   pip install  --upgrade \"python-tgpt[all]\"\n   ```\n\n\u003e `pip install -U \"python-tgt[api]\"` will install REST API dependencies.\n\n#### Termux extras\n\n1. Developers:\n\n   ```sh\n   pip install --upgrade \"python-tgpt[termux]\"\n   ```\n\n2. Commandline:\n\n   ```sh\n   pip install --upgrade \"python-tgpt[termux-cli]\"\n   ```\n\n3. Full installation:\n\n   ```sh\n   pip install  --upgrade \"python-tgpt[termux-all]\"\n   ```\n\n\u003e `pip install -U \"python-tgt[termux-api]\"` will install REST API dependencies\n\n\n## Usage\n\nThis package offers a convenient command-line interface.\n\n\u003e [!NOTE]\n\u003e `phind` is the default *provider*.\n\n- For a quick response:\n  ```bash\n  python -m pytgpt generate \"\u003cYour prompt\u003e\"\n  ```\n\n- For interactive mode:\n  ```bash\n  python -m pytgpt interactive \"\u003cKickoff prompt (though not mandatory)\u003e\"\n  ```\n\nMake use of flag `--provider` followed by the provider name of your choice. e.g `--provider koboldai`\n\n\u003e To list all providers offered by gpt4free, use following commands: ```pytgpt gpt4free list providers```\n\nYou can also simply use `pytgpt` instead of `python -m pytgpt`.\n\nStarting from version 0.2.7, running `$ pytgpt` without any other command or option will automatically enter the `interactive` mode. Otherwise, you'll need to explicitly declare the desired action, for example, by running `$ pytgpt generate`.\n\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\n\u003ch3\u003eDeveloper Docs\u003c/h3\u003e\n\u003c/summary\u003e\n\n1. Generate a quick response\n\n```python\nfrom pytgpt.phind import PHIND\nbot = PHIND()\nresp = bot.chat('\u003cYour prompt\u003e')\nprint(resp)\n# Output : How can I assist you today?\n```\n\n2. Get back whole response\n\n```python\nfrom pytgpt.phind import PHIND\nbot = PHIND()\nresp = bot.chat('\u003cYour prompt\u003e')\nprint(resp)\n# Output\n\"\"\"\n{'id': 'chatcmpl-gp6cwu2e5ez3ltoyti4z', 'object': 'chat.completion.chunk', 'created': 1731257890, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': \"Hello! I'm an AI assistant created by Phind to help with programming tasks. How can I assist you today?\"}, 'finish_reason': None}]}\n\"\"\"\n```\n\n#### Stream Response \n\nJust add parameter `stream` with value  `true`.\n\n1. Text Generated only \n\n```python\nfrom pytgpt.phind import PHIND\nbot = PHIND()\nresponse = bot.chat('hello', stream=True)\nfor chunk in response:\n    print(chunk)\n# output\n\"\"\"\nHello\nHello!\nHello! How\nHello! How can\nHello! How can I\nHello! How can I assist\nHello! How can I assist you\nHello! How can I assist you today\nHello! How can I assist you today?\n\"\"\"\n```\n\n2. Whole Response\n\n```python\nfrom pytgpt.phind import PHIND\nbot = PHIND()\nresp = bot.ask('\u003cYour Prompt\u003e', stream=True)\nfor value in resp:\n    print(value)\n# Output\n\"\"\"\n{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': 'Hello'}, 'finish_reason': None}]}\n{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': \"Hello! I'm an AI\"}, 'finish_reason': None}]}\n{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': \"Hello! I'm an AI assistant created by Phind to help with coding and technical tasks. How\"}, 'finish_reason': None}]}\n{'id': 'chatcmpl-icz6a4m1nbbclw9hhgol', 'object': 'chat.completion.chunk', 'created': 1731258032, 'model': 'phind-instant-llama-3_1-08-31-2024-checkpoint-1500', 'choices': [{'index': 0, 'delta': {'content': \"Hello! I'm an AI assistant created by Phind to help with coding and technical tasks. How can I assist you today?\"}, 'finish_reason': None}]}\n\"\"\"\n```\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nAuto - *(selects any working provider)*\n\n\u003c/summary\u003e\n\n```python\nimport pytgpt.auto import auto\nbot = auto.AUTO()\nprint(bot.chat(\"\u003cYour-prompt\u003e\"))\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nOpenai\n\n\u003c/summary\u003e\n\n```python\nimport pytgpt.openai as openai\nbot = openai.OPENAI(\"\u003cOPENAI-API-KEY\u003e\")\nprint(bot.chat(\"\u003cYour-prompt\u003e\"))\n```\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nKoboldai\n\n\u003c/summary\u003e\n\n```python\nimport pytgpt.koboldai as koboldai\nbot = koboldai.KOBOLDAI()\nprint(bot.chat(\"\u003cYour-prompt\u003e\"))\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nPhind\n\n\u003c/summary\u003e\n\n```python\nimport pytgpt.phind as phind\nbot = phind.PHIND()\nprint(bot.chat(\"\u003cYour-prompt\u003e\"))\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nPerplexity\n\n\u003c/summary\u003e\n\n```python\nimport pytgpt.perplexity as perplexity\nbot = perplexity.PERPLEXITY()\nprint(bot.chat(\"\u003cYour-prompt\u003e\"))\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nBlackboxai\n\n\u003c/summary\u003e\n\n```python\nimport pytgpt.blackboxai as blackboxai\nbot = blackboxai.BLACKBOXAI()\nprint(bot.chat(\"\u003cYour-prompt\u003e\"))\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nGpt4free providers\n\n\u003c/summary\u003e\n\n```python\nimport pytgpt.gpt4free as gpt4free\nbot = gpt4free.GPT4FREE(provider=\"Koala\")\nprint(bot.chat(\"\u003cYour-prompt\u003e\"))\n```\n\n\u003c/details\u003e\n\n### Asynchronous\n\n**Version 0.7.0** introduces asynchronous implementation to almost all providers except a few such as *perplexity*, which relies on other libraries which lacks such implementation.\n\nTo make it easier, you just have to prefix `Async` to the common synchronous class name. For instance `PHIND` will be accessed as `AsyncPHIND`:\n\n#### Streaming Whole ai response.\n\n```python\nimport asyncio\nfrom pytgpt.phind import AsyncPHIND\n\nasync def main():\n    async_ask = await AsyncPHIND(False).ask(\n        \"Critique that python is cool.\",\n        stream=True\n    )\n    async for streaming_response in async_ask:\n        print(\n            streaming_response\n        )\n\nasyncio.run(\n    main()\n)\n```\n\n#### Streaming just the text\n\n```python\nimport asyncio\nfrom pytgpt.phind import AsyncPHIND\n\nasync def main():\n    async_ask = await AsyncPHIND(False).chat(\n        \"Critique that python is cool.\",\n        stream=True\n    )\n    async for streaming_text in async_ask:\n        print(\n            streaming_text\n        )\n\nasyncio.run(\n    main()\n)\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\n\nTo obtain more tailored responses, consider utilizing [optimizers](pytgpt/utils.py) using the `optimizer` parameter. Its values can be set to either `code` or `system_command`.\n\n\u003c/summary\u003e\n\n```python\nfrom pytgpt.phind import PHIND\nbot = PHIND()\nresp = bot.ask('\u003cYour Prompt\u003e', optimizer='code')\nprint(resp)\n```\n\n\u003c/details\u003e\n\n\u003c/details\u003e\n\n\u003e [!IMPORTANT]\n\u003e Commencing from [v0.1.0](https://github.com/Simatwa/python-tgpt/releases/), the default mode of interaction is conversational. This mode enhances the interactive experience, offering better control over the chat history. By associating previous prompts and responses, it tailors conversations for a more engaging experience.\n\nYou can still disable the mode:\n\n```python\nbot = koboldai.KOBOLDAI(is_conversation=False)\n```\n\nUtilize the `--disable-conversation` flag in the console to achieve the same functionality.\n\n\n### Image Generation\n\nThis has been made possible by [pollinations.ai](https://pollination.ai).\n```sh\n$ pytgpt imager \"\u003cprompt\u003e\"\n# e.g pytgpt imager \"Coding bot\"\n```\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nDevelopers\n\u003c/summary\u003e\n\n```python\nfrom pytgpt.imager import Imager\n\nimg = Imager()\n\ngenerated_img = img.generate('Coding bot') # [bytes]\n\nimg.save(generated_img)\n```\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\nDownload Multiple Images\n\u003c/summary\u003e\n\n```python\n\nfrom pytgpt.imager import Imager\n\nimg = Imager()\n\nimg_generator = img.generate('Coding bot', amount=3, stream=True)\n\nimg.save(img_generator)\n\n# RAM friendly\n```\n\n\u003c/details\u003e\n\n#### Using **Prodia** provider\n\n```python\nfrom pytgpt.imager import Prodia\n\nimg = Prodia()\n\nimg_generator = img.generate('Coding bot', amount=3, stream=True)\n\nimg.save(img_generator)\n```\n\n\u003c/details\u003e\n\n### Advanced Usage of Placeholders\n\nThe `generate` functionality has been enhanced starting from *v0.3.0* to enable comprehensive utilization of the `--with-copied` option and support for accepting piped inputs. This improvement introduces placeholders, offering dynamic values for more versatile interactions.\n\n| Placeholder | Represents |\n| ------------ | ----------- |\n| `{{stream}}` | The piped input |\n| `{{copied}}` | The last copied text |\n\nThis feature is particularly beneficial for intricate operations. For example:\n\n```bash\n$ git diff | pytgpt generate \"Here is a diff file: {{stream}} Make a concise commit message from it, aligning with my commit message history: {{copied}}\" --new\n```\n\u003e In this illustration, `{{stream}}` denotes the result of the `$ git diff` operation, while `{{copied}}` signifies the content copied from the output of the `$ git log` command.\n\n### Awesome Prompts\n\n[These prompts](https://github.com/Simatwa/gpt-cli/blob/main/assets/all-acts.pdf?raw=True) are designed to guide the AI's behavior or responses in a particular direction, encouraging it to exhibit certain characteristics or behaviors. The  term \"awesome-prompt\" is not a formal term in AI or machine learning literature, but it encapsulates the idea of crafting prompts that are effective in achieving desired outcomes. Let's say you want it to behave like a *Linux Terminal*, *PHP Interpreter*, or just to [**JAIL BREAK.**](https://gist.github.com/coolaj86/6f4f7b30129b0251f61fa7baaa881516)\n\nInstances :\n\n```sh\n$ pytgpt interactive --awesome-prompt \"Linux Terminal\"\n# Act like a Linux Terminal\n\n$ pytgpt interactive -ap DAN\n# Jailbreak\n```\n\n\u003e [!NOTE]\n\u003e Awesome prompts are alternative to `--intro`.\n\u003e Run `$ pytgpt awesome whole` to list available prompts (*200+*).\n\u003e Run `$ pytgpt awesome --help` for more info.\n\n### Introducing RawDog\n\nRawDog is a masterpiece feature that exploits the versatile capabilities of Python to command and control your system as per your needs. You can literally do anything with it, since it generates and executes python codes, driven by **your prompts**! To have a bite of *rawdog* simply append the flag `--rawdog` *shortform* `-rd` in *generate/interactive* mode. This introduces a never seen-before feature in the *tgpt ecosystem*. Thanks to [AbanteAI/rawdog](https://github.com/AbanteAI/rawdog) for the idea.\n\nThis can be useful in some ways. For instance :\n\n   ```sh\n   $ pytgpt generate -n -q \"Visualize the disk usage using pie chart\" --rawdog\n   ```\n   \n   This will pop up a window showing system disk usage as shown below.\n   \n   \u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://github.com/Simatwa/python-tgpt/blob/main/assets/Figure_1.png?raw=true\" width='60%'\u003e\n   \u003c/p\u003e\n\n## Passing Environment Variables\n\nPytgpt **v0.4.6** introduces a convention way of taking variables from the environment.\nTo achieve that, set the environment variables in your operating system or script with prefix `PYTGPT_` followed by the option name in uppercase, replacing dashes with underscores.\n\nFor example, for the option `--provider`, you would set an environment variable `PYTGPT_PROVIDER` to provide a default value for that option. Same case applies to boolean flags such as `--rawdog` whose environment variable will be `PYTGPT_RAWDOG` with value being either `true/false`. Finally, `--awesome-prompt` will take the environment variable `PYTGPT_AWESOME_PROMPT`.\n\n\u003e [!NOTE]\n\u003e This is **NOT** limited to any command\n\nThe environment variables can be overridden by explicitly declaring new value.\n\n\u003e [!TIP]\n\u003e Save the variables in a `.env` file in your current directory or export them in your `~/.zshrc` file.\n\u003e To load previous conversations from a `.txt` file, use the `-fp` or `--filepath` flag. If no flag is passed, the default one will be used. To load context from a file without altering its content, use the `--retain-file` flag.\n\n## Dynamic Provider \u0026 Further Interfaces\n\nVersion **0.4.6** also introduces dynamic provider called `g4fauto`, which represents the fastest working g4f-based provider.\n\n\u003e [!TIP]\n\u003e To launch web interface for g4f-based providers simply run `$ pytgpt gpt4free gui`.\n\u003e `$ pytgpt api run` will start the REST-API. Access docs and redoc at */docs* and */redoc* respectively.\nTo launch the web interface for g4f-based providers, execute the following command in your terminal:\n\n```bash\n$ pytgpt gpt4free gui\n```\n\nThis command initializes the Web-user interface for interacting with g4f-based providers.\n\nTo start the REST-API:\n\n```bash\n$ pytgpt api run\n```\n\nThis command starts the RESTful API server, enabling you to interact with the service programmatically.\n\nFor accessing the documentation and redoc, navigate to the following paths in your web browser:\n- Documentation: `/docs`\n- ReDoc: `/redoc`\n\n## Speech Synthesis\n\nTo enable speech synthesis of responses, ensure you have either the [VLC player](https://www.videolan.org/vlc/index.html) installed on your system or, if you are a [Termux](https://termux.org) user, the [Termux:API](https://wiki.termux.com/wiki/Termux:API) package.\n\nTo activate speech synthesis, use the `--talk-to-me` flag or its shorthand `-ttm` when running your commands. For example:\n```bash\n$ pytgpt generate \"Generate an ogre story\" --talk-to-me\n```\nor\n```bash\n$ pytgpt interactive -ttm\n```\nThis flag instructs the system to audiolize the ai responses and then play them, enhancing the user experience by providing auditory feedback.\n\nVersion **0.6.4** introduces another dynamic provider, `auto`, which denotes the working provider **overall**. This relieves you of the workload of manually checking a working provider each time you fire up pytgpt. However, `auto` as a provider does not work so well with streaming responses, so probably you would need to sacrifice performance for the sake of reliability.\n\n## [Telegram Bot](https://github.com/Simatwa/pytgpt-bot)\n\nIf you're not satisfied with the existing interfaces, [pytgpt-bot](https://github.com/Simatwa/pytgpt-bot) could be the solution you're seeking. This bot is designed to enhance your experience by offering a wide range of functionalities. Whether you're interested in engaging in AI-driven conversations, creating images and audio from text, or exploring other innovative features, [pytgpt-bot is equipped to meet your needs.](https://github.com/Simatwa/pytgpt-bot)\n\nThe bot is maintained as a separate project so you just have to execute a command to get it installed :\n\n```\n$ pip install pytgpt-bot\n```\n\nUsage : `pytgpt bot run \u003cbot-api-token\u003e`\n\nOr you can simply interact with the one running now as [@pytgpt-bot](https://t.me/pytgpt_bot)\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\n\nFor more usage info run `$ pytgpt --help`\n\n\u003c/summary\u003e\n\n```\nUsage: pytgpt [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -v, --version  Show the version and exit.\n  -h, --help     Show this message and exit.\n\nCommands:\n  api          FastAPI control endpoint\n  awesome      Perform CRUD operations on awesome-prompts\n  bot          Telegram bot interface control\n  generate     Generate a quick response with AI\n  gpt4free     Discover gpt4free models, providers etc\n  imager       Generate images with pollinations.ai\n  interactive  Chat with AI interactively (Default)\n  utils        Utility endpoint for pytgpt\n```\n\n\u003c/details\u003e\n\n### API Health Status\n\n| No. | API | Status |\n|--------|-----|--------|\n| 1. | [On-render](https://python-tgpt.onrender.com)  | [cron-job](https://pqfzhmvz.status.cron-job.org/) |\n\n\n## [CHANGELOG](https://github.com/Simatwa/python-tgpt/blob/main/docs/CHANGELOG.md)\n\n## Acknowledgements\n\n1. [x] [tgpt](https://github.com/aandrew-me/tgpt)\n2. [x] [gpt4free](https://github.com/xtekky/gpt4free)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimatwa%2Fpython-tgpt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimatwa%2Fpython-tgpt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimatwa%2Fpython-tgpt/lists"}