Skip to content

Commit 799e4bb

Browse files
committed
docs: Refactor deployment guide in README to link external documentation, introduce a one-click Docker installation script, and add smart replace test cases documentation.
1 parent 980a22e commit 799e4bb

File tree

4 files changed

+422
-197
lines changed

4 files changed

+422
-197
lines changed

CHANGELOG.md

Lines changed: 223 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,223 @@
11
# 更新日志
22

3-
本项目的所有重要变更都会记录在此文件中。
3+
## [1.0.8] - 2026-02-02
44

5-
格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/),版本号遵循 [语义化版本](https://semver.org/lang/zh-CN/) 规范。
5+
### ✨ 新功能
6+
7+
- feat(Chat, PreviewAndDebug): add setIsMoreMessage to manage message loading state
8+
- feat(CreateModel): 新增或编辑模型时,新增最大上下文长度字段
9+
- feat(historyConversation): 添加历史会话页面关闭按钮
10+
11+
### 🐛 Bug 修复
12+
13+
- 修复 SSE 连接关闭逻辑,确保连接关闭时正确标记中止状态
14+
- 修复会话停止逻辑,确保 requestId 为空时也能停止会话
15+
- 修复清空会话后对话设置未重置问题
16+
- 修复页面切换时 SSE 连接未中断问题
17+
- 修复代码规范问题(ESLint)
18+
19+
### ♻️ 重构
20+
21+
- 恢复 v1.0.8-alpha 代码版本
22+
- 移除 ChatArea 组件中冗余的 handleAddToChat 函数,简化代码结构
23+
- 重构 SSE 连接逻辑,分离工作流与会话的 SSE 连接
24+
25+
### 🎨 样式优化
26+
27+
- style(EditAgent): Comment out mask property in PreviewAndDebug for improved visibility in WeChat
28+
- style: update AgentModelSetting layout and logic
29+
- style: update SystemTipsWord layout
30+
- 将"远程桌面"统一更名为"智能体电脑"
31+
32+
### 🔧 构建/工具
33+
34+
- 更新 .gitignore 文件,添加 .agent 以排除相关文件
35+
- 清理测试文件和示例文件
36+
37+
### 📚 文档
38+
39+
- 更新项目文档
40+
41+
## [1.0.7] - 2026-01-14
42+
43+
### ✨ 新功能
44+
45+
- 新增远程桌面分享功能,支持生成分享链接和设置过期时间
46+
- 新增文件树面板展开/折叠和固定功能,提升用户交互体验
47+
- 新增 VNC 远程桌面预览连接状态显示和自动重连机制
48+
- 新增空闲检测功能和警告弹窗,支持用户长时间无操作时自动断开连接
49+
- 新增加载更多历史消息功能,支持会话消息分页查询
50+
- 新增任务智能体模式切换功能
51+
- 新增文件操作提示框(上传、下载、导出、导入),增强用户反馈
52+
- 新增文件预览支持更多格式(SVG、JSON、Office 文档等)
53+
- 新增子智能体配置功能(SubAgentConfig)
54+
- 新增技能变量支持和工具分类功能
55+
- 新增会话状态更新事件监听,任务状态变化时 UI 及时更新
56+
- 新增未保存更改检查功能,防止用户在未保存的情况下进行重要操作
57+
58+
### 🐛 Bug 修复
59+
60+
- 修复 SSE 连接关闭逻辑,确保连接关闭时正确标记中止状态
61+
- 修复会话停止逻辑,确保 requestId 为空时也能停止会话
62+
- 修复清空会话后对话设置未重置问题
63+
- 修复页面切换时 SSE 连接未中断问题
64+
- 修复导出文件名解码问题,支持特殊字符
65+
- 修复文件预览组件类型切换时的闪动问题
66+
- 修复会话结束后文件树刷新逻辑
67+
- 修复任务记录跳转使用错误的空间 ID
68+
- 修复空消息渲染问题,过滤掉空消息
69+
- 修复 Select 组件选项匹配不上时的显示问题
70+
71+
### ♻️ 重构
72+
73+
- 重构 AppDev 文件树面板和聊天区域组件结构
74+
- 重构 FileTreeView 组件,优化文件选择逻辑和视图模式切换
75+
- 重构 SSE 连接逻辑,分离工作流与会话的 SSE 连接
76+
- 重构 VncPreview 组件,优化连接检查和重试机制
77+
- 优化工作流 v3 版本的表单值合并逻辑和节点数据获取逻辑
78+
- 优化最近使用和会话记录查询逻辑
79+
- 统一提示信息中的称谓为"你"以提升用户亲和力
80+
81+
### 🎨 样式优化
82+
83+
- 新增滚动条自动隐藏样式,仅在悬停时显示
84+
- 优化文件树顶部样式和搜索视图高度
85+
- 优化聊天页面布局,支持动态调整左侧宽度
86+
- 优化空状态组件图标和加载动画样式
87+
- 将"远程桌面"统一更名为"智能体电脑"
88+
89+
### 📚 文档
90+
91+
- 新增 TiptapVariableInput 组件文档
92+
- 新增变量引用规则文档
93+
- 新增试运行逻辑分析文档
94+
95+
## [1.0.6] - 2026-01-05
96+
97+
### ✨ 新功能
98+
99+
- 新增 VNC 远程桌面预览功能,长任务智能体支持远程桌面操作
100+
- 重构工作流 v3 版本,新增变量聚合节点(VariableAggregation)组件
101+
- 新增是否支持 Design 设计模式配置开关
102+
- 增强日志处理逻辑,支持检测最新日志块中的错误
103+
- 为文件树视图添加加载遮罩层,优化加载状态指示
104+
- 添加自定义滚动条样式,仅在悬停时显示滚动条
105+
106+
### 🐛 Bug 修复
107+
108+
- 修复智能体编排页同步开场白内容及预置问题列表逻辑
109+
- 修复插件参数对 Object 和 Array 类型子级删除逻辑
110+
- 修复 Design 模式下内容编辑删除 bug
111+
- 修复 VariableAggregation 目录命名规范(统一大写 V)
112+
- 修复 nodeItem 组件导入路径问题
113+
- 修复页面预览 iframe 不必要的页面重载问题
114+
115+
### ♻️ 重构
116+
117+
- 移除不必要的 onConfirmUpdateEventQuestions 属性
118+
- 优化 nodeItem 样式,简化输入框样式设置
119+
- 增强 DesignViewer 组件的内容更新和聊天功能
120+
- 统一跳转 URL 子包处理逻辑
121+
122+
### 📚 文档
123+
124+
- 添加 DesignViewer 设计模式开发指南
125+
- 添加查找替换规则文档
126+
- 更新开发指南,添加 Vite 插件预注入说明和常见问题
127+
128+
## [1.0.5] - 2025-12-08
129+
130+
### ✨ 新功能
131+
132+
- 新增 DesignViewer 设计模式组件,支持 Tailwind CSS 样式编辑和实时预览
133+
- 增强 TiptapVariableInput:支持变量输入、Markdown 语法、可编辑变量节点、自定义标签保护
134+
- 添加项目导出、聊天任务取消、变量建议外部关闭、多行智能样式替换
135+
136+
### 🐛 Bug 修复
137+
138+
- 修复文件上传/导入加载状态管理、useAppDevServer 支持 devServerUrl 为 null
139+
- 修复 PagePreviewIframe 文档处理、智能体引导问题、聊天滚动检测逻辑
140+
- 修复设计模式状态管理,迁移到 appDevDesign 模型
141+
142+
### ♻️ 重构
143+
144+
- 重构 TiptapVariableInput 实现自包含变量树,移除 VariableInferenceInput
145+
- 统一变量转换方法到工具库,提取滚动检测到独立 Hook
146+
- 优化 DesignViewer 模块化,升级 TiptapVariableInput 到 React 18 API
147+
- 清理调试日志和未使用代码
148+
149+
### ⚡️ 性能优化
150+
151+
- 优化 TiptapVariableInput 光标位置和滚动保持,使用 useCallback 优化 EditAgent
152+
153+
## [1.0.3] - 2025-11-24
154+
155+
### ✨ 新功能
156+
157+
- 同步老仓库最新代码,添加微信小程序支持、封面图片上传、MCP 智能体支持
158+
- 新增 TiptapVariableInput 组件,支持 @ 提及和变量自动补全
159+
- 添加项目 ID 支持、版本更新检查、回到首页悬浮图标
160+
- 重构 useAppDevServer 和 useDevLogs 钩子,使用 umi 的 useRequest 进行轮询
161+
162+
### 🐛 Bug 修复
163+
164+
- 修复封面图片源类型导入、图片加载错误处理、AttachFile 组件 mimeType 容错
165+
- 修复 useAppDevServer keepAlive 多项目并发问题
166+
- 修复 PagePreviewIframe 页面刷新逻辑、小程序跳转路径、AppDev 取消任务错误
167+
168+
### ♻️ 重构
169+
170+
- 使用枚举替代字符串常量,优化微信小程序消息发送逻辑
171+
- 优化 TiptapVariableInput 和 ExpandTextArea 组件
172+
- 清理 AppDev 调试日志(移除 80+ 条)
173+
174+
### 🧪 测试
175+
176+
- 新增 TiptapVariableInputTest 测试页面
177+
178+
## [1.0.2] - 2025-11-17
179+
180+
### 🔧 构建/工具
181+
182+
- 添加 esbuild 依赖并在配置中实现 dev-monitor.js 的复制与压缩功能
183+
- 更新 dev-monitor.js 版本号至 1.0.2、1.0.3、1.0.4
184+
185+
### ✨ 新功能
186+
187+
- 同步老仓库最新代码
188+
- 添加微信小程序支持功能,注入 JS-SDK 并监听 DOM 变化以发送消息
189+
- 添加封面图片上传功能,更新相关样式和逻辑,增强页面编辑和创建功能
190+
- 更新预览组件逻辑,添加封面图片源类型判断,优化截图处理
191+
- 更新 PageCard 组件,替换 icon 属性为 coverImg,优化样式过渡效果,移除不再使用的 PageDevelopCardItem 组件
192+
- MCP 添加智能体支持,更新相关组件和常量,优化图标处理逻辑
193+
- 添加创建智能体功能,更新 Created 组件和服务接口以支持智能体类型
194+
- 添加 streamableHttp 类型支持,更新样式以增强组件可视化效果
195+
- 添加项目 ID 支持以区分不同项目的最近使用记录,在 ChatArea、ChatInputHome 和 MentionSelector 组件中引入 projectId 属性
196+
197+
### 🐛 Bug 修复
198+
199+
- 修复封面图片源类型导入路径,确保正确引用
200+
- 添加图片加载错误处理逻辑,确保组件在图片加载失败时使用默认图片
201+
- 修复 useAppDevServer 中 keepAlive 可能同时运行多个不同 projectId 的问题,引入 useParams 从 URL 获取最新的 projectId,确保同一时间只有当前 URL projectId 的 keepAlive 在运行
202+
- 优化封面图片来源设置逻辑,确保用户未上传图片时不设置来源
203+
- 更新 Created 组件的 checkTag 属性,从 Plugin 修改为 Workflow,以确保正确的组件类型匹配
204+
- 修复 AttachFile 组件中对 mimeType 的容错处理,确保在后端返回空值时不导致错误
205+
- 延迟发送微信小程序消息,确保 DOM 变化监听稳定性
206+
- 添加错误发送防抖逻辑,优化错误消息发送至父窗口的稳定性
207+
- 更新 Created 组件中的 agentItem 标签,将 label 从 '当前空间智能体' 修改为 '全部',新增 '当前空间智能体' 选项
208+
209+
### ⚡️ 性能优化
210+
211+
- 优化微信小程序消息发送逻辑,简化代码结构并增强 DOM 变化监听功能
212+
213+
### ♻️ 重构
214+
215+
- 使用枚举替代字符串常量,增强代码可读性和可维护性,添加错误处理逻辑
216+
- 移除同步登录状态功能的实现,简化代码结构
217+
- 将最近使用的文件和数据源存储从 localStorage 更改为 sessionStorage,提高数据的即时性
218+
- 注释掉 setupMutationObserver 函数以简化错误监控逻辑,保留相关逻辑以便未来可能的恢复
219+
- 注释掉资源加载错误处理逻辑,简化错误监控代码
220+
- 重构 useAppDevServer 和 useDevLogs 钩子以使用 umi 的 useRequest 进行轮询,简化定时器管理,优化状态管理,提升代码可读性和维护性
6221

7222
## [1.0.1] - 2025-11-10
8223

@@ -86,3 +301,9 @@
86301

87302
[1.0.0]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.0
88303
[1.0.1]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.1
304+
[1.0.2]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.2
305+
[1.0.3]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.3
306+
[1.0.5]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.5
307+
[1.0.6]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.6
308+
[1.0.7]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.7
309+
[1.0.8]: https://github.com/nuwax-ai/nuwax/releases/tag/v1.0.8

README.md

Lines changed: 36 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -34,107 +34,26 @@ Use the official nuwax-cli command tool to quickly deploy services locally.
3434
- Ensure OrbStack or Docker Desktop is started
3535
- First-time use may require allowing unknown developers: System Preferences → Security & Privacy
3636

37-
##### Client Download
37+
#### Local Deployment Service Guide
3838

39-
> The client is only a deployment tool and does not include the platform software package
39+
There are 2 deployment services:
4040

41-
- [nuwax-cli-linux-amd64.tar.gz](https://nuwa-packages.oss-rg-china-mainland.aliyuncs.com/duck-client-releases/v1.0.65/nuwax-cli-linux-amd64.tar.gz)
42-
- [nuwax-cli-linux-arm64.tar.gz](https://nuwa-packages.oss-rg-china-mainland.aliyuncs.com/duck-client-releases/v1.0.65/nuwax-cli-linux-arm64.tar.gz)
43-
- [nuwax-cli-macos-universal.tar.gz](https://nuwa-packages.oss-rg-china-mainland.aliyuncs.com/duck-client-releases/v1.0.65/nuwax-cli-macos-universal.tar.gz) (amd64&arm64)
41+
- Main project service (required)
42+
- Agent Computer (Sandbox) deployment guide (optional)
4443

45-
##### Execute Commands to Complete Deployment
44+
In the main local service, configure one or more Agent Computer deployment addresses to use the Agent Computer (Sandbox). Since the "Agent Computer (Sandbox)" includes a personal computer (sandbox) which requires more resources, it supports separate deployment across multiple servers.
4645

47-
The following commands require Docker permissions or can be run with sudo
46+
#### Deploy Main Service
4847

49-
#### Linux / macOS
48+
[Installation Documentation](https://nuwax.com/deploy.html)
5049

51-
```bash
52-
# Example working directory
53-
mkdir nuwax_deploy
54-
cd nuwax_deploy
55-
56-
# Download client deployment tool
57-
# Linux download command (amd64)
58-
wget https://nuwa-packages.oss-rg-china-mainland.aliyuncs.com/duck-client-releases/v1.0.65/nuwax-cli-linux-amd64.tar.gz
59-
# Linux download command (arm64)
60-
wget https://nuwa-packages.oss-rg-china-mainland.aliyuncs.com/duck-client-releases/v1.0.65/nuwax-cli-linux-arm64.tar.gz
61-
# macOS download command
62-
wget https://nuwa-packages.oss-rg-china-mainland.aliyuncs.com/duck-client-releases/v1.0.65/nuwax-cli-macos-universal.tar.gz
63-
64-
# Extract downloaded client files to working directory
65-
tar -xzf nuwax-cli-*.tar.gz
66-
67-
# Add execute permission
68-
chmod +x nuwax-cli
69-
70-
# Initialize
71-
./nuwax-cli init
72-
73-
# Start deployment, if you need to specify project name or access port (default 80), you can use the following command:
74-
# ./nuwax-cli auto-upgrade-deploy run --port 8099 -p nuwax
75-
./nuwax-cli auto-upgrade-deploy run
76-
```
77-
78-
> **Important Note**: It is recommended to regularly upgrade the command line tool by executing in the working directory:
79-
>
80-
> ```bash
81-
> ./nuwax-cli check-update install
82-
> ```
83-
84-
Normally, after executing the commands, the service should be deployed successfully.
85-
86-
##### Access Service
87-
88-
After deployment is complete, access in browser: `http://localhost`
89-
90-
Login with default administrator account: `admin@nuwax.com` password: `123456`
91-
92-
> Note: If port 80 is occupied, you can specify a port for deployment, such as: `./nuwax-cli auto-upgrade-deploy run --port 8099`
93-
94-
##### Important Configuration
95-
96-
Please modify promptly after login:
97-
98-
- Administrator password
99-
- Site information configuration
100-
- Email service configuration for user registration and login verification codes.
101-
102-
### Troubleshooting
103-
104-
#### 1. Service Startup Failed
105-
106-
- Check if Docker is running properly
107-
- Use `./nuwax-cli status` to view detailed status
108-
- Check if ports are occupied
109-
110-
#### 2. Unable to Access Service
111-
112-
- Confirm service has started properly, you can execute `docker ps` or `./nuwax-cli ducker` to view container status
113-
- Check firewall settings
114-
- Confirm port configuration is correct
50+
#### Agent Computer (Sandbox) Deployment Guide
11551

116-
#### 3. Permission Issues - Permission denied
52+
You can deploy Agent Computer services on multiple different servers, achieving distributed agent sandbox capabilities through configuration.
11753

118-
- **Linux (Ubuntu 22.04 LTS)**: Ensure user is in docker group
119-
- **macOS**: Allow unknown developers to run, ensure OrbStack or Docker Desktop is started
54+
> **Environment Requirements**: Each server needs Docker and Docker Compose environment installed, refer to [Docker Installation Documentation](https://nuwax.com/deploy.html#%E6%8E%A8%E8%8D%90%E6%96%B9%E6%A1%88-%E4%B8%80%E9%94%AE%E5%AE%89%E8%A3%85%E9%85%8D%E7%BD%AE-docker-%E8%84%9A%E6%9C%AC).
12055
121-
Use `sudo` to execute commands: `sudo ./nuwax-cli auto-upgrade-deploy run`
122-
123-
#### 4. Extraction Failed - Directory not empty(os error 39)
124-
125-
First stop Docker service: `./nuwax-cli docker-service stop`, then manually delete the `docker` directory in the working directory and re-execute the deployment command.
126-
127-
#### 5. Interface Shows System Exception
128-
129-
Check backend logs: `./docker/logs/agent/app.log`, usually restarting the service can resolve:
130-
131-
```bash
132-
./nuwax-cli docker-service restart
133-
```
134-
135-
#### 6. Download Failed - error decoding response body
136-
137-
Network issues cause this, re-executing the deployment command will work, supports resumable downloads.
56+
[Installation Documentation](https://nuwax.com/agent-computer-deploy.html)
13857

13958
### Common Management Commands
14059

@@ -175,11 +94,33 @@ If your system doesn't have Docker environment installed yet, please refer to th
17594

17695
This installation guide includes detailed installation steps for the following platforms:
17796

178-
- **Ubuntu 22.04 LTS** (recommended Linux distribution)
97+
- **Ubuntu 24.04.3 LTS** (recommended Linux distribution)
17998
- **macOS** (supports OrbStack and Docker Desktop)
180-
- **Windows 10/11** (Docker Desktop)
18199
- **Mirror acceleration configuration** (for mainland China users)
182-
- **Installation verification and troubleshooting**
100+
101+
### Recommended: One-Click Docker Installation Script
102+
103+
> Community one-click Docker installation script
104+
105+
This script supports 13 Linux distributions, including domestic operating systems (openEuler, Anolis OS, OpenCloudOS, Alinux, Kylin Linux), one-click installation of docker, docker-compose with automatic configuration of Xuanyuan mirror acceleration.
106+
107+
```shell
108+
bash <(wget -qO- https://xuanyuan.cloud/docker.sh)
109+
```
110+
111+
#### Script Features and Advantages
112+
113+
✅ Supports 13 mainstream distributions: openEuler, OpenCloudOS, Anolis OS, Alinux (Alibaba Cloud), Kylin Linux, Fedora, Rocky Linux, AlmaLinux, Ubuntu, Debian, CentOS, RHEL, Oracle Linux
114+
115+
✅ Complete support for domestic operating systems: Deep adaptation for domestic OS (openEuler, Anolis OS, OpenCloudOS, Alinux, Kylin Linux), supports automatic version detection and optimal configuration
116+
117+
✅ Intelligent multi-mirror source switching: Built-in 6+ domestic mirror sources including Alibaba Cloud, Tencent Cloud, Huawei Cloud, USTC, Tsinghua, etc., automatically detects and selects the fastest source
118+
119+
✅ Special handling for older systems: Supports expired systems like Ubuntu 16.04, Debian 9/10, automatically configures compatible installation solutions
120+
121+
✅ Dual installation guarantee: Automatically switches to binary installation if package manager installation fails, ensuring installation success rate
122+
123+
✅ macOS/Windows friendly prompts: Automatically detects macOS and Windows systems, provides appropriate Docker Desktop installation guidance
183124

184125
**Quick Docker Installation Verification:**
185126

0 commit comments

Comments
 (0)