nexum-code 0.6.15 → 0.7.0

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,29 +1,46 @@
1
- # Nexum Code
1
+ # 终端客户端
2
2
 
3
- Nexum Code 是一个本地优先的终端 AI Agent,也可以作为 AIFlowy / Web 智能体系统的底座。它支持会话、工具调用、MCP、Skill、多 Agent 协作、长期记忆、Node SDK、服务端 API,以及文档智能解析。
3
+ `nexum-code` 是个人 Agent 助手的终端客户端,提供 `nexum` 命令和终端交互界面。它适合本地开发、自动化任务执行、文档解析、项目系统接入前的本地调试,以及需要终端原生体验的 Agent 工作流。
4
4
 
5
- ## 安装
5
+ ## 目录
6
6
 
7
- 要求 Node.js >= 22.19.0。
7
+ - [安装与启动](#安装与启动)
8
+ - [运行要求](#运行要求)
9
+ - [常用命令](#常用命令)
10
+ - [文档解析](#文档解析)
11
+ - [本地开发](#本地开发)
12
+ - [职责边界](#职责边界)
13
+ - [许可证](#许可证)
14
+
15
+ ## 安装与启动
16
+
17
+ 全局安装已发布包:
8
18
 
9
19
  ```bash
10
20
  npm install -g nexum-code
11
21
  nexum
12
22
  ```
13
23
 
14
- 安装时会尽量准备 `/doc` 所需的扫描件运行环境:
24
+ 在本仓库内开发运行:
25
+
26
+ ```bash
27
+ pnpm install
28
+ pnpm --filter nexum-code run dev:cli-only
29
+ ```
30
+
31
+ ## 运行要求
15
32
 
16
- - `@napi-rs/canvas` 会随 npm 包安装,用于扫描 PDF 页面渲染。
17
- - `canvas` 作为兼容备用依赖安装。
18
- - Windows 全局安装时会检测 Tesseract OCR;如果没有安装,会尝试通过 `winget` 安装。
33
+ - Node.js >= 22.19.0
34
+ - pnpm 仅在本仓库开发时需要
35
+ - 扫描件 OCR 依赖 Tesseract OCR
19
36
 
20
- 如果你的系统不能自动安装 Tesseract,可以手动安装:
37
+ Windows 可手动安装 OCR:
21
38
 
22
39
  ```powershell
23
40
  winget install UB-Mannheim.TesseractOCR
24
41
  ```
25
42
 
26
- 中文 OCR 需要 `chi_sim.traineddata`。如果你的 Tesseract 只带英文,可以把中文语言包放到用户目录,并设置:
43
+ 常用 OCR 环境变量:
27
44
 
28
45
  ```powershell
29
46
  $env:NEXUM_TESSERACT_PATH="C:\Program Files\Tesseract-OCR\tesseract.exe"
@@ -31,84 +48,71 @@ $env:NEXUM_OCR_LANGUAGE="chi_sim+eng"
31
48
  $env:NEXUM_TESSDATA_DIR="$env:LOCALAPPDATA\Nexum\tessdata"
32
49
  ```
33
50
 
34
- ## `/doc` 文档解析
51
+ ## 常用命令
35
52
 
36
- 启动 `nexum` 后,在 TUI 输入框里直接使用 `/doc`。
53
+ ```text
54
+ /config 配置模型服务
55
+ /model 切换模型
56
+ /mode 切换权限模式
57
+ /goal 开启目标驱动执行
58
+ /memory 管理长期记忆
59
+ /doc 解析 PDF、Word、Excel、CSV、图片与扫描 PDF
60
+ /agent 查看或管理项目系统中的智能体配置
61
+ /skill 管理已安装 Skill 与可安装 Skill 包
62
+ /mcp 管理 MCP 服务
63
+ /update 手动更新客户端
64
+ ```
65
+
66
+ ## 文档解析
37
67
 
38
68
  解析单个文件:
39
69
 
40
70
  ```text
41
- /doc "E:\资料\灾毁报告.pdf" --format markdown
71
+ /doc "E:\资料\个人报告.pdf" --format markdown
42
72
  ```
43
73
 
44
- 递归解析整个文件夹:
74
+ 递归解析文件夹:
45
75
 
46
76
  ```text
47
- /doc "E:\资料\公路灾毁文档" --format markdown
77
+ /doc "E:\资料\知识库文档" --format markdown
48
78
  ```
49
79
 
50
- 只解析当前文件夹,不递归子目录:
80
+ 只解析当前文件夹,不进入子目录:
51
81
 
52
82
  ```text
53
- /doc "E:\资料\公路灾毁文档" --format markdown --no-recursive
83
+ /doc "E:\资料\知识库文档" --format markdown --no-recursive
54
84
  ```
55
85
 
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
86
  支持导出格式:
64
87
 
65
88
  ```text
66
89
  json | markdown | excel | csv | review-json | review-markdown
67
90
  ```
68
91
 
69
- 解析文件夹时,Nexum 会在目标文件夹下生成汇总报告:
70
-
71
- ```text
72
- <文件夹>/.nexum-document-analysis/document-analysis-*.md
73
- ```
74
-
75
- 单个文档的导出结果会写入 Nexum 的文档输出目录,并在终端提示路径。
76
-
77
- ## 常用命令
92
+ ## 本地开发
78
93
 
79
- ```text
80
- /config 配置模型服务
81
- /model 切换模型
82
- /mode 切换权限模式
83
- /goal 开启目标驱动执行
84
- /wolfpack 开启多 Agent 协作
85
- /memory 管理长期记忆
86
- /doc 解析 PDF、Word、Excel、扫描件
87
- /cc-connect 配置远程聊天入口
94
+ ```bash
95
+ pnpm install
96
+ pnpm --filter nexum-code run dev:cli-only
97
+ pnpm --filter nexum-code run build
98
+ pnpm --filter nexum-code run test
99
+ pnpm --filter nexum-code run typecheck
88
100
  ```
89
101
 
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、结构化提取、导出和评测能力。
102
+ ## 职责边界
97
103
 
98
- 这意味着你可以把 Nexum 作为 Web 智能体、企业内部 Agent 工作台、AIFlowy 系统智能体底座或自动化平台的执行核心。
104
+ `nexum-code` 只负责客户端体验与命令入口。会话执行、文档解析、服务端适配、模型调用等核心逻辑应通过 `packages/*` 中的稳定 API 调用,不应直接塞入终端界面层。
99
105
 
100
- ## 开发
106
+ 终端客户端调用链:
101
107
 
102
- ```bash
103
- pnpm install
104
- pnpm run build
105
- pnpm run typecheck
106
- pnpm run lint
107
- pnpm run test
108
+ ```text
109
+ src/main.ts
110
+ -> src/cli/commands.ts
111
+ -> src/cli/run-shell.ts
112
+ -> @nexum-cli/nexum-code-sdk
113
+ -> src/tui/nexum-tui.ts
108
114
  ```
109
115
 
110
- SDK 的类型声明构建会运行 `api-extractor` rollup。失败会让构建失败,不再跳过。
111
-
112
116
  ## 许可证
113
117
 
114
118
  MIT