nexum-code 0.6.16 → 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,15 +1,34 @@
1
- # Nexum Code CLI
1
+ # 终端客户端
2
2
 
3
- `nexum-code` 是 Nexum 的终端客户端,提供命令行入口和 TUI 交互界面。它面向本地开发、自动化任务执行、AIFlowy/Web 智能体接入前的本地调试,以及需要终端原生体验的 Agent 工作流。
3
+ `nexum-code` 是个人 Agent 助手的终端客户端,提供 `nexum` 命令和终端交互界面。它适合本地开发、自动化任务执行、文档解析、项目系统接入前的本地调试,以及需要终端原生体验的 Agent 工作流。
4
+
5
+ ## 目录
6
+
7
+ - [安装与启动](#安装与启动)
8
+ - [运行要求](#运行要求)
9
+ - [常用命令](#常用命令)
10
+ - [文档解析](#文档解析)
11
+ - [本地开发](#本地开发)
12
+ - [职责边界](#职责边界)
13
+ - [许可证](#许可证)
4
14
 
5
15
  ## 安装与启动
6
16
 
17
+ 全局安装已发布包:
18
+
7
19
  ```bash
8
20
  npm install -g nexum-code
9
21
  nexum
10
22
  ```
11
23
 
12
- 运行要求:
24
+ 在本仓库内开发运行:
25
+
26
+ ```bash
27
+ pnpm install
28
+ pnpm --filter nexum-code run dev:cli-only
29
+ ```
30
+
31
+ ## 运行要求
13
32
 
14
33
  - Node.js >= 22.19.0
15
34
  - pnpm 仅在本仓库开发时需要
@@ -38,7 +57,10 @@ $env:NEXUM_TESSDATA_DIR="$env:LOCALAPPDATA\Nexum\tessdata"
38
57
  /goal 开启目标驱动执行
39
58
  /memory 管理长期记忆
40
59
  /doc 解析 PDF、Word、Excel、CSV、图片与扫描 PDF
41
- /cc-connect 配置远程聊天入口
60
+ /agent 查看或管理项目系统中的智能体配置
61
+ /skill 管理已安装 Skill 与可安装 Skill 包
62
+ /mcp 管理 MCP 服务
63
+ /update 手动更新客户端
42
64
  ```
43
65
 
44
66
  ## 文档解析
@@ -46,19 +68,19 @@ $env:NEXUM_TESSDATA_DIR="$env:LOCALAPPDATA\Nexum\tessdata"
46
68
  解析单个文件:
47
69
 
48
70
  ```text
49
- /doc "E:\资料\灾毁报告.pdf" --format markdown
71
+ /doc "E:\资料\个人报告.pdf" --format markdown
50
72
  ```
51
73
 
52
74
  递归解析文件夹:
53
75
 
54
76
  ```text
55
- /doc "E:\资料\公路灾毁文档" --format markdown
77
+ /doc "E:\资料\知识库文档" --format markdown
56
78
  ```
57
79
 
58
80
  只解析当前文件夹,不进入子目录:
59
81
 
60
82
  ```text
61
- /doc "E:\资料\公路灾毁文档" --format markdown --no-recursive
83
+ /doc "E:\资料\知识库文档" --format markdown --no-recursive
62
84
  ```
63
85
 
64
86
  支持导出格式:
@@ -77,7 +99,19 @@ pnpm --filter nexum-code run test
77
99
  pnpm --filter nexum-code run typecheck
78
100
  ```
79
101
 
80
- `nexum-code` 只负责客户端体验与命令入口。文档解析、会话执行、服务端适配等核心逻辑应通过 `packages/*` 中的稳定 API 调用,不应直接塞入 TUI 层。
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
+ ```
81
115
 
82
116
  ## 许可证
83
117