@xopcai/xopcbot 0.1.3 → 0.2.0

package/README.md

@@ -1,7 +1,5 @@
 # 🐈 xopcbot: Ultra-Lightweight Personal AI Assistant
 
-[中文](./README.zh-CN.md) | English
-
 <div align="center">
   <p>
     <strong>An ultra-lightweight, plugin-driven personal AI assistant built with Node.js and TypeScript.</strong>
@@ -16,106 +14,113 @@
     <a href="#">
       <img src="https://img.shields.io/badge/Node-%3E%3D22.0.0-brightgreen" alt="Node">
     </a>
-    <a href="#">
-      <img src="https://img.shields.io/badge/TypeScript-5.x-blue" alt="TypeScript">
-    </a>
     <a href="#">
       <img src="https://img.shields.io/badge/License-MIT-green" alt="License">
     </a>
   </p>
 </div>
 
-**xopcbot** provides the core functionality of a personal AI agent in a minimal footprint (~6,000 lines of TypeScript). It's designed to be simple, extensible, and easy to understand.
+## ✨ What can xopcbot do?
 
-## ✨ Features
+xopcbot is your personal AI assistant that runs locally. It can help you with:
 
-- **🤖 Unified LLM API** - Supports 20+ providers (OpenAI, Anthropic, Google, Groq, DeepSeek, MiniMax, Qwen, Kimi, etc.)
-- **🔌 Extensible Plugins** - Add custom tools, hooks, and commands with hot-reloading
-- **📱 Multi-Channel Support** - Telegram, WhatsApp, Feishu/Lark, or Web UI
-- **🧠 Persistent Memory** - Conversation history with automatic context compaction
-- **📂 Session Management** - Browse, search, archive, and manage conversations via CLI or Web UI
-- **🔧 Rich Built-in Tools** - Filesystem, shell, web search, grep, find, edit, and more
-- **⏰ Scheduled Tasks** - Cron-based automation
-- **🖥️ Powerful CLI** - Manage agent, config, and plugins from command line
-- **🌐 Modern Web UI** - Chat, sessions, cron, subagents, logs, and settings
+| Use Case | Example |
+|----------|---------|
+| **Coding assistant** | Debug code, explain snippets, write functions |
+| **Task automation** | Schedule recurring tasks with cron |
+| **File operations** | Search, read, edit files in your workspace |
+| **Web research** | Search the web and summarize results |
+| **Multi-channel chat** | Talk via Telegram, WhatsApp, Feishu, or Web UI |
+
+```bash
+# Chat interactively in your terminal
+xopcbot agent -i
+
+# Or send a single message
+xopcbot agent -m "Explain what this code does: function foo() { return 42; }"
+
+# Let xopcbot help with a git task
+xopcbot agent -m "Show me the recent commits and create a PR summary"
+```
 
 ---
 
 ## 🚀 Quick Start
 
-### Option 1: Install from npm
+### 1️⃣ Install
 
 ```bash
-# Install globally
+# From npm (recommended)
 npm install -g @xopcai/xopcbot
 
-# Configure (interactive setup)
-xopcbot configure
-
-# Start chatting!
-xopcbot agent -i
+# Or from source
+git clone https://github.com/xopcai/xopcbot.git
+cd xopcbot && npm install && npm build
 ```
 
-### Option 2: Build from source
+### 2️⃣ Setup (interactive wizard)
 
 ```bash
-# Clone and install
-git clone https://github.com/xopcai/xopcbot.git
-cd xopcbot
-pnpm install
+xopcbot onboard
+# or: npm run dev -- onboard
+```
 
-# Configure (interactive setup)
-pnpm run dev -- configure
+The wizard will guide you through:
+- Choosing your preferred AI model (20+ providers supported)
+- Configuring API keys
+- Setting up chat channels (Telegram, WhatsApp, etc.)
 
