nexum-code 0.6.15 → 0.6.16

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