https://github.com/nitindahiya-dev/terminalai
TerminalAI is an AI-driven terminal assistant
https://github.com/nitindahiya-dev/terminalai
ai freeapi gpt-4 terminal terminal-ai terminal-app
Last synced: 18 days ago
JSON representation
TerminalAI is an AI-driven terminal assistant
- Host: GitHub
- URL: https://github.com/nitindahiya-dev/terminalai
- Owner: nitindahiya-dev
- Created: 2025-04-21T18:24:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-21T18:53:19.000Z (about 1 year ago)
- Last Synced: 2026-02-06T09:07:53.608Z (4 months ago)
- Topics: ai, freeapi, gpt-4, terminal, terminal-ai, terminal-app
- Language: Rust
- Homepage: https://terminal-ai-alpha.vercel.app
- Size: 112 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TerminalAI: AI-Powered Terminal Assistant
TerminalAI is an AI-driven terminal assistant that combines a sleek, dark-themed interface with natural language processing to transform plain English instructions into executable bash commands. Built with Rust for performance and Python for AI integration, it offers a modern workflow enhancement for developers.
## ✨ Features
- **Natural Language Processing**
Convert phrases like _"create a folder"_ to `mkdir folder`
- **Dark Futuristic GUI**
Responsive interface built with Rust's `eframe` featuring real-time typing
- **Smart Autocomplete**
Tab-complete files/directories with Tab
- **Direct Command Execution**
Run native bash commands (`pwd`, `ls --color`, `clear`, `cd`)
- **GPT-4 Integration**
Powered by Dockerized [FreeGPT4-WEB-API](https://github.com/d0ckmg/free-gpt4-web-api)
- **Robust Error Handling**
Clear diagnostics for API issues and invalid commands
## 🚀 Getting Started
### Prerequisites
- **Rust**:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
- **Python 3.13+:**:
```bash
sudo apt-get install python3 python3-pip python3-venv
```
- Install Docker
## Installation
- **Clome repo**:
```bash
git clone https://github.com/nitindahiya-dev/terminalAI.git
cd terminalAI
```
- **Set Up Python Environment**:
```bash
python3 -m venv venv
source venv/bin/activate
pip install requests
```
- **Launch GPT-4 API**:
```bash
docker run -p 5500:5500 d0ckmg/free-gpt4-web-api
```
- **Build Rust Project**:
```bash
cargo build
```
- **Launching the Application**:
```bash
# Ensure Docker API is running in background
source venv/bin/activate
cargo run -- --interactive
```
## 📚 Examples
- **Create Directory**:
```bash
user@host $ create a logs folder
→ Executed: mkdir logs_folder
```
- **List Files with Colors**:
```bash
user@host $ list files in detail
→ Executed: ls --color -l
```
- **System Command**:
```bash
user@host $ clear
→ Terminal cleared
```
## 🔧 Troubleshooting
- **Verify AI agent path:**:
```bash
/projects/terminalAI/venv/bin/python3 ai_agent.py "create folder"
```
Expected output: {"command":"mkdir folder"}
- **❌ API Connection Issues**:
```bash
docker ps
netstat -tuln | grep 5500
```
- **🔄 UI Rendering Problems**:
```bash
desired_width = 600.0,
window_size = (800.0, 600.0)
```