mozi-bot 1.0.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Mozi Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,467 @@
+# Mozi (墨子)
+
+**支持国产大模型和国产通讯软件的智能助手框架**
+
+Mozi 是一个轻量级的 AI 助手框架，专注于国产生态。它提供统一的接口对接多种国产 AI 模型（DeepSeek、Qwen、Kimi 等），支持 OpenAI Function Calling，并能在飞书、钉钉、WebChat 等平台上运行。
+
+## 与 Moltbot 对比
+
+Mozi 的架构设计参考了 [Moltbot](https://github.com/moltbot/moltbot)，但专注于不同的使用场景。
+
+| 特性 | Mozi | Moltbot |
+|------|------|---------|
+| **定位** | 国产生态优先的轻量框架 | 全功能个人 AI 助手 |
+| **代码量** | ~16,000 行 (64 文件) | ~516,000 行 (3,137 文件) |
+| **国产模型** | ✅ DeepSeek、Qwen、Kimi、阶跃星辰、MiniMax | ❌ 仅 Anthropic、OpenAI |
+| **国产通讯** | ✅ 飞书、钉钉原生支持 | ❌ WhatsApp、Telegram、Slack 等海外平台 |
+| **Node.js 版本** | ≥18 | ≥22 |
+| **资源占用** | 轻量 | 较重（菜单栏应用、语音唤醒等） |
+| **适用场景** | 企业内部机器人、国内团队协作 | 个人多设备助手、海外平台集成 |
+
+> **Mozi 用 3% 的代码量实现了核心功能**，专注简洁高效，易于理解和二次开发。
+
+### 选择 Mozi 的理由
+
+- **国产模型一站式支持** — 无需翻墙，直接对接 DeepSeek、通义千问等国产大模型
+- **飞书/钉钉开箱即用** — 原生支持国内主流办公平台，配置简单
+- **轻量快速** — 专注核心功能，无冗余依赖，启动快、资源占用少
+- **低门槛** — 一个 API Key + 三行配置即可运行，适合快速验证和部署
+- **企业友好** — 适合国内企业内网环境，无外部依赖
+
+### 选择 Moltbot 的理由
+
+- 需要 WhatsApp、Telegram、Discord 等海外平台支持
+- 需要语音唤醒、Live Canvas 等高级交互功能
+- 需要多设备同步、macOS/iOS 深度集成
+- 个人使用场景，设备控制需求
+
+## 核心特性
+
+- **多模型支持** — DeepSeek、ModelScope (Qwen)、Kimi、阶跃星辰、MiniMax，以及 OpenAI/Anthropic 兼容格式
+- **多平台通道** — WebChat、飞书、钉钉，统一的消息处理接口
+- **Function Calling** — 原生支持 OpenAI tools/tool_choice 参数
+- **15+ 内置工具** — 文件读写、Bash 执行、代码搜索、网页获取等
+- **会话管理** — 上下文压缩、会话持久化、Memory 向量记忆
+- **可扩展** — 插件系统、Hook 事件、自定义工具
+
+## 快速开始
+
+### 环境要求
+
+- Node.js >= 18
+- npm / pnpm / yarn
+
+### 1. 安装
+
+```bash
+# 一键安装（推荐）
+npm install -g mozi-bot
+
+# 或者克隆项目
+git clone https://github.com/King-Chau/mozi.git
+cd mozi && npm install && npm run build
+```
+
+### 2. 配置
+
+创建配置文件 `config.local.json5`（会被 git 忽略）：
+
+```json5
+{
+  providers: {
+    // 至少配置一个模型提供商
+    deepseek: {
+      apiKey: "sk-your-deepseek-key"
+    }
+  },
+  agent: {
+    defaultProvider: "deepseek",
+    defaultModel: "deepseek-chat"
+  }
+}
+```
+
+或者使用环境变量：
+
+```bash
+export DEEPSEEK_API_KEY=sk-your-key
+```
+
+### 3. 启动
+
+```bash
+# 启动 WebChat（本地调试）
+npm run dev -- start --web-only
+
+# 或构建后启动
+npm start -- start --web-only
+```
+
+打开浏览器访问 `http://localhost:3000` 即可开始对话。
+
+### 4. 连接通讯平台（可选）
+
+如需连接飞书或钉钉，添加相应配置后启动完整服务：
+
+```bash
+npm start -- start
+```
+
+## 支持的模型提供商
+
+### 国产模型
+
+| 提供商 | 环境变量 | 说明 |
+|--------|----------|------|
+| DeepSeek | `DEEPSEEK_API_KEY` | 推理能力强、性价比高 |
+| DashScope | `DASHSCOPE_API_KEY` | 阿里云灵积，通义千问商业版，稳定高并发 |
+| 智谱 AI | `ZHIPU_API_KEY` | GLM-4 系列，清华技术团队，有免费额度 |
+| ModelScope | `MODELSCOPE_API_KEY` | 阿里云魔搭社区，Qwen 开源版，有免费额度 |
+| Kimi | `KIMI_API_KEY` | Moonshot，长上下文支持（128K/1M） |
+| 阶跃星辰 | `STEPFUN_API_KEY` | Step 系列，多模态能力 |
+| MiniMax | `MINIMAX_API_KEY` | 语音、视觉能力 |
+
+### 海外模型
+
+| 提供商 | 环境变量 | 说明 |
+|--------|----------|------|
+| OpenAI | `OPENAI_API_KEY` | GPT-4o、GPT-4、GPT-3.5 |
+| OpenRouter | `OPENROUTER_API_KEY` | 聚合多家模型，统一 API |
+| Together AI | `TOGETHER_API_KEY` | 开源模型托管，Llama、Mixtral 等 |
+| Groq | `GROQ_API_KEY` | 超快推理速度 |
+
+### 本地部署
+
+| 提供商 | 环境变量 | 说明 |
+|--------|----------|------|
+| Ollama | `OLLAMA_BASE_URL` | 本地运行开源模型 |
+
+### 自定义接口
+
+支持配置任意 OpenAI/Anthropic 兼容的 API 接口，详见「模型提供商配置」章节。
+
+## 配置说明
+
+支持 `config.local.json5`、`config.json5`、`config.yaml` 等格式，优先级从高到低。
+
+### 模型提供商配置
+
+所有内置提供商都支持自定义模型配置：
+
+```json5
+{
+  providers: {
+    // 内置提供商 - 直接配置 apiKey 即可使用预设模型
+    deepseek: {
+      apiKey: "sk-xxx"
+    },
+
+    // 内置提供商 + 自定义模型列表
+    dashscope: {
+      apiKey: "sk-xxx",
+      models: [
+        {
+          id: "qwen-max-latest",
+          name: "通义千问 Max",
+          contextWindow: 32768,
+          maxTokens: 8192
+        },
+        {
+          id: "qwen-plus-latest",
+          name: "通义千问 Plus",
+          contextWindow: 131072,
+          maxTokens: 8192
+        }
+      ]
+    },
+
+    // 自定义 OpenAI 兼容接口
+    "custom-provider": {
+      id: "my-provider",
+      name: "My Provider",
+      baseUrl: "https://api.example.com/v1",
+      apiKey: "xxx",
+      models: [
+        {
+          id: "model-id",
+          name: "Model Name",
+          contextWindow: 32768,
+          maxTokens: 4096,
+          supportsVision: false,
+          supportsTools: true
+        }
+      ]
+    }
+  }
+}
+```
+
+### 通讯平台配置
+
+飞书和钉钉都支持两种连接模式：
+
+| 模式 | 说明 | 适用场景 |
+|------|------|----------|
+| **长连接（默认）** | WebSocket/Stream 主动连接，无需公网 IP | 内网部署、本地开发 |
+| Webhook | 被动接收回调，需要公网可访问地址 | 公网服务器部署 |
+
+```json5
+{
+  channels: {
+    // 飞书配置
+    feishu: {
+      appId: "cli_xxx",
+      appSecret: "xxx",
+      mode: "websocket"  // "websocket"（默认）或 "webhook"
+    },
+
+    // 钉钉配置
+    dingtalk: {
+      appKey: "xxx",
+      appSecret: "xxx",
+      mode: "stream"  // "stream"（默认）或 "webhook"
+    }
+  }
+}
+```
+
+> **推荐使用长连接模式**：无需公网 IP，无需配置回调地址，启动即可接收消息。
+
+### 完整配置示例
+
+```json5
+{
+  // 模型提供商配置
+  providers: {
+    deepseek: {
+      apiKey: "sk-xxx"
+    },
+    dashscope: {
+      apiKey: "sk-xxx"  // 阿里云灵积 API Key
+    },
+    zhipu: {
+      apiKey: "xxx"  // 智谱 API Key
+    },
+    modelscope: {
+      apiKey: "ms-xxx"
+    }
+  },
+
+  // 通讯平台配置（长连接模式，无需公网）
+  channels: {
+    feishu: {
+      appId: "cli_xxx",
+      appSecret: "xxx",
+      mode: "websocket"  // 默认值，可省略
+    },
+    dingtalk: {
+      appKey: "xxx",
+      appSecret: "xxx",
+      mode: "stream"  // 默认值，可省略
+    }
+  },
+
+  // Agent 配置
+  agent: {
+    defaultProvider: "deepseek",
+    defaultModel: "deepseek-chat",
+    temperature: 0.7,
+    maxTokens: 4096,
+    systemPrompt: "你是墨子，一个智能助手。"
+  },
+
+  // 服务器配置
+  server: {
+    port: 3000,
+    host: "0.0.0.0"
+  },
+
+  // 日志级别
+  logging: {
+    level: "info"  // debug | info | warn | error
+  }
+}
+```
+
+## 内置工具
+
+| 类别 | 工具 | 说明 |
+|------|------|------|
+| 文件 | `read_file` | 读取文件内容 |
+| | `write_file` | 写入/创建文件 |
+| | `edit_file` | 精确字符串替换 |
+| | `list_directory` | 列出目录内容 |
+| | `glob` | 按模式搜索文件 |
+| | `grep` | 按内容搜索文件 |
+| | `apply_patch` | 应用 diff 补丁 |
+| 命令 | `bash` | 执行 Bash 命令 |
+| | `process` | 管理后台进程 |
+| 网络 | `web_search` | 网络搜索 |
+| | `web_fetch` | 获取网页内容 |
+| 其他 | `current_time` | 获取当前时间 |
+| | `calculator` | 数学计算 |
+
+## 平台配置
+
+### 飞书
+
+#### 长连接模式（推荐）
+
+无需公网 IP，适合内网部署和本地开发：
+
+1. 登录 [飞书开放平台](https://open.feishu.cn/)，创建企业自建应用
+2. 获取 App ID 和 App Secret
+3. 启用「机器人」能力
+4. 添加权限：`im:message`、`im:message.group_at_msg`
+5. 进入「事件订阅」，将订阅方式设置为「使用长连接接收事件」
+6. 添加事件：`im.message.receive_v1`（接收消息）
+7. 配置完成，启动服务即可
+
+```json5
+{
+  channels: {
+    feishu: {
+      appId: "cli_xxx",
+      appSecret: "xxx"
+      // mode: "websocket" 是默认值，可省略
+    }
+  }
+}
+```
+
+#### Webhook 模式
+
+需要公网可访问地址：
+
+1. 完成上述步骤 1-4
+2. 配置事件订阅地址：`http://your-server:3000/webhook/feishu`
+3. 订阅事件：`im.message.receive_v1`
+
+```json5
+{
+  channels: {
+    feishu: {
+      appId: "cli_xxx",
+      appSecret: "xxx",
+      mode: "webhook"
+    }
+  }
+}
+```
+
+### 钉钉
+
+#### 长连接模式（推荐）
+
+无需公网 IP，使用官方 Stream SDK：
+
+1. 登录 [钉钉开放平台](https://open.dingtalk.com/)，创建企业内部应用
+2. 获取 AppKey 和 AppSecret
+3. 添加「机器人」能力
+4. 在机器人配置页面，消息接收模式选择「Stream 模式」
+5. 配置完成，启动服务即可
+
+```json5
+{
+  channels: {
+    dingtalk: {
+      appKey: "xxx",
+      appSecret: "xxx"
+      // mode: "stream" 是默认值，可省略
+    }
+  }
+}
+```
+
+#### Webhook 模式
+
+需要公网可访问地址：
+
+1. 完成上述步骤 1-3
+2. 配置消息接收地址：`http://your-server:3000/webhook/dingtalk`
+
+```json5
+{
+  channels: {
+    dingtalk: {
+      appKey: "xxx",
+      appSecret: "xxx",
+      mode: "webhook"
+    }
+  }
+}
+```
+
+## CLI 命令
+
+```bash
+# 启动服务
+mozi start              # 完整服务（含飞书/钉钉）
+mozi start --web-only   # 仅 WebChat
+mozi start --port 8080  # 指定端口
+
+# 查看日志
+mozi logs               # 查看最新日志（默认 50 行）
+mozi logs -n 100        # 查看最新 100 行
+mozi logs -f            # 实时跟踪日志（类似 tail -f）
+mozi logs --level error # 只显示错误日志
+
+# 其他命令
+mozi check              # 检查配置
+mozi models             # 列出可用模型
+mozi chat               # 命令行聊天
+```
+
+> 日志文件存储在 `~/.mozi/logs/` 目录下，按日期自动轮转。
+
+## 项目结构
+
+```
+src/
+├── agents/        # Agent 核心（会话、上下文压缩）
+├── channels/      # 通道适配器（飞书、钉钉）
+├── providers/     # 模型提供商
+├── tools/         # 内置工具
+├── web/           # WebChat 前端
+├── config/        # 配置加载
+├── gateway/       # HTTP 网关
+└── types/         # 类型定义
+```
+
+## API 使用
+
+```typescript
+import { loadConfig, initializeProviders, getProvider } from "mozi";
+
+const config = loadConfig();
+initializeProviders(config);
+
+const provider = getProvider("deepseek");
+const response = await provider.chat({
+  model: "deepseek-chat",
+  messages: [{ role: "user", content: "你好！" }],
+});
+
+console.log(response.content);
+```
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=King-Chau/mozi&type=Date)](https://star-history.com/#King-Chau/mozi&Date)
+
+## 开发
+
+```bash
+# 开发模式（自动重启）
+npm run dev -- start --web-only
+
+# 类型检查
+npm run typecheck
+
+# 构建
+npm run build
+```
+
+## License
+
+Apache 2.0