{"id":26290972,"url":"https://github.com/protik09/terminal-ai","last_synced_at":"2025-03-15T00:33:07.382Z","repository":{"id":240168057,"uuid":"801855620","full_name":"protik09/terminal-ai","owner":"protik09","description":"Super Fast 0-Shot AI assistant in the terminal","archived":false,"fork":false,"pushed_at":"2024-05-17T06:24:13.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-18T04:36:43.400Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/protik09.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":"2024-05-17T03:40:12.000Z","updated_at":"2024-06-01T04:22:48.336Z","dependencies_parsed_at":"2024-06-01T04:22:46.223Z","dependency_job_id":"3c643f6f-f725-4d8c-bee2-720a4c26df76","html_url":"https://github.com/protik09/terminal-ai","commit_stats":null,"previous_names":["protik09/terminal-ai"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protik09%2Fterminal-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protik09%2Fterminal-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protik09%2Fterminal-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protik09%2Fterminal-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/protik09","download_url":"https://codeload.github.com/protik09/terminal-ai/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243668050,"owners_count":20328035,"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":[],"created_at":"2025-03-15T00:33:06.649Z","updated_at":"2025-03-15T00:33:07.370Z","avatar_url":"https://github.com/protik09.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Terminal-AI\r\n\r\n![Python Language](https://img.shields.io/badge/Python-14354C?style=for-the-badge\u0026logo=python\u0026logoColor=white)\r\n\r\n![PyPI - Version](https://img.shields.io/pypi/v/protai) ![GitHub](https://img.shields.io/github/license/protik09/terminal-ai) ![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg) ![Issues Open](https://img.shields.io/github/issues/protik09/terminal-ai.svg)\r\n\u003c!-- ![MintenanceNo](https://img.shields.io/badge/Maintained%3F-no-red.svg) --\u003e\r\n\r\n![Powershell](https://img.shields.io/badge/powershell-5391FE?style=for-the-badge\u0026logo=powershell\u0026logoColor=white) ![Bash](https://img.shields.io/badge/GNU%20Bash-4EAA25?style=for-the-badge\u0026logo=GNU%20Bash\u0026logoColor=white) ![WinTerm](https://img.shields.io/badge/windows%20terminal-4D4D4D?style=for-the-badge\u0026logo=windows%20terminal\u0026logoColor=white)\r\n\r\n\u003c!-- ![ProtAI Logo](assets/protai_logo.jpg) --\u003e\r\n\r\nA zero-shot AI assistant in the terminal, backended by the *GROQ AI*, for blazing fast responses. The **free** API key from *GROQ* can be obtained [here](https://console.groq.com/keys)\r\n\r\n## Installation\r\n\r\nTo install protai, simply run the following command in your terminal:\r\n\r\n```bash\r\npip install --upgrade protai\r\n```\r\n\r\n## Usage\r\n\r\nTo use this application, simply run the following command in your terminal:\r\n\r\n```bash\r\nprotai \u003cquery\u003e\r\n```\r\n\r\n*For example:*\r\n\r\n![ProtAI Demo](https://github.com/protik09/terminal-ai/blob/master/assets/protai_demo.jpeg?raw=true \"ProtAI Demo\")\r\n\r\n\r\n\r\n\u003e[!Note]\r\n\u003e On first run you will be prompted to enter your **free** *Groq AI* API key. You can get one at the [**Groq AI website**](https://console.groq.com/keys).\r\n\r\n\u003e[!IMPORTANT]\r\n\u003e You need to have a _**valid Groq AI API key**_ to use this application.\r\n\r\n## Development\r\n\r\nThe application is using the _**llama-3.1-8b-instant**_ model for its instant inference, as that has the fastest response time.\r\nThe interactive version is using the  **llama-3.3-70b-versatile** for its 0-shot inference.\r\n\r\nIf you wish to develop for this application, you can clone the repository and install the dependencies using the scripts given:\r\n\r\n```bash\r\ngit clone https://github.com/protik09/terminal-ai.git\r\ncd terminal-ai\r\n./activate_venv.sh\r\n```\r\n\r\nor\r\n\r\n```powershell\r\ngit clone https://github.com/protik09/terminal-ai.git\r\ncd terminal-ai\r\n.\\activate_venv.ps1\r\n```\r\n\r\nTo generate the wheel and upload to PyPI, we use the following command:\r\n\r\n```bash\r\npython setup.py upload\r\n```\r\n\r\n\u003e [!IMPORTANT]\r\n\u003e Only the current maintainer has access to the [**PyPI**](https://pypi.org/project/protai/) repository API key. If you wish to contribute, please fork the repository and submit a pull request.\r\n\r\n### Prerequisites\r\n\r\n\u003e[!NOTE]\r\n\u003e* Python 3.10 or later 🐍\r\n\u003e* Groq AI API key (available at [Groq AI website](https://console.groq.com/keys))\r\n\r\n### Program Flow Chart\r\n\r\n![Program Flow Chart](https://mermaid.ink/svg/pako:eNqdVl1T6jAQ_SuZ3PENGBG4ah_uTPkQEUGlih_FcTIlhY5tWpNU5VL--92mpVLHO6PhKbs5Z3dzdunsGjvhnGIDLziJlui6O2MIfqZtScLlI6pW_6D2urOkzjMifBEHlEmxyUDt9DYZhx8XCerYl9xjEsWCLCgibI7ouycfdwnV6pL6UYK634G-Ui68kCWoZ3eI76PcPgW4T_knsLMkbEETdGJ31AmZlwP0TFdfB78RlCOPRbFMUB9qCR0qBFSz9QI4g_eVCqe2GcslvNJziKTozZNL1J9cXKVJ8rinKm4mVo-9oinhCRqsU9QToJ6GvXsIjSh7zRUcKMI9BeHObKgnvdoW_bgLGYcJGtp9KosnuTwM0gNIuMihQ1Xn-XqYedMXi6JZ5x-pRipVzv2U7rxIN04lCSKZKeKG_BNyrLJd2FPie_NUEYUrYy5UNIVI0CXMVMg_mgJKlOvP0AP2muGv8vmgnEPyTy3cFfyEeH7Moe_W14wS2IqdtM8JmtgdTtO6-zx8QY7vQWuz4Nu-T9QLr20LZBcrIWmAIiVJXsO1ur-xu56IfLJCIvIYAw3yUYKH1Wq1HHujsNO1RaEqTl9iKiSSYTFBeZem5RpvVcs5jfytorcqzl0qZVQkFBnejf0Cd6dw97kgKkIq-Ijw53n4xorZnpYVfCgHVkPuZpd54AcV2DT_15wM1clQbbv30bJu7susXsk6KVlWyboqWaZZmJljbw9ZcuWno8zgUyYyrwAXjBpyPd83frmuA7-KkDx8psavRqORn6tv3lwujYPofZfW3qEdH3-b1iloKfHbtK4erZfTHOdHtBM9Wl9PklM92kCPdrbzNtf9Nm2oRzvXK3Kkl22s17cLPdqlHu1K7_820ZPE0st2rZftRo821aPd6tHu9Pp2r0d70GuAqflZNts_4eEKDigPiDeH7Xadxplh2N8COsMGHOfUJbEvZ3jGNgAlsQytFXOwIXlMK5iH8WKJDZf4Aqw4SjecrkdgSw4KL517sNCMsv1ZrdEVHBH2EIbBNgyY2Fjjd2w067XfjUaz3jo6aDaOj_YPK3gF3lqrtX9weFBvNo9b9dbhYWtTwX9VgPrmH82NxJY?raw=true \"Program Flow Chart\")\r\n\r\n### Contributing\r\n\r\nContributions are welcome! If you'd like to contribute to this application, please fork the repository and submit a pull request.\r\n\u003e[!WARNING]\r\n\u003e WSL2 is not supported for development. Please use a native Linux or Windows environment. There are issues with keyring access in WSL2.\r\n\r\n## License\r\n\r\nThis application is licensed under the MIT License. See [LICENSE](LICENSE) for details.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotik09%2Fterminal-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotik09%2Fterminal-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotik09%2Fterminal-ai/lists"}