A useful 0-Shot AI in the terminal
Project description
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
Installation
To install protai, simply run the following command in your terminal:
pip install --upgrade protai
Usage
To use this application, simply run the following command in your terminal:
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.
[!IMPORTANT] You need to have a valid Groq AI API key to use this application.
Development
The GROQ API is using the llama3-8b-8192 model, as that has the fastest response time.
If you wish to develop for this application, you can clone the repository and install the dependencies using the scripts given:
git clone https://github.com/protik09/terminal-ai.git
cd terminal-ai
./activate_venv.sh
or
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:
python setup.py upload
[!IMPORTANT] Only the current maintainer has access to the PyPI 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)
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 for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file protai-1.0.0.tar.gz
.
File metadata
- Download URL: protai-1.0.0.tar.gz
- Upload date:
- Size: 14.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24654aff2dd7fa34723dbde4a808c11f769eab75431c17d7113692687fe7d5d5 |
|
MD5 | 92d356fd581487f9abe7b6f197751128 |
|
BLAKE2b-256 | ee55c1cc3b369b8253173873432c02e3bd5a948b56d39990dd7a58842b31e211 |
File details
Details for the file protai-1.0.0-py2.py3-none-any.whl
.
File metadata
- Download URL: protai-1.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 12.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2dc1e4cf06673874ece8cf47589f6ae545bad0a597bbe35f464c61aca099614a |
|
MD5 | 96602bd93e8abae8c580ac29dceff4dc |
|
BLAKE2b-256 | 45cb0abcf8e6846a0609f6295111f69d29f23c4653ddb339abf6e3f03940cf64 |