1 line
3.8 KiB
JSON
1 line
3.8 KiB
JSON
{"repo": "aromalbiju1/elyssiaagent", "files": {"README.md": {"c489133a2a16d25d38ea231593c33f1b0a82b4c3": {"t": 1785674372.9442954, "n": 3463, "h": "1e0af9f1cf5923aa", "c": "# ElyssiaAgent\n\n\n> A locally-hosted, multimodal AI agent with plugin architecture, multi-channel communication, and browser automation. Running 100% on your hardware.\n\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n\n## 🌟 Major Features\n\n### 1. 🧠 Core Intelligence\n- **LLM Agnostic**: defaults to Ollama (Qwen 4B), but supports **vLLM**, **Groq**, **LM Studio**, and **OpenAI**.\n- **RAG Memory**: Vector database (FAISS) + SQLite conversation history.\n- **Tools**: Calculator, Web Search, Python Execution, File I/O.\n\n### 2. 🔌 Plugin System\n- Modular architecture where every capability is a plugin.\n- Located in `plugins/builtin/` and `plugins/community/`.\n- Hot-loadable and extensible.\n\n### 3. 📡 Multi-Channel Communication\n- **Telegram Bot**: Full chat interface with typing indicators.\n- **Discord Bot**: DM and channel support.\n- **Web UI**: Next.js styled interface (Black+Pink theme).\n- **CLI**: Interactive terminal chat.\n\n### 4. 🌍 Browser Automation\n- **Headless Browsing**: Powered by Playwright.\n- Capabilities: Navigate, click, type, extract text, take screenshots.\n- \"Browsing Agent\" mode.\n\n### 5. 🛡️ Security & Management\n- **CLI Gateway**: Unified management tool (`manage`).\n- **Security Guardrails**: Prevents filesystem damage (`rm -rf /` block, path validation).\n\n---\n\n## 🚀 Quick Start\n\n### 1. Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/elyssia-agent.git\ncd elyssia-agent\n\n# Install dependencies\npip install -r requirements.txt\nplaywright install chromium\n```\n\n### 2. Configuration & Setup\n\nRun the interactive setup wizard:\n\n```bash\npython run.py --mode manage setup\n```\nThis will create `config/config.yaml` from `config/config.example.yaml`.\n\n> **⚠️ IMPORTANT**: Never commit `config/config.yaml`. It contains your API keys and tokens.\n\n### 3. Running the Agent\n\n**Interactive CLI (Chat):**\n```bash\npython run.py --mode chat\n```\n\n**Web Backend (API):**\n```bash\npython run.py --mode web\n```\n\n**Web Frontend (UI):**\n```bash\ncd web\nnpm install\nnpm run dev\n# Visit http://localhost:3000\n```\n\n**System Status:**\n```bash\npython run.py --mode manage status\n```\n\n---\n\n## 🔧 Configuration Guide\n\nSee `config/config.example.yaml` for all options.\n\n### Enabling Channels (Telegram/Discord)\n1. Get your bot tokens.\n2. Edit `config/config.yaml`:\n ```yaml\n channels:\n telegram:\n enabled: true\n bot_token: \"YOUR_TOKEN\"\n ```\n\n### Connecting to External Models (Groq / vLLM)\n```yaml\nmodel:\n backend: \"openai\"\n name: \"mixtral-8x7b-32768\"\n openai:\n base_url: \"https://api.groq.com/openai/v1\"\n api_key: \"gsk_...\"\n```\n\n---\n\n## 🏗️ Project Structure\n\n```\nelyssia-agent/\n├── src/\n│ ├── core/ # LLM, Memory, Security\n│ ├── plugins/ # Plugin Loader\n│ ├── channels/ # Telegram/Discord logic\n│ ├── cli/ # CLI Gateway\n│ └── api/ # FastAPI Server\n├── plugins/\n│ └── builtin/ # Default plugins (browser, search, etc.)\n├── config/\n│ ├── config.yaml # YOUR SECRETS (GitIgnored)\n│ └── config.example.yaml # Template\n├── run.py # Main entry point\n└── requirements.txt\n```\n\n## 🤝 Contributing\n\nContributions are welcome! Please ensure you:\n1. Don't commit `config.yaml`.\n2. Add tests for new plugins.\n\n## 📄 License\n\nMIT License.\n"}}}} |