Metadata-Version: 2.4
Name: jarvis-buddy
Version: 0.1.0
Summary: A chill AI assistant that lives in your terminal — controls your computer, reads files, searches the web, all in plain English.
Author-email: Najib <blancko31@outlook.com>
License: MIT
Project-URL: Homepage, https://github.com/Najibex/jarvis-ai
Project-URL: Repository, https://github.com/Najibex/jarvis-ai
Project-URL: Issues, https://github.com/Najibex/jarvis-ai/issues
Keywords: ai,assistant,cli,terminal,chatbot,jarvis,groq
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai>=1.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: pypdf>=4.0.0
Requires-Dist: ddgs>=0.9.0
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: requests>=2.31.0
Dynamic: license-file

# Jarvis Buddy 🤖

A chill AI assistant that lives in your terminal — controls your computer, reads files, searches the web, all in plain English.

Made by a 15-year-old who wanted his own Jarvis. Now anyone can have one.

---

## ✨ Features

- 🧠 Remembers you across sessions
- 🖥️ Control your computer with natural language ("take me to Downloads")
- 📄 Read any file including PDFs
- 🌐 Search the web (DuckDuckGo, no API key)
- 📖 Fetch and read webpages (Wikipedia, Reddit, GitHub, articles)
- 🛡️ Safety system with confirmations for risky commands
- 🗑️ Automatic backup before deleting files
- 🎨 Beautiful colored terminal interface

---

## 💻 Supported Platforms

- ✅ Linux (all distros)
- ✅ macOS
- ❌ Windows — use WSL or switch to Linux 🐧

---

## 📦 Installation

```bash
pip install jarvis-buddy
```

---

## ⚙️ Setup

1. Get a **free** API key from [Groq](https://console.groq.com/keys)
2. Configure it: `jarvis setup`
3. Start chatting: `jarvis`

---

## 💬 Usage

Just talk to Jarvis like a normal person:

- `"take me to my downloads folder"`
- `"what files are here?"`
- `"read main.py and explain it to me"`
- `"search for the latest python news"`
- `"fetch the wikipedia page for machine learning"`
- `"make a new folder called projects"`

Type `quit` to exit, `reset` to wipe memory.

---

## 💰 Cost

Jarvis uses Groq's API. You have 2 options:

- 🆓 **Free tier** — 100k tokens/day (~150-200 messages). Enough for casual daily use.
- 💰 **Dev tier** — deposit ~$5-10, get thousands of messages. Way cheaper than ChatGPT Plus.

Get your key at [console.groq.com/keys](https://console.groq.com/keys)

---

## 🛡️ Safety

Jarvis has 3 command tiers:

- 🟢 **Safe** — read/navigate freely (`ls`, `cd`, `cat`, etc.)
- 🟡 **Confirm** — asks before modifying anything (`rm`, `mv`, `pip install`)
- 🔴 **Banned** — never runs (`sudo`, disk formatting, system files)

Deleted files get backed up to `~/.jarvis/trash/` first, just in case.

---

## 🔧 Commands

| Command | What it does |
|---|---|
| `jarvis` | Start chatting |
| `jarvis setup` | Configure your API key |
| `jarvis reset` | Wipe conversation memory |
| `jarvis --help` | Show help |

---

## 📁 Files

Jarvis stores everything in `~/.jarvis/`:
- `config.env` — your API key
- `memory.json` — conversation history
- `action_log.txt` — every command that ran
- `trash/` — backups of deleted files

---

## 📜 License

MIT — do whatever you want with it.

---

## 👤 Author

Made with too much caffeine by [Najib](https://github.com/Najibex)

Star the repo ⭐ if you like it!
