nexum-code 0.6.14 → 0.6.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,322 +1,114 @@
1
- <p align="center">
2
- <img width="108" height="108" alt="Nexum Code" src="https://github.com/user-attachments/assets/26b707fa-1fd7-4dda-8484-e8c6b0bd7523" />
3
- </p>
4
-
5
- <h1 align="center">Nexum Code</h1>
6
-
7
- <p align="center">
8
- <strong>一个真正为中文工作流设计的本地 AI Agent 工作台</strong>
9
- </p>
10
-
11
- <p align="center">
12
- 不只是会写代码的终端助手。Nexum Code 把目标循环、长期记忆、多 Agent 协同、MCP 扩展、后端 API 和远程聊天控制放进同一个本地运行的系统里,让 AI 可以稳定地替你执行复杂任务,也可以作为 Web 端智能体系统的底座。
13
- </p>
14
-
15
- <p align="center">
16
- <a href="https://www.npmjs.com/package/nexum-code"><img src="https://img.shields.io/npm/v/nexum-code?style=for-the-badge&logo=npm&logoColor=white&color=111827" alt="npm version"></a>
17
- <a href="https://www.npmjs.com/package/nexum-code"><img src="https://img.shields.io/npm/dm/nexum-code?style=for-the-badge&logo=npm&logoColor=white&color=2563eb" alt="npm downloads"></a>
18
- <a href="https://github.com/Hsssliu/nexum-code/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Hsssliu/nexum-code?style=for-the-badge&color=0f766e" alt="license"></a>
19
- <a href="https://nodejs.org"><img src="https://img.shields.io/badge/Node.js-%3E%3D22-16a34a?style=for-the-badge&logo=node.js&logoColor=white" alt="node version"></a>
20
- </p>
21
-
22
- <p align="center">
23
- <a href="https://nexum.chat">官网</a>
24
- ·
25
- <a href="#快速开始">快速开始</a>
26
- ·
27
- <a href="#核心优势">核心优势</a>
28
- <a href="#系统架构">系统架构</a>
29
- ·
30
- <a href="#web-端智能体底座">Web 智能体</a>
31
- ·
32
- <a href="#远程控制">远程控制</a>
33
- </p>
34
-
35
- ---
36
-
37
- ## 一句话介绍
38
-
39
- Nexum Code 是一个本地优先的 AI Agent 系统。你可以用中文或英文直接下达目标,它会读取项目、编辑文件、运行命令、调用工具、拆分任务、记录记忆,并在需要时通过审批面板保护你的机器。它也可以通过后端服务和 Node SDK 接入 Web 产品,构建网页端智能体、工作台、自动化平台或企业内部 Agent 系统。
40
-
41
- 它适合这些场景:
42
-
43
- - 写代码、改项目、跑测试、整理仓库
44
- - 查资料、读文档、写报告、做研究
45
- - 让多个子 Agent 并行处理复杂任务
46
- - 把常用工作流沉淀成 Skill
47
- - 接到自己的后端,做 Web 端智能体系统
48
- - 通过微信、飞书、钉钉等聊天入口远程控制本地 Agent
49
-
50
- ---
51
-
52
- ## 核心优势
53
-
54
- <table>
55
- <tr>
56
- <td width="50%">
57
- <h3>目标驱动,不是空转循环</h3>
58
- <p>Nexum Code 内置 Goal 系统。你给出目标后,它会围绕目标持续推进,并由独立裁判判断是否完成,支持轮次、Token 和时间预算。</p>
59
- </td>
60
- <td width="50%">
61
- <h3>多 Agent 并行协作</h3>
62
- <p>Wolfpack 模式可以把复杂任务拆给多个子 Agent 并行执行。探索、编码、规划、验证、写作可以分工处理,适合多文件、多步骤的大任务。</p>
63
- </td>
64
- </tr>
65
- <tr>
66
- <td width="50%">
67
- <h3>长期记忆,不靠聊天记录硬撑</h3>
68
- <p>记忆系统支持 SQLite、FTS5 全文检索、Tag 归类和向量检索。它能跨会话保留偏好、约定、项目经验和反复出现的痛点。</p>
69
- </td>
70
- <td width="50%">
71
- <h3>本地运行,权限可控</h3>
72
- <p>文件写入、命令执行、敏感路径访问都会经过权限策略。默认安全,必要时可切换模式,让效率和控制感都在线。</p>
73
- </td>
74
- </tr>
75
- <tr>
76
- <td width="50%">
77
- <h3>MCP / Skill / 插件扩展</h3>
78
- <p>你可以连接数据库、浏览器、API、代码工具,也可以把自己的流程封装成 Skill。Nexum Code 更像一个可扩展的本地 Agent 底座。</p>
79
- </td>
80
- <td width="50%">
81
- <h3>可接后端和 Web 端</h3>
82
- <p>内置服务端 API 和 Node SDK,可以把会话、子 Agent、提示、取消、模型切换、权限控制等能力接入自己的 Web 应用。</p>
83
- </td>
84
- </tr>
85
- <tr>
86
- <td width="50%">
87
- <h3>中文体验优先</h3>
88
- <p>从配置、审批、提示到常用命令都围绕中文用户设计。不是把英文工具翻译一遍,而是从使用习惯上降低门槛。</p>
89
- </td>
90
- <td width="50%">
91
- <h3>终端、服务端、远程入口统一</h3>
92
- <p>同一套 Agent Core 可以跑在 TUI、后端服务和远程聊天入口后面。你可以先自己用,再把它产品化给团队使用。</p>
93
- </td>
94
- </tr>
95
- </table>
96
-
97
- ---
98
-
99
- ## 快速开始
100
-
101
- ### 环境要求
102
-
103
- - Node.js >= 22.0.0
104
- - Git
105
- - 一个可用的模型服务,例如 DeepSeek、OpenAI、Anthropic、通义千问、硅基流动或任何 OpenAI-compatible API
106
-
107
- ### npm 安装
108
-
109
- ```bash
110
- npm install -g nexum-code
111
- ```
112
-
113
- 安装完成后,启动 Nexum:
114
-
115
- ```bash
116
- nexum
117
- ```
118
-
119
- ### macOS / Linux 一键安装
120
-
121
- ```bash
122
- curl -fsSL https://raw.githubusercontent.com/Hsssliu/nexum-code/main/install.sh | bash
123
- ```
124
-
125
- ### Windows PowerShell 一键安装
126
-
127
- ```powershell
128
- irm https://raw.githubusercontent.com/Hsssliu/nexum-code/main/install.ps1 | iex
129
- ```
130
-
131
- 首次启动时,如果还没有配置模型,Nexum Code 会进入交互式配置向导。你也可以随时输入:
132
-
133
- ```text
134
- /config
135
- ```
136
-
137
- 配置完成后,用下面的命令切换模型:
138
-
139
- ```text
140
- /model
141
- ```
142
-
143
- ---
144
-
145
- ## 你可以怎么用
146
-
147
- ```text
148
- 帮我理解这个项目的架构,并指出最重要的入口文件
149
- ```
150
-
151
- ```text
152
- 修复 pnpm test 里的失败用例,改完后再跑一遍验证
153
- ```
154
-
155
- ```text
156
- /goal 在不破坏现有 API 的前提下,把这套工具调用逻辑整理清楚,并补上必要测试
157
- ```
158
-
159
- ```text
160
- /memory 记住:这个项目优先使用 pnpm,不要引入不必要的新依赖
161
- ```
162
-
163
- ```text
164
- /wolfpack 帮我并行检查 README、安装脚本、CLI 参数和服务端 API 是否一致
165
- ```
166
-
167
- ---
168
-
169
- ## 能力地图
170
-
171
- | 能力 | Nexum Code 做什么 |
172
- |---|---|
173
- | 对话式执行 | 用自然语言描述任务,自动读文件、改代码、跑命令 |
174
- | 审批面板 | 修改文件和执行命令前展示审批,降低误操作风险 |
175
- | 权限策略 | 支持默认模式、计划模式、自动模式、YOLO 模式等 |
176
- | Goal 循环 | 目标驱动的多轮执行,支持预算和完成度裁决 |
177
- | 多 Agent | 子 Agent 并行处理探索、编码、验证、写作等任务 |
178
- | 记忆系统 | 跨会话沉淀偏好、项目经验、问题记录和工作约定 |
179
- | MCP 扩展 | 连接外部工具、数据库、浏览器、内部 API 等能力 |
180
- | Skill 系统 | 把常用流程封装成可复用技能 |
181
- | 后端 API | 通过服务端接口创建会话、发送提示、控制 Agent 和读取状态 |
182
- | Node SDK | 在自己的 Node 后端里集成 Nexum Agent 能力 |
183
- | Web 智能体 | 可作为网页端 Agent 工作台、企业自动化系统或内部 Copilot 底座 |
184
- | 后台任务 | 支持长任务、后台命令和任务输出读取 |
185
- | 会话恢复 | 中断后继续,支持历史记录、分叉、导出和撤销 |
186
- | 远程聊天 | 通过 cc-connect 接入微信、飞书、钉钉、Slack 等平台 |
187
-
188
- ---
189
-
190
- ## 系统架构
191
-
192
- 这个仓库是一个 TypeScript monorepo,核心模块大致如下:
193
-
194
- ```text
195
- aiflowy-agent/
196
- apps/
197
- nexum-code/ # 终端入口与 TUI
198
- nexum-agent-server/ # Agent 服务入口
199
- packages/
200
- agent-core/ # Agent 循环、工具、权限、会话、MCP、LSP
201
- node-sdk/ # Node SDK 与 RPC 客户端
202
- nexum-server/ # HTTP API 与会话控制
203
- memory/ # 长期记忆、检索、整理
204
- ltod/ # 模型与工具调用抽象
205
- jian/ # 本地运行时能力封装
206
- config/ # 共享配置与身份信息
207
- ```
208
-
209
- 关键设计思路:
210
-
211
- - `agent-core` 负责 Agent 的大脑,包括工具注册、权限评估、执行循环、子 Agent 和会话状态。
212
- - `nexum-code` 负责终端用户体验,包括命令、审批面板、消息渲染和交互状态。
213
- - `nexum-server` 和 `node-sdk` 让 Nexum 不只存在于终端,也能被后端服务、Web 应用、桌面端或其他客户端驱动。
214
- - `memory` 独立成包,避免记忆能力被某一次会话绑定,方便跨项目和跨场景复用。
215
-
216
- ---
217
-
218
- ## Web 端智能体底座
219
-
220
- Nexum Code 不是只能在终端里跑。它的核心能力已经拆成可复用的服务端和 SDK 层,适合接入自己的产品后端。
221
-
222
- 你可以用它构建:
223
-
224
- - Web 端 AI 编程助手
225
- - 企业内部 Agent 工作台
226
- - 自动化任务执行平台
227
- - 多 Agent 协作系统
228
- - 带记忆、权限和会话恢复的私有 Copilot
229
-
230
- 后端可以围绕这些能力组织业务:
231
-
232
- | 能力 | 适合做成什么产品功能 |
233
- |---|---|
234
- | Session API | 创建会话、恢复会话、分叉会话、导出会话 |
235
- | Agent API | 发送任务、取消任务、切换模型、调整思考和权限模式 |
236
- | Subagent Host | 在 Web 端展示多个子 Agent 的并行执行状态 |
237
- | Permission System | 做企业级审批、敏感操作拦截和审计记录 |
238
- | Memory Store | 做用户偏好、项目知识库和跨会话上下文 |
239
- | MCP / Skill | 给 Web 产品接入数据库、浏览器、内部系统和自定义流程 |
240
-
241
- 这意味着 Nexum Code 可以从“一个本地工具”升级成“你的 Agent 产品底座”:前端负责交互,后端负责业务权限和数据,Nexum 负责智能体执行、工具调度、记忆和多 Agent 编排。
242
-
243
- ---
244
-
245
- ## 常用命令
246
-
247
- | 命令 | 说明 |
248
- |---|---|
249
- | `/config` | 配置模型服务 |
250
- | `/model` | 切换或管理模型 |
251
- | `/memory` | 打开记忆管理 |
252
- | `/dream` | 整理重复或过期记忆 |
253
- | `/goal` | 开启目标循环 |
254
- | `/wolfpack` | 开启多 Agent 协作 |
255
- | `/cc-connect` | 配置聊天平台远程控制 |
256
- | `/mode` | 查看或切换权限模式 |
257
-
258
- 开发仓库时常用:
259
-
260
- ```bash
261
- pnpm install
262
- pnpm run dev:cli
263
- pnpm run typecheck
264
- pnpm run lint
265
- pnpm run test
266
- pnpm run build
267
- ```
268
-
269
- ---
270
-
271
- ## 远程控制
272
-
273
- Nexum Code 可以通过 `cc-connect` 接入聊天平台。配置后,即使终端不在眼前,也能在聊天窗口里创建会话、发送任务、上传文件和切换模式。
274
-
275
- ```bash
276
- npm install -g cc-connect
277
- ```
278
-
279
- 在 Nexum Code 中启动配置:
280
-
281
- ```text
282
- /cc-connect
283
- ```
284
-
285
- 常用远程指令:
286
-
287
- | 指令 | 用途 |
288
- |---|---|
289
- | `/new` | 创建新会话 |
290
- | `/bind setup` | 开启文件传送,支持图片、PDF 等 |
291
- | `/mode` | 查看可用模式 |
292
- | `/mode yolo` | 自动批准所有工具调用 |
293
- | `/mode default` | 每次工具调用前询问 |
294
-
295
- ---
296
-
297
- ## 为什么做 Nexum Code
298
-
299
- 我想要的不是一个只会补全代码的工具,而是一个能长期陪我处理真实工作流的本地 Agent:
300
-
301
- - 它要能记住项目里的约定,而不是每次从零开始。
302
- - 它要能拆任务、分工、验证,而不是只会单线程聊天。
303
- - 它要能接入我已有的工具和聊天入口,而不是把我锁在一个界面里。
304
- - 它要尊重本地机器的安全边界,而不是为了方便牺牲控制权。
305
-
306
- 所以 Nexum Code 选择了 TypeScript monorepo、本地优先、权限策略、长期记忆、多 Agent 和可扩展工具系统这条路线。它不是功能堆叠,而是把高频 Agent 工作流收敛成一个稳定的底座。
307
-
308
- ---
309
-
310
- ## 项目链接
311
-
312
- - 官网:https://nexum.chat
313
- - npm:https://www.npmjs.com/package/nexum-code
314
- - 许可证:[MIT](LICENSE)
315
-
316
- ---
317
-
318
- <p align="center">
319
- <strong>Nexum Code</strong>
320
- <br />
321
- Local first. Agent native. Built for real workflows.
322
- </p>
1
+ # Nexum Code
2
+
3
+ Nexum Code 是一个本地优先的终端 AI Agent,也可以作为 AIFlowy / Web 智能体系统的底座。它支持会话、工具调用、MCP、Skill、多 Agent 协作、长期记忆、Node SDK、服务端 API,以及文档智能解析。
4
+
5
+ ## 安装
6
+
7
+ 要求 Node.js >= 22.19.0。
8
+
9
+ ```bash
10
+ npm install -g nexum-code
11
+ nexum
12
+ ```
13
+
14
+ 安装时会尽量准备 `/doc` 所需的扫描件运行环境:
15
+
16
+ - `@napi-rs/canvas` 会随 npm 包安装,用于扫描 PDF 页面渲染。
17
+ - `canvas` 作为兼容备用依赖安装。
18
+ - Windows 全局安装时会检测 Tesseract OCR;如果没有安装,会尝试通过 `winget` 安装。
19
+
20
+ 如果你的系统不能自动安装 Tesseract,可以手动安装:
21
+
22
+ ```powershell
23
+ winget install UB-Mannheim.TesseractOCR
24
+ ```
25
+
26
+ 中文 OCR 需要 `chi_sim.traineddata`。如果你的 Tesseract 只带英文,可以把中文语言包放到用户目录,并设置:
27
+
28
+ ```powershell
29
+ $env:NEXUM_TESSERACT_PATH="C:\Program Files\Tesseract-OCR\tesseract.exe"
30
+ $env:NEXUM_OCR_LANGUAGE="chi_sim+eng"
31
+ $env:NEXUM_TESSDATA_DIR="$env:LOCALAPPDATA\Nexum\tessdata"
32
+ ```
33
+
34
+ ## `/doc` 文档解析
35
+
36
+ 启动 `nexum` 后,在 TUI 输入框里直接使用 `/doc`。
37
+
38
+ 解析单个文件:
39
+
40
+ ```text
41
+ /doc "E:\资料\灾毁报告.pdf" --format markdown
42
+ ```
43
+
44
+ 递归解析整个文件夹:
45
+
46
+ ```text
47
+ /doc "E:\资料\公路灾毁文档" --format markdown
48
+ ```
49
+
50
+ 只解析当前文件夹,不递归子目录:
51
+
52
+ ```text
53
+ /doc "E:\资料\公路灾毁文档" --format markdown --no-recursive
54
+ ```
55
+
56
+ 支持格式:
57
+
58
+ - PDF,包括文本 PDF 和扫描 PDF
59
+ - Word:`.docx`,旧版 `.doc` 会提示先转换
60
+ - Excel:`.xlsx`、`.xls`、`.csv`
61
+ - 图片扫描件:`.png`、`.jpg`、`.jpeg`、`.tif`、`.tiff`、`.webp`、`.gif`
62
+
63
+ 支持导出格式:
64
+
65
+ ```text
66
+ json | markdown | excel | csv | review-json | review-markdown
67
+ ```
68
+
69
+ 解析文件夹时,Nexum 会在目标文件夹下生成汇总报告:
70
+
71
+ ```text
72
+ <文件夹>/.nexum-document-analysis/document-analysis-*.md
73
+ ```
74
+
75
+ 单个文档的导出结果会写入 Nexum 的文档输出目录,并在终端提示路径。
76
+
77
+ ## 常用命令
78
+
79
+ ```text
80
+ /config 配置模型服务
81
+ /model 切换模型
82
+ /mode 切换权限模式
83
+ /goal 开启目标驱动执行
84
+ /wolfpack 开启多 Agent 协作
85
+ /memory 管理长期记忆
86
+ /doc 解析 PDF、Word、Excel、扫描件
87
+ /cc-connect 配置远程聊天入口
88
+ ```
89
+
90
+ ## 作为 AIFlowy / Web 智能体底座
91
+
92
+ Nexum Code 的核心能力不只服务于终端。仓库内还包含:
93
+
94
+ - `packages/node-sdk`:Node.js SDK,可在后端中创建会话、发送任务、监听事件、管理文档任务。
95
+ - `packages/nexum-server`:HTTP + SSE 服务端适配层。
96
+ - `packages/document-intelligence`:文档解析、OCR、结构化提取、导出和评测能力。
97
+
98
+ 这意味着你可以把 Nexum 作为 Web 智能体、企业内部 Agent 工作台、AIFlowy 系统智能体底座或自动化平台的执行核心。
99
+
100
+ ## 开发
101
+
102
+ ```bash
103
+ pnpm install
104
+ pnpm run build
105
+ pnpm run typecheck
106
+ pnpm run lint
107
+ pnpm run test
108
+ ```
109
+
110
+ SDK 的类型声明构建会运行 `api-extractor` rollup。失败会让构建失败,不再跳过。
111
+
112
+ ## 许可证
113
+
114
+ MIT
@@ -134,8 +134,8 @@ function normalizeBotList(payload) {
134
134
  return payload.map((item) => {
135
135
  if (typeof item !== "object" || item === null) return null;
136
136
  const record = item;
137
- const id = String(record["id"] ?? "");
138
- const title = String(record["title"] ?? "");
137
+ const id = optionalString(record["id"]) ?? "";
138
+ const title = optionalString(record["title"]) ?? "";
139
139
  if (id.length === 0 || title.length === 0) return null;
140
140
  return {
141
141
  id,
@@ -3,5 +3,5 @@ import { fileURLToPath as __cjsShimFileURLToPath } from 'node:url';
3
3
  import { dirname as __cjsShimDirname } from 'node:path';
4
4
  const __filename = __cjsShimFileURLToPath(import.meta.url);
5
5
  const __dirname = __cjsShimDirname(__filename);
6
- import { l as updateAiflowyBot } from "./aiflowy-bot-sync-BMV5Lg3y.mjs";
6
+ import { l as updateAiflowyBot } from "./aiflowy-bot-sync-C0WrAYbG.mjs";
7
7
  export { updateAiflowyBot };