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.

The application uses the following models:

• Instant Mode: llama-3.3-70b-versatile for fast, zero-shot inference.

• Interactive Mode: openai/gpt-oss-120b for multi-turn, zero-shot inference.

Development

To develop for this application, clone the repository and install dependencies using the provided scripts:

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.

Key Files & Structure

• protai/protai.py: CLI entry, argument parsing, main logic, reply formatting, error handling.
• protai/auth.py: API key storage, retrieval, validation, user prompts (uses prompt-toolkit).
• protai/mygroq.py: GROQ API wrapper (uses requests and orjson).
• protai/texteffects.py: Terminal output formatting.
• protai/ismarkdown.py: Markdown detection for replies.
• protai/__init__.py and VERSION: Version management.

Prerequisites

• Python 3.9 or later 🐍
• Groq AI API key (available at Groq AI website)

[!NOTE]

• Python 3.9 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.