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 +63 -59
- package/dist/{app-BM4PK_mj.mjs → app-DDsPnVUr.mjs} +94268 -93072
- package/dist/esm-RYfZ46Tf.mjs +3593 -0
- package/dist/index.min-D4utBuC7.mjs +2990 -0
- package/dist/main.mjs +1 -1
- package/dist/pdf.worker-ByxNbF6P.mjs +82061 -0
- package/dist/{src-DLZtHSyk.mjs → src-BxVYaO-v.mjs} +12 -12
- package/package.json +23 -23
- package/dist/esm-CmfJNv9s.mjs +0 -8590
package/README.md
CHANGED
|
@@ -1,29 +1,46 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 终端客户端
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`nexum-code` 是个人 Agent 助手的终端客户端,提供 `nexum` 命令和终端交互界面。它适合本地开发、自动化任务执行、文档解析、项目系统接入前的本地调试,以及需要终端原生体验的 Agent 工作流。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 目录
|
|
6
6
|
|
|
7
|
-
|
|
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
|
-
|
|
24
|
+
在本仓库内开发运行:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pnpm install
|
|
28
|
+
pnpm --filter nexum-code run dev:cli-only
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## 运行要求
|
|
15
32
|
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
33
|
+
- Node.js >= 22.19.0
|
|
34
|
+
- pnpm 仅在本仓库开发时需要
|
|
35
|
+
- 扫描件 OCR 依赖 Tesseract OCR
|
|
19
36
|
|
|
20
|
-
|
|
37
|
+
Windows 可手动安装 OCR:
|
|
21
38
|
|
|
22
39
|
```powershell
|
|
23
40
|
winget install UB-Mannheim.TesseractOCR
|
|
24
41
|
```
|
|
25
42
|
|
|
26
|
-
|
|
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
|
-
##
|
|
51
|
+
## 常用命令
|
|
35
52
|
|
|
36
|
-
|
|
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
|
|
71
|
+
/doc "E:\资料\个人报告.pdf" --format markdown
|
|
42
72
|
```
|
|
43
73
|
|
|
44
|
-
|
|
74
|
+
递归解析文件夹:
|
|
45
75
|
|
|
46
76
|
```text
|
|
47
|
-
/doc "E
|
|
77
|
+
/doc "E:\资料\知识库文档" --format markdown
|
|
48
78
|
```
|
|
49
79
|
|
|
50
|
-
|
|
80
|
+
只解析当前文件夹,不进入子目录:
|
|
51
81
|
|
|
52
82
|
```text
|
|
53
|
-
/doc "E
|
|
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
|
-
|
|
70
|
-
|
|
71
|
-
```text
|
|
72
|
-
<文件夹>/.nexum-document-analysis/document-analysis-*.md
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
单个文档的导出结果会写入 Nexum 的文档输出目录,并在终端提示路径。
|
|
76
|
-
|
|
77
|
-
## 常用命令
|
|
92
|
+
## 本地开发
|
|
78
93
|
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
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
|
-
##
|
|
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
|
-
|
|
104
|
+
`nexum-code` 只负责客户端体验与命令入口。会话执行、文档解析、服务端适配、模型调用等核心逻辑应通过 `packages/*` 中的稳定 API 调用,不应直接塞入终端界面层。
|
|
99
105
|
|
|
100
|
-
|
|
106
|
+
终端客户端调用链:
|
|
101
107
|
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
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
|