# Terminal-AI
   
<!--  -->
  
<!--  -->
A 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)
## Installation
To install protai, simply run the following command in your terminal:
```bash
pip install --upgrade protai
```
## Usage
To use this application, simply run the following command in your terminal:
```bash
protai <query>
```
*For example:*
>[!Note]
> 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).
>[!IMPORTANT]
> You need to have a _**valid Groq AI API key**_ to use this application.
## Development
The application is using the _**llama-3.1-8b-instant**_ model for its instant inference, as that has the fastest response time.
The interactive version is using the **llama-3.3-70b-versatile** for its 0-shot inference.
If you wish to develop for this application, you can clone the repository and install the dependencies using the scripts given:
```bash
git clone https://github.com/protik09/terminal-ai.git
cd terminal-ai
./activate_venv.sh
```
or
```powershell
git clone https://github.com/protik09/terminal-ai.git
cd terminal-ai
.\activate_venv.ps1
```
To generate the wheel and upload to PyPI, we use the following command:
```bash
python setup.py upload
```
> [!IMPORTANT]
> 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.
### Prerequisites
>[!NOTE]
>* Python 3.10 or later 🐍
>* Groq AI API key (available at [Groq AI website](https://console.groq.com/keys))
### Program Flow Chart
### Contributing
Contributions are welcome! If you'd like to contribute to this application, please fork the repository and submit a pull request.
>[!WARNING]
> WSL2 is not supported for development. Please use a native Linux or Windows environment. There are issues with keyring access in WSL2.
## License
This application is licensed under the MIT License. See [LICENSE](LICENSE) for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/protik09/terminal-ai",
"name": "protai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.0",
"maintainer_email": null,
"keywords": null,
"author": "Protik Banerji",
"author_email": "protik09@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/f8/ef/4c7aa25800cfb1e32a0f72e79d40c48da0cecc66b6855d703c933a99a787/protai-1.0.2.tar.gz",
"platform": null,
"description": "\r\n# Terminal-AI\r\n\r\n\r\n\r\n   \r\n<!--  -->\r\n\r\n  \r\n\r\n<!--  -->\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 <query>\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>[!Note]\r\n> 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>[!IMPORTANT]\r\n> 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> [!IMPORTANT]\r\n> 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>[!NOTE]\r\n>* Python 3.10 or later \ud83d\udc0d\r\n>* 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>[!WARNING]\r\n> 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",
"bugtrack_url": null,
"license": "MIT",
"summary": "A useful 0-Shot AI in the terminal",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/protik09/terminal-ai"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "18d82a41f1329bb59a120203f80bc09a45d47c1be429414dd66a8029b0277fbd",
"md5": "b337773c8483bf802b79f0152618643f",
"sha256": "dae124d70c003fa7c299ed2dfbc5877d0f9d78015ac712e22d5647c67b21946f"
},
"downloads": -1,
"filename": "protai-1.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b337773c8483bf802b79f0152618643f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10.0",
"size": 12234,
"upload_time": "2024-12-21T13:18:03",
"upload_time_iso_8601": "2024-12-21T13:18:03.614739Z",
"url": "https://files.pythonhosted.org/packages/18/d8/2a41f1329bb59a120203f80bc09a45d47c1be429414dd66a8029b0277fbd/protai-1.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8ef4c7aa25800cfb1e32a0f72e79d40c48da0cecc66b6855d703c933a99a787",
"md5": "7f7bc97d290077edd966476ce9882a65",
"sha256": "0a26d0cf0f2277b75bdb0f3c733bb39aab4321c5920546a086a662130c7bbcf8"
},
"downloads": -1,
"filename": "protai-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "7f7bc97d290077edd966476ce9882a65",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.0",
"size": 14423,
"upload_time": "2024-12-21T13:18:06",
"upload_time_iso_8601": "2024-12-21T13:18:06.030376Z",
"url": "https://files.pythonhosted.org/packages/f8/ef/4c7aa25800cfb1e32a0f72e79d40c48da0cecc66b6855d703c933a99a787/protai-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 13:18:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "protik09",
"github_project": "terminal-ai",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": []
},
{
"name": "wheel",
"specs": []
},
{
"name": "rich",
"specs": []
},
{
"name": "keyring",
"specs": []
},
{
"name": "prompt-toolkit",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "orjson",
"specs": []
},
{
"name": "tiktoken",
"specs": []
}
],
"lcname": "protai"
}
JSON
