@comate/zulu 0.2.1-beta.2 → 0.3.0

package/README.md

@@ -1,31 +1,37 @@
 # Zulu CLI
 
 ## 环境
-* nodejs >=  22
+* nodejs >=  18
 * ripgrep >= 12 需要手动安装该库
 
 ## 安装
+
+### 安装 Zulu-CLI
+```shell
+npm install -g @comate/zulu
+```
+
 ### 安装 ripgrep
 以下是在不同操作系统和包管理器中安装`ripgrep`的常见命令：
 #### MacOS
 ```shell
 brew install ripgrep
 ```
-#### Linux
-##### Ubuntu/Debian
+#### Windows
+```shell
+winget install BurntSushi.ripgrep.MSVC
+```
+#### Ubuntu/Debian
 ```shell
 sudo apt update
 sudo apt install ripgrep
 ```
-##### CentOS
+#### CentOS
 ```shell
 sudo yum install epel-release
 sudo yum install ripgrep
 ```
-#### Windows
-```shell
-winget install BurntSushi.ripgrep.MSVC
-```
+
 #### 验证安装
 安装完成后，可以使用以下命令验证：
 ```shell
@@ -33,10 +39,6 @@ rg --version
 ```
 选择适合你操作系统和包管理器的命令即可。推荐使用系统自带的包管理器，这样更容易管理和更新。
 
-### 安装 Zulu-CLI
-```shell
-npm install -g @comate/zulu
-```
 
 ## 网络
 默认请求`https://comate.baidu.com`,如果环境未知，请执行`zulu --ping`测试连通性，如果不通：
@@ -58,7 +60,13 @@ zulu run --query="你好" --license=xxxx
 | run | 是 | --query | 问题的内容 |
 | run |  | --cwd | 工作路径，默认执行时所在地址 |
 | run |  | --ripgrep | ripgrep的绝对路径 |
-| run |  | --max | max模式的模型id |
+| run |  | --max | max模式的模型id。注意，指定模型只能在首轮对话生效，中途无法更换模型|
+| run |  | --normal | normal模式的模型id。注意，指定模型只能在首轮对话生效，中途无法更换模型|
+| run |  | --conversation | conversation id，如果需要多轮对话，将上一轮对话的id传入此参数，详情见下文 |
+| run |  | --delay | 模型调用的延迟时间，单位毫秒 |
+| list | 是 | --license | license的值 |
+| list |  | --max | 获取max模式支持的模型信息 |
+| list |  | --normal | 获取normal模式支持的模型信息 |
 |  |  | --ping | 测试网络连通性 |
 |  |  | --help | 帮助 |
 |  |  | --version | 版本号 |
@@ -74,6 +82,49 @@ zulu run --query="你好" --license=xxxx
 | HTTP_HOST | string | 设置服务地址，默认是 https://comate.baidu.com |
 | DEBUG | boolean | 打开调试日志 |
 
+## 多轮对话 Conversation 使用注意事项
+
+1. 以一次普通的生成结果为例，`conversation`的值为`conversationInfo.id`
+
+```json
+{
+  "type": "partial-message-data",
+  "conversationInfo": {
+    "id": "12af9af4-xxxxxx", // 这里就是 conversation id
+    "status": "Running",
+    "type": "E2EBotConversation",
+    "utime": 1755840911964,
+    "ctime": 1755840911957
+  },
+  "messages": [
+    {
+      "id": "e884b828-xxxxxx",
+      "userMessageId": "50039910",
+      "role": "assistant",
+      "status": "completed",
+      "content": {},
+      "elements": [
+        {
+          "id": "1f89ded8-xxxxxxx",
+          "type": "TEXT",
+          "status": "success",
+          "content": "我是Zulu，专注软件工程的智能体，助力实现从需求到代码的全流程开发。请问有什么具体的开发任务需要我协助您完成吗？例如代码开发、问题调试或性能优化等。",
+          "composer": {
+            "markdown": "",
+            "tasks": []
+          },
+          "isErrorMessage": false
+        }
+      ]
+    }
+  ]
+}
+```
+
+2. `conversation`指定的历史轮次必须在本地存在。历史记录在`~/.comate-engine/store`，以`chat_session_`开头，结尾即`conversation`
+
+3. 多轮对话中途无法变更模型
+
 
 ## 调试
 * 使用环境变量`DEBUG=true`，`STDOUT`会显示debug级别的日志

package/comate-engine/bin/comate.js

@@ -1,7 +1,16 @@
 // ================ polyfill start ================
 import {compare} from 'compare-versions';
+
 if (compare(process.version, '18.0.0', '<')) {
     await import('web-streams-polyfill/polyfill');
+    //polyfill for AbortSignal.timeout
+    if (!AbortSignal.timeout) {
+        AbortSignal.timeout = function (timeout) {
+            const controller = new AbortController();
+            setTimeout(() => controller.abort(), timeout);
+            return controller.signal;
+        }
+    };
 }
 // ================= polyfill end =================