nexum-code 0.6.16 → 0.7.9

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,84 +1,118 @@
1
- # Nexum Code CLI
2
-
3
- `nexum-code` 是 Nexum 的终端客户端,提供命令行入口和 TUI 交互界面。它面向本地开发、自动化任务执行、AIFlowy/Web 智能体接入前的本地调试,以及需要终端原生体验的 Agent 工作流。
4
-
5
- ## 安装与启动
6
-
7
- ```bash
8
- npm install -g nexum-code
9
- nexum
10
- ```
11
-
12
- 运行要求:
13
-
14
- - Node.js >= 22.19.0
15
- - pnpm 仅在本仓库开发时需要
16
- - 扫描件 OCR 依赖 Tesseract OCR
17
-
18
- Windows 可手动安装 OCR:
19
-
20
- ```powershell
21
- winget install UB-Mannheim.TesseractOCR
22
- ```
23
-
24
- 常用 OCR 环境变量:
25
-
26
- ```powershell
27
- $env:NEXUM_TESSERACT_PATH="C:\Program Files\Tesseract-OCR\tesseract.exe"
28
- $env:NEXUM_OCR_LANGUAGE="chi_sim+eng"
29
- $env:NEXUM_TESSDATA_DIR="$env:LOCALAPPDATA\Nexum\tessdata"
30
- ```
31
-
32
- ## 常用命令
33
-
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
- ## 文档解析
45
-
46
- 解析单个文件:
47
-
48
- ```text
49
- /doc "E:\资料\灾毁报告.pdf" --format markdown
50
- ```
51
-
52
- 递归解析文件夹:
53
-
54
- ```text
55
- /doc "E:\资料\公路灾毁文档" --format markdown
56
- ```
57
-
58
- 只解析当前文件夹,不进入子目录:
59
-
60
- ```text
61
- /doc "E:\资料\公路灾毁文档" --format markdown --no-recursive
62
- ```
63
-
64
- 支持导出格式:
65
-
66
- ```text
67
- json | markdown | excel | csv | review-json | review-markdown
68
- ```
69
-
70
- ## 本地开发
71
-
72
- ```bash
73
- pnpm install
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
78
- ```
79
-
80
- `nexum-code` 只负责客户端体验与命令入口。文档解析、会话执行、服务端适配等核心逻辑应通过 `packages/*` 中的稳定 API 调用,不应直接塞入 TUI 层。
81
-
82
- ## 许可证
83
-
84
- MIT
1
+ # 终端客户端
2
+
3
+ `nexum-code` 是个人 Agent 助手的终端客户端,提供 `nexum` 命令和终端交互界面。它适合本地开发、自动化任务执行、文档解析、项目系统接入前的本地调试,以及需要终端原生体验的 Agent 工作流。
4
+
5
+ ## 目录
6
+
7
+ - [安装与启动](#安装与启动)
8
+ - [运行要求](#运行要求)
9
+ - [常用命令](#常用命令)
10
+ - [文档解析](#文档解析)
11
+ - [本地开发](#本地开发)
12
+ - [职责边界](#职责边界)
13
+ - [许可证](#许可证)
14
+
15
+ ## 安装与启动
16
+
17
+ 全局安装已发布包:
18
+
19
+ ```bash
20
+ npm install -g nexum-code
21
+ nexum
22
+ ```
23
+
24
+ 在本仓库内开发运行:
25
+
26
+ ```bash
27
+ pnpm install
28
+ pnpm --filter nexum-code run dev:cli-only
29
+ ```
30
+
31
+ ## 运行要求
32
+
33
+ - Node.js >= 22.19.0
34
+ - pnpm 仅在本仓库开发时需要
35
+ - 扫描件 OCR 依赖 Tesseract OCR
36
+
37
+ Windows 可手动安装 OCR:
38
+
39
+ ```powershell
40
+ winget install UB-Mannheim.TesseractOCR
41
+ ```
42
+
43
+ 常用 OCR 环境变量:
44
+
45
+ ```powershell
46
+ $env:NEXUM_TESSERACT_PATH="C:\Program Files\Tesseract-OCR\tesseract.exe"
47
+ $env:NEXUM_OCR_LANGUAGE="chi_sim+eng"
48
+ $env:NEXUM_TESSDATA_DIR="$env:LOCALAPPDATA\Nexum\tessdata"
49
+ ```
50
+
51
+ ## 常用命令
52
+
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
+ ## 文档解析
67
+
68
+ 解析单个文件:
69
+
70
+ ```text
71
+ /doc "E:\资料\个人报告.pdf" --format markdown
72
+ ```
73
+
74
+ 递归解析文件夹:
75
+
76
+ ```text
77
+ /doc "E:\资料\知识库文档" --format markdown
78
+ ```
79
+
80
+ 只解析当前文件夹,不进入子目录:
81
+
82
+ ```text
83
+ /doc "E:\资料\知识库文档" --format markdown --no-recursive
84
+ ```
85
+
86
+ 支持导出格式:
87
+
88
+ ```text
89
+ json | markdown | excel | csv | review-json | review-markdown
90
+ ```
91
+
92
+ ## 本地开发
93
+
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
100
+ ```
101
+
102
+ ## 职责边界
103
+
104
+ `nexum-code` 只负责客户端体验与命令入口。会话执行、文档解析、服务端适配、模型调用等核心逻辑应通过 `packages/*` 中的稳定 API 调用,不应直接塞入终端界面层。
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
114
+ ```
115
+
116
+ ## 许可证
117
+
118
+ MIT