termi-ai 0.1.0__tar.gz

termi_ai-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Termi Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

termi_ai-0.1.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: termi-ai
+Version: 0.1.0
+Summary: AI-powered cross-platform terminal assistant that converts natural language into shell commands.
+Author: Termi Contributors
+License: MIT
+Keywords: cli,ai,llm,terminal,shell,assistant
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Shells
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.12.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: groq
+Requires-Dist: groq>=0.9.0; extra == "groq"
+Provides-Extra: openai
+Requires-Dist: openai>=1.30.0; extra == "openai"
+Provides-Extra: gemini
+Requires-Dist: google-genai>=0.3.0; extra == "gemini"
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.30.0; extra == "anthropic"
+Provides-Extra: all
+Requires-Dist: groq>=0.9.0; extra == "all"
+Requires-Dist: openai>=1.30.0; extra == "all"
+Requires-Dist: google-genai>=0.3.0; extra == "all"
+Requires-Dist: anthropic>=0.30.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: isort>=5.13.0; extra == "dev"
+Dynamic: license-file
+
+# 🤖 Termi
+
+**AI-powered multi-LLM terminal assistant that converts natural language into executable shell commands.**
+
+---
+
+## 📖 Project Description
+
+**Termi** lets you describe what you want to do in plain English and get back a real, executable shell command — no more digging through `man` pages or half-remembered `find` flags.
+
+It works across **Windows, Linux, and macOS**, automatically detects your operating system and shell, and supports **five different LLM providers** so you're never locked into one vendor. Termi remembers what you've asked in the current session. It can explain what a command does before you run it, diagnose *why* a command failed after you run it and like any responsible assistant sitting in front of your terminal, it always asks before executing anything.
+
+---
+
+## 🎥 Demo
+
+> Demo GIF / Video coming soon
+
+
+
+
+---
+
+## ✨ Features
+
+| | Feature | Description |
+|---|---|---|
+| ✅ | **Natural language → shell commands** | Describe a task in plain English, get back a real, runnable command |
+| ✅ | **Multiple LLM providers** | Groq, OpenAI, Gemini, Anthropic, and Ollama (local) |
+| ✅ | **Runtime provider switching** | Swap providers mid-session with `/provider set <name>` |
+| ✅ | **Automatic OS detection** | Detects Windows, Linux, or macOS automatically |
+| ✅ | **Automatic shell detection** | Detects bash, zsh, fish, PowerShell, or cmd automatically |
+| ✅ | **Persistent command history** | Every prompt, command, and result is logged to SQLite |
+| ✅ | **Command explanation** | Ask Termi to explain any shell command in plain English |
+| ✅ | **AI-powered error explanation** | When a command fails, Termi diagnoses why and suggests a fix |
+| ✅ | **Confirmation before execution** | Nothing runs without your explicit go-ahead |
+| ✅ | **Cross-platform** | Windows, Linux, and macOS |
+| ✅ | **Installable CLI package** | `pip install -e .` and run `termi` from anywhere |
+
+---
+
+## 🏗️ Architecture
+
+```
+                          ┌─────────────────────┐
+                          │   CLI (Typer/Rich)   │
+                          │         │
+                          └──────────┬───────────┘
+                                     │
+                                     ▼
+                          ┌─────────────────────┐
+                          │        Agent         │
+                          │   (orchestrator)      │
+                          └──────────┬───────────┘
+                                     │
+        ┌───────────────┬───────────┼───────────────┬───────────────┐
+        ▼               ▼           ▼               ▼               ▼
+┌───────────────┐ ┌───────────┐ ┌─────────┐ ┌───────────────┐ ┌───────────┐
+│ Conversation   │ │ Provider  │ │ Command │ │   Settings    │ │  System   │
+│   Manager      │ │ Manager   │ │Executor │ │   Manager     │ │ Detector  │
+└───────────────┘ └─────┬─────┘ └─────────┘ └───────────────┘ └───────────┘
+                         │
+                         ▼
+              ┌──────────────────────┐
+              │   ProviderFactory     │
+              └──────────┬────────────┘
+                         │
+     ┌────────┬──────────┼──────────┬────────────┐
+     ▼         ▼          ▼          ▼            ▼
+  ┌──────┐ ┌────────┐ ┌────────┐ ┌───────────┐ ┌────────┐
+  │ Groq │ │ OpenAI │ │ Gemini │ │ Anthropic │ │ Ollama │
+  └──────┘ └────────┘ └────────┘ └───────────┘ └────────┘
+
+                         │
+                         ▼
+              ┌──────────────────────┐
+              │   SQLite Database     │
+              │   │
+              └───────────────────────┘
+```
+
+---
+
+## 📦 Installation
+
+### From source
+
+```bash
+git clone https://github.com/<shreya-ramesh>/termi.git
+cd termi
+
+python3 -m venv .venv
+source .venv/bin/activate      
+
+pip install -e ".[dev]"
+
+cp .env.example .env
+# add your API key(s) to .env
+
+termi
+```
+
+### Via pip (once published)
+
+```bash
+pip install termi
+termi
+```
+
+---
+
+## ⚙️ Configuration
+
+Termi reads its configuration from a `.env` file at the project root so fill in the keys for whichever provider(s) you plan to use — you only need the ones you'll actually use.
+
+| Variable | Description |
+|---|---|
+| `GROQ_API_KEY` | API key for Groq |
+| `OPENAI_API_KEY` | API key for OpenAI |
+| `GEMINI_API_KEY` | API key for Google Gemini |
+| `ANTHROPIC_API_KEY` | API key for Anthropic Claude |
+| `OLLAMA_BASE_URL` | URL of a locally running Ollama server (default: `http://localhost:11434`) |
+
+---
+
+
+## 📁 Project Structure
+
+```
+termi/
+├── termi/
+│   ├── __init__.py
+│   ├── cli.py                     # Typer + Rich CLI entrypoint
+│   ├── core/
+│   │   ├── agent.py                # Orchestrates generation, safety, execution
+│   │   ├── provider_manager.py     # Single entry point to LLM providers
+│   │   ├── conversation.py         # Conversational memory
+│   │   ├── executor.py             # Shell command execution
+│   │   ├── settings.py             # Persistent user settings
+│   │   ├── system.py               # OS / shell / cwd / user detection
+│   │   ├── system_query.py         # Local (LLM-free) system-info queries
+│   │   ├── explainer.py            # Command explanation
+│   │   ├── error_explainer.py      # AI-powered failure diagnosis
+│   │   └── intent.py               # LLM output → clean shell command
+│   ├── providers/
+│   │   ├── base.py                 # Abstract BaseProvider interface
+│   │   ├── factory.py              # ProviderFactory
+│   │   ├── groq_provider.py
+│   │   ├── openai_provider.py
+│   │   ├── gemini_provider.py
+│   │   ├── anthropic_provider.py
+│   │   └── ollama_provider.py
+│   ├── database/
+│   │   ├── database.py             # SQLite connection + schema
+│   │   └── history_repository.py   # History CRUD
+│   ├
+│   │              
+│   └── utils/
+│       ├── logger.py
+│       ├── exceptions.py
+│       └── dangerous_commands.py   # Destructive-command heuristics
+├── tests/                          # pytest suite
+├── settings.json
+├── pyproject.toml
+├── requirements.txt
+├── .env.example
+├── .gitignore
+└── LICENSE
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! If you'd like to help:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Make your changes, following the existing style (`black`, `isort`, `ruff`)
+4. Run the test suite (`pytest`)
+5. Open a pull request describing what changed and why
+
+> 📋 Please keep pull requests focused on one feature or fix per PR makes review much faster.
+
+---
+
+## 📄 License
+
+This project is licensed under the **MIT License** — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Acknowledgements
+
+Termi is built on top of a great open-source ecosystem, including [Typer](https://typer.tiangolo.com/), [Rich](https://github.com/Textualize/rich), and [python-dotenv](https://github.com/theskumar/python-dotenv), along with the official SDKs for Groq, OpenAI, Google Gemini, and Anthropic, plus [Ollama](https://ollama.com/) for local inference.

termi_ai-0.1.0/README.md

@@ -0,0 +1,195 @@
+# 🤖 Termi
+
+**AI-powered multi-LLM terminal assistant that converts natural language into executable shell commands.**
+
+---
+
+## 📖 Project Description
+
+**Termi** lets you describe what you want to do in plain English and get back a real, executable shell command — no more digging through `man` pages or half-remembered `find` flags.
+
+It works across **Windows, Linux, and macOS**, automatically detects your operating system and shell, and supports **five different LLM providers** so you're never locked into one vendor. Termi remembers what you've asked in the current session. It can explain what a command does before you run it, diagnose *why* a command failed after you run it and like any responsible assistant sitting in front of your terminal, it always asks before executing anything.
+
+---
+
+## 🎥 Demo
+
+> Demo GIF / Video coming soon
+
+
+
+
+---
+
+## ✨ Features
+
+| | Feature | Description |
+|---|---|---|
+| ✅ | **Natural language → shell commands** | Describe a task in plain English, get back a real, runnable command |
+| ✅ | **Multiple LLM providers** | Groq, OpenAI, Gemini, Anthropic, and Ollama (local) |
+| ✅ | **Runtime provider switching** | Swap providers mid-session with `/provider set <name>` |
+| ✅ | **Automatic OS detection** | Detects Windows, Linux, or macOS automatically |
+| ✅ | **Automatic shell detection** | Detects bash, zsh, fish, PowerShell, or cmd automatically |
+| ✅ | **Persistent command history** | Every prompt, command, and result is logged to SQLite |
+| ✅ | **Command explanation** | Ask Termi to explain any shell command in plain English |
+| ✅ | **AI-powered error explanation** | When a command fails, Termi diagnoses why and suggests a fix |
+| ✅ | **Confirmation before execution** | Nothing runs without your explicit go-ahead |
+| ✅ | **Cross-platform** | Windows, Linux, and macOS |
+| ✅ | **Installable CLI package** | `pip install -e .` and run `termi` from anywhere |
+
+---
+
+## 🏗️ Architecture
+
+```
+                          ┌─────────────────────┐
+                          │   CLI (Typer/Rich)   │
+                          │         │
+                          └──────────┬───────────┘
+                                     │
+                                     ▼
+                          ┌─────────────────────┐
+                          │        Agent         │
+                          │   (orchestrator)      │
+                          └──────────┬───────────┘
+                                     │
+        ┌───────────────┬───────────┼───────────────┬───────────────┐
+        ▼               ▼           ▼               ▼               ▼
+┌───────────────┐ ┌───────────┐ ┌─────────┐ ┌───────────────┐ ┌───────────┐
+│ Conversation   │ │ Provider  │ │ Command │ │   Settings    │ │  System   │
+│   Manager      │ │ Manager   │ │Executor │ │   Manager     │ │ Detector  │
+└───────────────┘ └─────┬─────┘ └─────────┘ └───────────────┘ └───────────┘
+                         │
+                         ▼
+              ┌──────────────────────┐
+              │   ProviderFactory     │
+              └──────────┬────────────┘
+                         │
+     ┌────────┬──────────┼──────────┬────────────┐
+     ▼         ▼          ▼          ▼            ▼
+  ┌──────┐ ┌────────┐ ┌────────┐ ┌───────────┐ ┌────────┐
+  │ Groq │ │ OpenAI │ │ Gemini │ │ Anthropic │ │ Ollama │
+  └──────┘ └────────┘ └────────┘ └───────────┘ └────────┘
+
+                         │
+                         ▼
+              ┌──────────────────────┐
+              │   SQLite Database     │
+              │   │
+              └───────────────────────┘
+```
+
+---
+
+## 📦 Installation
+
+### From source
+
+```bash
+git clone https://github.com/<shreya-ramesh>/termi.git
+cd termi
+
+python3 -m venv .venv
+source .venv/bin/activate      
+
+pip install -e ".[dev]"
+
+cp .env.example .env
+# add your API key(s) to .env
+
+termi
+```
+
+### Via pip (once published)
+
+```bash
+pip install termi
+termi
+```
+
+---
+
+## ⚙️ Configuration
+
+Termi reads its configuration from a `.env` file at the project root so fill in the keys for whichever provider(s) you plan to use — you only need the ones you'll actually use.
+
+| Variable | Description |
+|---|---|
+| `GROQ_API_KEY` | API key for Groq |
+| `OPENAI_API_KEY` | API key for OpenAI |
+| `GEMINI_API_KEY` | API key for Google Gemini |
+| `ANTHROPIC_API_KEY` | API key for Anthropic Claude |
+| `OLLAMA_BASE_URL` | URL of a locally running Ollama server (default: `http://localhost:11434`) |
+
+---
+
+
+## 📁 Project Structure
+
+```
+termi/
+├── termi/
+│   ├── __init__.py
+│   ├── cli.py                     # Typer + Rich CLI entrypoint
+│   ├── core/
+│   │   ├── agent.py                # Orchestrates generation, safety, execution
+│   │   ├── provider_manager.py     # Single entry point to LLM providers
+│   │   ├── conversation.py         # Conversational memory
+│   │   ├── executor.py             # Shell command execution
+│   │   ├── settings.py             # Persistent user settings
+│   │   ├── system.py               # OS / shell / cwd / user detection
+│   │   ├── system_query.py         # Local (LLM-free) system-info queries
+│   │   ├── explainer.py            # Command explanation
+│   │   ├── error_explainer.py      # AI-powered failure diagnosis
+│   │   └── intent.py               # LLM output → clean shell command
+│   ├── providers/
+│   │   ├── base.py                 # Abstract BaseProvider interface
+│   │   ├── factory.py              # ProviderFactory
+│   │   ├── groq_provider.py
+│   │   ├── openai_provider.py
+│   │   ├── gemini_provider.py
+│   │   ├── anthropic_provider.py
+│   │   └── ollama_provider.py
+│   ├── database/
+│   │   ├── database.py             # SQLite connection + schema
+│   │   └── history_repository.py   # History CRUD
+│   ├
+│   │              
+│   └── utils/
+│       ├── logger.py
+│       ├── exceptions.py
+│       └── dangerous_commands.py   # Destructive-command heuristics
+├── tests/                          # pytest suite
+├── settings.json
+├── pyproject.toml
+├── requirements.txt
+├── .env.example
+├── .gitignore
+└── LICENSE
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! If you'd like to help:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Make your changes, following the existing style (`black`, `isort`, `ruff`)
+4. Run the test suite (`pytest`)
+5. Open a pull request describing what changed and why
+
+> 📋 Please keep pull requests focused on one feature or fix per PR makes review much faster.
+
+---
+
+## 📄 License
+
+This project is licensed under the **MIT License** — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Acknowledgements
+
+Termi is built on top of a great open-source ecosystem, including [Typer](https://typer.tiangolo.com/), [Rich](https://github.com/Textualize/rich), and [python-dotenv](https://github.com/theskumar/python-dotenv), along with the official SDKs for Groq, OpenAI, Google Gemini, and Anthropic, plus [Ollama](https://ollama.com/) for local inference.

termi_ai-0.1.0/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "termi-ai"
+version = "0.1.0"
+description = "AI-powered cross-platform terminal assistant that converts natural language into shell commands."
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.12"
+license = { text = "MIT" }
+authors = [{ name = "Termi Contributors" }]
+keywords = ["cli", "ai", "llm", "terminal", "shell", "assistant"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Shells",
+]
+
+dependencies = [
+    "typer>=0.12.0",
+    "rich>=13.7.0",
+    "python-dotenv>=1.0.0",
+    "requests>=2.31.0",
+]
+
+[project.optional-dependencies]
+groq = ["groq>=0.9.0"]
+openai = ["openai>=1.30.0"]
+gemini = ["google-genai>=0.3.0"]
+anthropic = ["anthropic>=0.30.0"]
+all = ["groq>=0.9.0", "openai>=1.30.0", "google-genai>=0.3.0", "anthropic>=0.30.0"]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-cov>=5.0.0",
+    "black>=24.0.0",
+    "ruff>=0.5.0",
+    "isort>=5.13.0",
+]
+
+[project.scripts]
+termi = "termi.cli:run"
+
+[tool.setuptools.packages.find]
+include = ["termi*"]
+
+[tool.black]
+line-length = 100
+target-version = ["py312"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+known_first_party = ["termi"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+ignore = ["E501"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra -q"

termi_ai-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

termi_ai-0.1.0/termi/__init__.py

@@ -0,0 +1,3 @@
+"""Termi: an AI-powered cross-platform terminal assistant."""
+
+__version__ = "0.1.0"