Your AI Assistant for the Terminal 🚀

Terminaider is a CLI that brings AI-powered assistance directly to your terminal.

Interact with an AI chat interface to get instant help, code analysis, and more — all without leaving your command line.

✨ Features

• AI Chat Interface: Engage in conversations with an AI assistant directly from your terminal.
• Code Analysis: Provides code summaries related to your inputs.
• Customizable Interfaces: Choose between different AI interfaces like Groq or OpenAI.
• Session Management: Maintains chat history per session.
• Clipboard Integration: Copy code summaries directly to your clipboard.

📦 Installation

Install Terminaider via pip:

pip install terminaider

# Recommended:
pipx install terminaider

🚀 Getting Started

Start using Terminaider by simply typing:

ai

Or initiate a chat with an initial prompt:

ai How do I calculate Earth's roundness

⚙️ Configuration

Set your API tokens as environment variables:

# If you want to use Groq's API
export GROQ_API_KEY='your_groq_api_key'

# If you want to use OpenAI's API
export OPENAI_API_KEY='your_openai_api_key'

📖 Usage

🗨️ Chat with the AI Assistant

Start an interactive session:

ai

Provide an initial prompt:

ai explain the why Python is great

⚙️ Options

• --interface, -i: Specify the AI interface to use (e.g., groq or openai).
• --version, -v: Display the current version of Terminaider.

PD: Interface selection will be stored as default for future use. So you don't need to specify it everytime_

Configuration file is located at ~/.config/terminaider/config.yaml.

🔍 Code Analysis

The AI will provide code analysis when necessary and automatically copy them to your clipboard for easy access.

🛠 Build Instructions

Build from source:

Clone the Repository

git clone https://github.com/Danielratmiroff/terminaider.git

Navigate to the Project Directory

cd terminaider

Create a Virtual Environment (Optional but Recommended)

python -m venv venv
source venv/bin/activate  # On Windows use venv\Scripts\activate

Install Dependencies

pip install build
pip install -r requirements.txt

Build the Package

python -m build

This will generate distribution files in the dist/ directory.

Install the Built Package

pip install dist/terminaider-<VERSION>-py3-none-any.whl

🤝 Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

📄 License

MIT License - LICENSE.