-# Start chatting!
-pnpm run dev -- agent -i
-```
+> **Tip:** Use `xopcbot onboard --quick` for quick model setup only.
+
+### 3️⃣ Start chatting!
 
-> **Tip:** Run `xopcbot configure` (or `pnpm run dev -- configure`) to set up your LLM provider API key interactively.
+```bash
+# Interactive chat mode
+xopcbot agent -i
+
+# Or use specific channels
+xopcbot agent -m "Hello!" --channel telegram --chat-id 123456
+```
 
 ---
 
 ## 📖 Documentation
 
-Full documentation is available at **[xopcai.github.io/xopcbot](https://xopcai.github.io/xopcbot/)**
-
 | Guide | Description |
 |-------|-------------|
 | [Getting Started](https://xopcai.github.io/xopcbot/getting-started) | Setup and basic usage |
 | [Configuration](https://xopcai.github.io/xopcbot/configuration) | Full config reference |
 | [CLI Reference](https://xopcai.github.io/xopcbot/cli) | All available commands |
 | [Channels](https://xopcai.github.io/xopcbot/channels) | Telegram, WhatsApp, Feishu setup |
-| [Plugins](https://xopcai.github.io/xopcbot/plugins) | Build your own plugins |
 | [Tools](https://xopcai.github.io/xopcbot/tools) | Built-in tools reference |
-| [Architecture](https://xopcai.github.io/xopcbot/architecture) | Under the hood |
 
 ---
 
-## 💬 Supported Channels
+## 🔌 Supported Channels
 
-| Channel | Status | Description |
-|---------|--------|-------------|
-| Telegram | ✅ | Bot API with polling/webhook |
-| WhatsApp | ✅ | Baileys WebSocket |
-| Feishu/Lark | ✅ | WebSocket events |
-| Web UI | ✅ | Modern browser interface |
+| Channel | Status | Install |
+|---------|--------|---------|
+| Telegram | ✅ | [Setup Guide](https://xopcai.github.io/xopcbot/channels#telegram) |
+| WhatsApp | ✅ | [Setup Guide](https://xopcai.github.io/xopcbot/channels#whatsapp) |
+| Feishu/Lark | ✅ | [Setup Guide](https://xopcai.github.io/xopcbot/channels#feishu) |
+| Web UI | ✅ | Built-in, run `xopcbot gateway` |
 
 ---
 
 ## 🛠️ Development
 
 ```bash
-# Development
-pnpm run dev
+# Development (with hot reload)
+npm run dev
 
-# Build
-pnpm run build
+# Build for production
+npm run build
 
-# Test
-pnpm test
+# Run tests
+npm test
 
 # Lint
-pnpm run lint
+npm run lint
 ```
 
 ---

package/README.zh-CN.md

@@ -14,106 +14,113 @@
     <a href="#">
       <img src="https://img.shields.io/badge/Node-%3E%3D22.0.0-brightgreen" alt="Node">
     </a>
-    <a href="#">
-      <img src="https://img.shields.io/badge/TypeScript-5.x-blue" alt="TypeScript">
-    </a>
     <a href="#">
       <img src="https://img.shields.io/badge/License-MIT-green" alt="License">
     </a>
   </p>
 </div>
 
-**xopcbot** 以极简的代码量（约 6,000 行 TypeScript）提供个人 AI 代理的核心功能。设计简洁、可扩展、易于理解。
+## ✨ xopcbot 能做什么？
+
+xopcbot 是运行在本地 的个人 AI 助手，可以帮助你：
+
+| 使用场景 | 示例 |
+|----------|------|
+| **编程助手** | 调试代码、解释代码片段、编写函数 |
+| **任务自动化** | 使用 cron 设置定时任务 |
+| **文件操作** | 在工作区中搜索、读取、编辑文件 |
+| **网络搜索** | 搜索网页并总结结果 |
+| **多渠道聊天** | 通过 Telegram、WhatsApp、飞书或网页 UI 交流 |
+
+```bash
+# 在终端中交互式聊天
+xopcbot agent -i
 
-## ✨ 特性
+# 或发送单条消息
+xopcbot agent -m "解释这段代码：function foo() { return 42; }"
 
-- **🤖 统一 LLM API** - 支持 20+ 提供商（OpenAI、Anthropic、Google、Groq、DeepSeek、Minimax、Qwen、Kimi 等）
-- **🔌 可扩展插件** - 支持热加载的自定义工具、钩子和命令
-- **📱 多渠道支持** - Telegram、WhatsApp、飞书/Lark 或 Web UI
-- **🧠 持久记忆** - 对话历史，自动上下文压缩
-- **📂 会话管理** - 通过 CLI 或 Web UI 浏览、搜索、归档和管理对话
-- **🔧 丰富的内置工具** - 文件系统、Shell、Web 搜索、grep、查找、编辑等
-- **⏰ 定时任务** - 基于 Cron 的自动化
-- **🖥️ 强大的 CLI** - 从命令行管理代理、配置和插件
-- **🌐 现代 Web UI** - 聊天、会话、Cron、子代理、日志和设置
+# 让 xopcbot 帮你处理 git 任务
+xopcbot agent -m "查看最近的提交并创建 PR 摘要"
+```
 
 ---
 
 ## 🚀 快速开始
 
-### 方式一：从 npm 安装
+### 1️⃣ 安装
 
 ```bash
