# RabbitAI 🐰
An intelligent CLI troubleshooting assistant powered by LLMs using the ReAct (Reasoning + Acting) pattern.
RabbitAI helps you diagnose and troubleshoot system issues by autonomously running diagnostic commands, analyzing the results, and providing helpful answers - all through a simple conversational interface.
## Installation
### Prerequisites
- **Python 3.8+** (Python 3.9 or later recommended)
- **pip** (Python package manager)
- **LLM Provider** (choose one):
- **Gemini API**: Get a free API key from [Google AI Studio](https://makersuite.google.com/app/apikey)
- **Ollama**: Install from [ollama.ai](https://ollama.ai) and pull a model (e.g., `ollama pull llama3`)
### Install from GitHub
#### Option 1: Install with pip (Recommended)
```bash
# Clone the repository
git clone https://github.com/yourusername/rabbitai.git
cd rabbitai
# Install the package
pip install -e .
```
#### Option 2: Install from URL
```bash
# Install directly from GitHub
pip install git+https://github.com/yourusername/rabbitai.git
```
### Initial Setup
After installation, run the setup wizard:
```bash
rabbit setup
```
The setup wizard will ask you to:
1. Choose your LLM provider (Gemini or Ollama)
2. Enter your API key (for Gemini) or model name (for Ollama)
3. Configure safety settings
## Quick Start
### Basic Usage
```bash
# Start RabbitAI
rabbit
# Example interaction
rabbit> what directory am I in?
```
The agent will:
1. Analyze your query
2. Run diagnostic commands (e.g., `pwd`)
3. Provide a clear answer based on the output
### Example Queries
**System Diagnostics:**
```
rabbit> why is my disk full?
rabbit> what processes are using the most memory?
rabbit> check system uptime and load
```
**Network Troubleshooting:**
```
rabbit> can I reach google.com?
rabbit> what's my IP address?
rabbit> check if port 8080 is open
```
**Service Management:**
```
rabbit> is nginx running?
rabbit> what services are listening on port 80?
rabbit> check docker containers
```
**File Operations:**
```
rabbit> what are the largest files in this directory?
rabbit> find all .log files modified today
rabbit> show me hidden files
```
### Exit
```bash
rabbit> exit
# or press Ctrl+C
```
## Troubleshooting
### Common Issues
**1. "No configuration found"**
```bash
# Run setup first
rabbit setup
```
**2. "Gemini API key not configured"**
```bash
# Re-run setup and enter your API key
rabbit setup
```
**3. "Ollama connection error"**
```bash
# Make sure Ollama is running
ollama serve
# Pull a model if you haven't
ollama pull llama3
```
**4. "rabbit command not found"**
After installation, the `rabbit` command may not be in your PATH. Add the scripts directory to your PATH:
**macOS:**
```bash
# Add to ~/.zshrc or ~/.bash_profile
export PATH="$HOME/Library/Python/3.9/bin:$PATH" # Replace the python version as per your current version
source ~/.zshrc
```
**Linux:**
```bash
# Add to ~/.bashrc or ~/.profile
export PATH="$HOME/.local/bin:$PATH"
source ~/.bashrc
```
**Windows:**
```powershell
# Add to PowerShell profile or Environment Variables
$env:PATH += ";$env:APPDATA\Python\Python39\Scripts" # Replace the python version as per your current version
```
**Alternative: Run directly without PATH setup**
```bash
python3 -m rabbitai.cli # macOS/Linux
python -m rabbitai.cli # Windows
```
## License
MIT License - see LICENSE file for details
---
Made with ❤️ for CLI enthusiasts and system administrators
Raw data
{
"_id": null,
"home_page": null,
"name": "rabbitai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cli, troubleshooting, ai, llm, react, agent, gemini, ollama, langchain",
"author": null,
"author_email": "Aritra777 <aritrabiswas.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/72/f6/09898f9000a3c3499f52a79110b279899c8fabe2d778991709878f724c35/rabbitai-0.1.0.tar.gz",
"platform": null,
"description": "# RabbitAI \ud83d\udc30\n\nAn intelligent CLI troubleshooting assistant powered by LLMs using the ReAct (Reasoning + Acting) pattern.\n\nRabbitAI helps you diagnose and troubleshoot system issues by autonomously running diagnostic commands, analyzing the results, and providing helpful answers - all through a simple conversational interface.\n\n## Installation\n\n### Prerequisites\n\n- **Python 3.8+** (Python 3.9 or later recommended)\n- **pip** (Python package manager)\n- **LLM Provider** (choose one):\n - **Gemini API**: Get a free API key from [Google AI Studio](https://makersuite.google.com/app/apikey)\n - **Ollama**: Install from [ollama.ai](https://ollama.ai) and pull a model (e.g., `ollama pull llama3`)\n\n### Install from GitHub\n\n#### Option 1: Install with pip (Recommended)\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/rabbitai.git\ncd rabbitai\n\n# Install the package\npip install -e .\n```\n\n#### Option 2: Install from URL\n\n```bash\n# Install directly from GitHub\npip install git+https://github.com/yourusername/rabbitai.git\n```\n\n### Initial Setup\n\nAfter installation, run the setup wizard:\n\n```bash\nrabbit setup\n```\n\nThe setup wizard will ask you to:\n1. Choose your LLM provider (Gemini or Ollama)\n2. Enter your API key (for Gemini) or model name (for Ollama)\n3. Configure safety settings\n\n## Quick Start\n\n### Basic Usage\n\n```bash\n# Start RabbitAI\nrabbit\n\n# Example interaction\nrabbit> what directory am I in?\n```\n\nThe agent will:\n1. Analyze your query\n2. Run diagnostic commands (e.g., `pwd`)\n3. Provide a clear answer based on the output\n\n### Example Queries\n\n**System Diagnostics:**\n```\nrabbit> why is my disk full?\nrabbit> what processes are using the most memory?\nrabbit> check system uptime and load\n```\n\n**Network Troubleshooting:**\n```\nrabbit> can I reach google.com?\nrabbit> what's my IP address?\nrabbit> check if port 8080 is open\n```\n\n**Service Management:**\n```\nrabbit> is nginx running?\nrabbit> what services are listening on port 80?\nrabbit> check docker containers\n```\n\n**File Operations:**\n```\nrabbit> what are the largest files in this directory?\nrabbit> find all .log files modified today\nrabbit> show me hidden files\n```\n\n### Exit\n\n```bash\nrabbit> exit\n# or press Ctrl+C\n```\n## Troubleshooting\n\n### Common Issues\n\n**1. \"No configuration found\"**\n```bash\n# Run setup first\nrabbit setup\n```\n\n**2. \"Gemini API key not configured\"**\n```bash\n# Re-run setup and enter your API key\nrabbit setup\n```\n\n**3. \"Ollama connection error\"**\n```bash\n# Make sure Ollama is running\nollama serve\n\n# Pull a model if you haven't\nollama pull llama3\n```\n\n**4. \"rabbit command not found\"**\n\nAfter installation, the `rabbit` command may not be in your PATH. Add the scripts directory to your PATH:\n\n**macOS:**\n```bash\n# Add to ~/.zshrc or ~/.bash_profile\nexport PATH=\"$HOME/Library/Python/3.9/bin:$PATH\" # Replace the python version as per your current version\nsource ~/.zshrc\n```\n\n**Linux:**\n```bash\n# Add to ~/.bashrc or ~/.profile\nexport PATH=\"$HOME/.local/bin:$PATH\"\nsource ~/.bashrc\n```\n\n**Windows:**\n```powershell\n# Add to PowerShell profile or Environment Variables\n$env:PATH += \";$env:APPDATA\\Python\\Python39\\Scripts\" # Replace the python version as per your current version\n```\n\n**Alternative: Run directly without PATH setup**\n```bash\npython3 -m rabbitai.cli # macOS/Linux\npython -m rabbitai.cli # Windows\n```\n\n## License\n\nMIT License - see LICENSE file for details\n\n---\n\nMade with \u2764\ufe0f for CLI enthusiasts and system administrators\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI-powered CLI troubleshooting assistant using ReAct pattern with LLM backends (Gemini/Ollama)",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/Aritra777/rabbitai#readme",
"Homepage": "https://github.com/Aritra777/rabbitai",
"Repository": "https://github.com/Aritra777/rabbitai"
},
"split_keywords": [
"cli",
" troubleshooting",
" ai",
" llm",
" react",
" agent",
" gemini",
" ollama",
" langchain"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "faa4abaf5b44441d51848e2820b56fb9952bfc176139a3496e9628687463db71",
"md5": "9b7d2c8c9b136f194aae7d9e1634fedc",
"sha256": "efedc03ce52c2021bed32220c26e92875978ed5db31a4885f84e9be53e94d828"
},
"downloads": -1,
"filename": "rabbitai-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b7d2c8c9b136f194aae7d9e1634fedc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 28889,
"upload_time": "2025-10-19T17:47:43",
"upload_time_iso_8601": "2025-10-19T17:47:43.391053Z",
"url": "https://files.pythonhosted.org/packages/fa/a4/abaf5b44441d51848e2820b56fb9952bfc176139a3496e9628687463db71/rabbitai-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "72f609898f9000a3c3499f52a79110b279899c8fabe2d778991709878f724c35",
"md5": "c01c8322f8f5cfebbdc1dfe11689169d",
"sha256": "e86ea279bc16077670734b6a2a23cecef03c8f1bcb6fd77cd6c2e16417e93dd8"
},
"downloads": -1,
"filename": "rabbitai-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c01c8322f8f5cfebbdc1dfe11689169d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 23926,
"upload_time": "2025-10-19T17:47:44",
"upload_time_iso_8601": "2025-10-19T17:47:44.879309Z",
"url": "https://files.pythonhosted.org/packages/72/f6/09898f9000a3c3499f52a79110b279899c8fabe2d778991709878f724c35/rabbitai-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-19 17:47:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Aritra777",
"github_project": "rabbitai#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rabbitai"
}
JSON
