apexbot 1.0.5 → 1.0.7

package/README.md

@@ -1,119 +1,95 @@
-# ApexBot
+# 🦊 ApexBot
 
-Personal AI assistant you run on your own devices. Free with Ollama (local AI).
+**Personal AI assistant you run on your own devices. 100% Free with Ollama.**
 
 ```
-    ___    ____  _______  ______  ____  ______
-   /   |  / __ \/ ____/ |/ / __ )/ __ \/_  __/
-  / /| | / /_/ / __/  |   / __  / / / / / /   
- / ___ |/ ____/ /___ /   / /_/ / /_/ / / /    
-/_/  |_/_/   /_____//_/|_/_____/\____/ /_/    
-                                               
-       Your Free AI Assistant
+   /\   /\
+  //\\_//\\  ✦ ApexBot
+  \_◕ ◕_/   Local AI Assistant
+   /   \   
 ```
 
-[![CI](https://github.com/YOUR_USERNAME/apexbot/actions/workflows/ci.yml/badge.svg)](https://github.com/YOUR_USERNAME/apexbot/actions)
-[![npm package](https://badge.fury.io/js/apexbot.svg)](https://www.npmjs.com/package/apexbot)
-[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue.svg)](https://www.typescriptlang.org/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![Ollama](https://img.shields.io/badge/AI-Ollama-orange.svg)](https://ollama.com)
 
-100% Free | Open Source | Private | Self-Hosted
-
-[Installation](#installation) |
-[Features](#features) |
-[Quick Start](#quick-start) |
-[Commands](#commands) |
-[Contributing](#contributing)
-
----
-
-## Installation
-
-Runtime: Node 18+
-
-### npm (recommended)
-
-```bash
-npm install -g apexbot
-apexbot onboard
-```
-
-### One-line install
-
-Windows (PowerShell):
-
-```powershell
-iwr -useb https://raw.githubusercontent.com/YOUR_USERNAME/apexbot/main/scripts/install.ps1 | iex
-```
-
-macOS/Linux:
-
-```bash
-curl -fsSL https://raw.githubusercontent.com/YOUR_USERNAME/apexbot/main/scripts/install.sh | bash
-```
-
-### From source
-
-```bash
-git clone https://github.com/YOUR_USERNAME/apexbot.git
-cd apexbot
-npm install
-npm run build
-npm run onboard
-```
+**100% Free** | **Open Source** | **Private** | **Local-First**
 
 ---
 
-## Features
-
-### Local AI with Ollama
-
-ApexBot runs AI models locally on your machine using Ollama. No API keys, no cloud costs, complete privacy.
-
-- **Free**: No subscriptions or usage fees
-- **Private**: Conversations never leave your computer
-- **Offline**: Works without internet after model download
-- **Models**: llama3.2, mistral, codellama, qwen2.5, and more
-
-### Multi-channel support
-
-| Channel    | Status   | Description            |
-|------------|----------|------------------------|
-| Telegram   | Ready    | Full bot integration   |
-| Discord    | Ready    | Guilds and DMs         |
-| WebChat    | Ready    | Built-in web dashboard |
-| WhatsApp   | Planned  | Via Baileys            |
-
-### AI providers
-
-| Provider         | Cost    | Notes                      |
-|------------------|---------|----------------------------|
-| **Ollama**       | Free    | Local AI (recommended)     |
-| Google Gemini    | Free tier | Cloud API               |
-| Anthropic Claude | Paid    | Cloud API                  |
-| OpenAI GPT       | Paid    | Cloud API                  |
+## ✨ Features
+
+### 🤖 Local AI (Ollama)
+- **Free** - No API costs, no subscriptions
+- **Private** - Data never leaves your machine
+- **Offline** - Works without internet
+- **Models** - llama3.2, mistral, qwen2.5, codellama
+
+### 💬 Multi-Channel Support
+| Channel | Status | Description |
+|---------|--------|-------------|
+| CLI | ✅ Ready | Terminal chat with shortcuts |
+| Telegram | ✅ Ready | Full bot integration |
+| Discord | ✅ Ready | Guilds and DMs |
+| WhatsApp | ✅ Ready | Via Baileys |
+| WebChat | ✅ Ready | Built-in dashboard |
+| Slack | ✅ Ready | Workspace integration |
+| Signal | ✅ Ready | Secure messaging |
+| Matrix | ✅ Ready | Decentralized chat |
+
+### 🧠 Brain System
+- Personality profiles (SOUL files)
+- Long-term memory with vector store
+- Context-aware responses
+- Lobster Engine for reasoning
+
+### 🛠️ 30+ Skills
+
+| Category | Skills |
+|----------|--------|
+| **Communication** | Telegram, WhatsApp, Discord, Slack, Signal, iMessage, Matrix, Twitter, Gmail |
+| **Productivity** | Obsidian, Notion, Trello, GitHub, Calendar, Reminders, Apple Notes |
+| **Media** | Spotify, Sonos, Voice/TTS, Image Gen, GIF Search |
+| **Smart Home** | Home Assistant, Philips Hue |
+| **Automation** | Browser, Cron, 1Password, Weather, Search, System |
+
+### ⌨️ Claude Code Style CLI
+
+**Input Prefixes:**
+| Prefix | Action | Example |
+|--------|--------|---------|
+| `!` | Bash command | `!ls -la` |
+| `/` | Bot commands | `/help` |
+| `@` | File reference | `@src/index.ts` |
+| `&` | Background task | `&npm test` |
+
+**Keyboard Shortcuts:**
+- `Ctrl+C` - Exit
+- `Ctrl+L` - Clear screen
+- `↑↓` - History navigation
+- `\+Enter` - Multi-line input
+
+### 🌐 Web Dashboard
+- Real-time chat interface
+- **File upload** (images, code, files)
+- Session management
+- Channel status monitoring
+- System logs
 
 ---
 
-## Quick Start
+## 🚀 Quick Start
 
 ### 1. Install Ollama
 
-Windows:
-
-```powershell
+```bash
+# Windows
 winget install Ollama.Ollama
-```
 
-macOS:
-
-```bash
+# macOS
 brew install ollama
-```
-
-Linux:
 
-```bash
+# Linux
 curl -fsSL https://ollama.com/install.sh | sh
 ```
 
@@ -124,165 +100,159 @@ ollama pull llama3.2
 ollama serve
 ```
 
-### 3. Install ApexBot
-
-```bash
-npm install -g apexbot
-```
-
-### 4. Run setup
-
-```bash
-apexbot onboard
-```
-
-The wizard walks you through AI provider selection, channel setup (Telegram/Discord), and configuration.
-
-### 5. Start the bot
-
-```bash
-apexbot daemon start
-```
-
-Your assistant is now running in the background.
-
----
-
-## Commands
-
-### CLI
+### 3. Install & Run ApexBot
 
 ```bash
-# Setup
-apexbot onboard            # Interactive setup wizard
-apexbot config             # Show configuration
-apexbot config --reset     # Reset configuration
-
-# Daemon (background)
-apexbot daemon start       # Start in background
-apexbot daemon stop        # Stop daemon
-apexbot daemon restart     # Restart daemon
-apexbot daemon status      # Check status
-
-# Gateway (foreground)
-apexbot gateway            # Start gateway server
-apexbot gateway --verbose  # With debug output
-
-# Utilities
-apexbot status             # Show status
-apexbot models             # Manage Ollama models
-```
-
-### Chat commands
-
-| Command        | Description              |
-|----------------|--------------------------|
-| `/help`        | Show available commands  |
-| `/status`      | Show session info        |
-| `/new`         | Start new conversation   |
-| `/model <name>`| Switch AI model          |
+# Clone
+git clone https://github.com/emes789/apexbot.git
+cd apexbot
 
----
+# Install
+npm install
 
-## Architecture
+# Setup (interactive)
+npx ts-node src/cli/index.ts onboard
 
-```
-Messaging Channels
-Telegram | Discord | WebChat | WhatsApp
-         |         |         |
-         v         v         v
-+----------------------------------------+
-|            Gateway Server              |
-|       (HTTP + WebSocket :18789)        |
-+----------------------------------------+
-|  Sessions  |  Event Bus  |  Rate Limit |
-+----------------------------------------+
-                   |
-                   v
-+----------------------------------------+
-|           AI Agent Manager             |
-|    Ollama | Gemini | Claude | OpenAI   |
-+----------------------------------------+
+# Start chat
+npx ts-node src/cli/index.ts chat
 ```
 
 ---
 
-## Project Structure
+## 📁 Project Structure
 
 ```
 apexbot/
-  src/
-    adapters/       Provider integrations (Manifold, etc.)
-    agent/          AI agent manager and message handling
-    backtest/       Backtesting framework
-    channels/       Channel adapters (Telegram, Discord)
-    cli/            Command-line interface
-    core/           Event bus and shared utilities
-    gateway/        HTTP/WebSocket server and dashboard
-    math/           Expected value and Kelly criterion
-    safety/         Rate limiting and content filtering
-    sessions/       Conversation state management
-    strategy/       Trading strategies (arbitrage)
-  scripts/
-    install.ps1     Windows installer
-    install.sh      Unix installer
+├── src/
+│   ├── agent/        # AI agent manager
+│   ├── brain/        # Personality & memory
+│   ├── channels/     # Telegram, Discord, etc.
+│   ├── cli/          # Terminal interface
+│   ├── gateway/      # HTTP/WebSocket server
+│   ├── lobster/      # Reasoning engine
+│   ├── memory/       # Vector store
+│   ├── sessions/     # Conversation state
+│   ├── skills/       # 30+ integrations
+│   ├── safety/       # Rate limiting
+│   └── tools/        # Tool registry
+├── scripts/          # Install scripts
+└── docs/             # Documentation
 ```
 
 ---
 
-## Configuration
+## ⚙️ Configuration
 
-Configuration lives in `~/.apexbot/config.json`:
+Config file: `~/.apexbot/config.json`
 
 ```json
 {
-  "gateway": {
-    "port": 18789
-  },
+  "gateway": { "port": 18789 },
   "agent": {
     "provider": "ollama",
     "apiUrl": "http://localhost:11434",
-    "model": "llama3.2"
+    "model": "llama3.2",
+    "enableTools": true
   },
   "channels": {
-    "telegram": {
-      "token": "your-bot-token"
-    }
+    "telegram": { "enabled": true, "token": "..." },
+    "discord": { "enabled": true, "token": "..." }
   }
 }
 ```
 
-Environment variables also work:
+### AI Providers
+
+| Provider | Cost | Notes |
+|----------|------|-------|
+| **Ollama** | Free | Local, recommended |
+| Google Gemini | Free tier | Cloud API |
+| Anthropic Claude | Paid | Cloud API |
+| OpenAI GPT | Paid | Cloud API |
+| Kimi | Free tier | Cloud API |
+
+---
+
+## 🔧 CLI Commands
 
 ```bash
-export OLLAMA_URL=http://localhost:11434
-export OLLAMA_MODEL=llama3.2
-export TELEGRAM_BOT_TOKEN=your-token
+# Interactive setup
+npx ts-node src/cli/index.ts onboard
+
+# Terminal chat
+npx ts-node src/cli/index.ts chat
+
+# Start gateway server
+npx ts-node src/cli/index.ts gateway
+
+# Check status
+npx ts-node src/cli/index.ts status
 ```
 
+### Chat Commands
+
+| Command | Description |
+|---------|-------------|
+| `/help` | Show commands |
+| `/status` | Session info |
+| `/reset` | Clear history |
+| `/model <name>` | Switch model |
+| `/skills` | List skills |
+| `/tools` | List tools |
+| `/fox` | Show mascot 🦊 |
+
 ---
 
-## Contributing
+## 📊 Architecture
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+```
+┌─────────────────────────────────────────────┐
+│              Messaging Channels              │
+│  Telegram │ Discord │ WhatsApp │ CLI │ Web  │
+└────────────────────┬────────────────────────┘
+                     │
+┌────────────────────▼────────────────────────┐
+│           Gateway Server (:18789)            │
+│     HTTP API │ WebSocket │ Dashboard         │
+└────────────────────┬────────────────────────┘
+                     │
+┌────────────────────▼────────────────────────┐
+│               Orchestrator                   │
+│  Sessions │ Event Bus │ Rate Limit │ Safety │
+└────────────────────┬────────────────────────┘
+                     │
+       ┌─────────────┼─────────────┐
+       ▼             ▼             ▼
+┌────────────┐ ┌───────────┐ ┌──────────┐
+│   Brain    │ │   Agent   │ │  Skills  │
+│ Personality│ │  Manager  │ │ 30+ APIs │
+│   Memory   │ │  Ollama   │ │          │
+└────────────┘ └───────────┘ └──────────┘
+```
+
+---
+
+## 🤝 Contributing
 
 ```bash
-git clone https://github.com/YOUR_USERNAME/apexbot.git
+git clone https://github.com/emes789/apexbot.git
 cd apexbot
 npm install
 npm run dev
 ```
 
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
 ---
 
-## License
+## 📄 License
 
 MIT License. See [LICENSE](LICENSE).
 
 ---
 
-## Acknowledgments
+## 🙏 Acknowledgments
 
-- Inspired by [Clawdbot](https://github.com/moltbot/moltbot)
-- Powered by [Ollama](https://ollama.com) for local AI
+- Inspired by [Clawdbot/Moltbot](https://clawd.bot)
+- Powered by [Ollama](https://ollama.com)
 - Built with TypeScript, grammy, discord.js