-# 全局安装
+# 从 npm 安装（推荐）
 npm install -g @xopcai/xopcbot
 
-# 配置（交互式设置）
-xopcbot configure
-
-# 开始聊天！
-xopcbot agent -i
+# 或从源码构建
+git clone https://github.com/xopcai/xopcbot.git
+cd xopcbot && npm install && npm build
 ```
 
-### 方式二：从源码构建
+### 2️⃣ 配置（交互式向导）
 
 ```bash
-# 克隆并安装
-git clone https://github.com/xopcai/xopcbot.git
-cd xopcbot
-pnpm install
+xopcbot onboard
+# 或: npm run dev -- onboard
+```
 
-# 配置（交互式设置）
-pnpm run dev -- configure
+向导会引导你完成：
+- 选择喜欢的 AI 模型（支持 20+ 提供商）
+- 配置 API 密钥
+- 设置聊天渠道（Telegram、WhatsApp 等）
 
-# 开始聊天！
-pnpm run dev -- agent -i
-```
+> **提示：** 使用 `xopcbot onboard --quick` 可快速设置模型。
+
+### 3️⃣ 开始聊天！
 
-> **提示：** 运行 `xopcbot configure`（或 `pnpm run dev -- configure`）交互式设置 LLM 提供商 API 密钥。
+```bash
+# 交互式聊天模式
+xopcbot agent -i
+
+# 或使用特定渠道
+xopcbot agent -m "你好！" --channel telegram --chat-id 123456
+```
 
 ---
 
 ## 📖 文档
 
-完整文档请访问 **[xopcai.github.io/xopcbot](https://xopcai.github.io/xopcbot/)**
-
 | 指南 | 描述 |
 |------|------|
 | [快速开始](https://xopcai.github.io/xopcbot/getting-started) | 安装和基本用法 |
 | [配置](https://xopcai.github.io/xopcbot/configuration) | 完整配置参考 |
 | [CLI 参考](https://xopcai.github.io/xopcbot/cli) | 所有可用命令 |
 | [渠道](https://xopcai.github.io/xopcbot/channels) | Telegram、WhatsApp、飞书设置 |
-| [插件](https://xopcai.github.io/xopcbot/plugins) | 构建你自己的插件 |
 | [工具](https://xopcai.github.io/xopcbot/tools) | 内置工具参考 |
-| [架构](https://xopcai.github.io/xopcbot/architecture) | 底层实现 |
 
 ---
 
-## 💬 支持的渠道
+## 🔌 支持的渠道
 
-| 渠道 | 状态 | 描述 |
+| 渠道 | 状态 | 安装 |
 |------|------|------|
-| Telegram | ✅ | Bot API，支持轮询/webhook |
-| WhatsApp | ✅ | Baileys WebSocket |
-| 飞书/Lark | ✅ | WebSocket 事件 |
-| Web UI | ✅ | 现代浏览器界面 |
+| Telegram | ✅ | [设置指南](https://xopcai.github.io/xopcbot/channels#telegram) |
+| WhatsApp | ✅ | [设置指南](https://xopcai.github.io/xopcbot/channels#whatsapp) |
+| 飞书/Lark | ✅ | [设置指南](https://xopcai.github.io/xopcbot/channels#feishu) |
+| 网页 UI | ✅ | 内置，运行 `xopcbot gateway` 即可 |
 
 ---
 
 ## 🛠️ 开发
 
 ```bash
-# 开发模式
-pnpm run dev
+# 开发模式（热重载）
+npm run dev
 
-# 构建
-pnpm run build
+# 构建生产版本
+npm run build
 
-# 测试
-pnpm test
+# 运行测试
+npm test
 
 # 代码检查
-pnpm run lint
+npm run lint
 ```
 
 ---

package/dist/agent/__tests__/media-processing.test.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Agent Media Processing Tests
+ *
+ * Tests for media message handling in AgentService.
+ */
+export {};