@comate/zulu 0.0.11 → 0.0.13

package/README.md

@@ -0,0 +1,98 @@
+# Zulu CLI
+
+## 环境
+* nodejs >=  22
+* ripgrep >= 12 需要手动安装该库
+
+## 安装
+### 安装 ripgrep
+以下是在不同操作系统和包管理器中安装`ripgrep`的常见命令：
+#### MacOS
+```shell
+brew install ripgrep
+```
+#### Linux
+##### Ubuntu/Debian
+```shell
+sudo apt update
+sudo apt install ripgrep
+```
+##### CentOS
+```shell
+sudo yum install epel-release
+sudo yum install ripgrep
+```
+#### Windows
+```shell
+winget install BurntSushi.ripgrep.MSVC
+```
+#### 验证安装
+安装完成后，可以使用以下命令验证：
+```shell
+rg --version
+```
+选择适合你操作系统和包管理器的命令即可。推荐使用系统自带的包管理器，这样更容易管理和更新。
+
+### 安装 Zulu-CLI
+```shell
+npm install -g @comate/zulu
+```
+
+## 网络
+默认请求`https://comate.baidu.com`,如果环境未知，请执行`zulu --ping`测试连通性，如果不通：
+
+* 厂内用户可以使用export HTTP_HOST="https://comate-saas-proxy.now.baidu-int.com"修改默认请求的域名
+* 私有服务或者其他特殊场景可以设置export HTTP_HOST="xxxx"其他zulu支持的域名
+
+## 使用
+```shell
+zulu run --query="你好" --license=xxxx
+```
+命令执行后会以`STDOUT`形式返回模型完整的JSON数据日志，文件操作直接应用到文件
+
+## Command
+
+| command | 是否必须 | option | 描述 |
+|:---|:---|:---|:---|
+| run | 是 | --license | license的值 |
+| run | 是 | --query | 问题的内容 |
+| run |  | --cwd | 工作路径，默认执行时所在地址 |
+| run |  | --ripgrep | ripgrep的绝对路径 |
+|  |  | --ping | 测试网络连通性 |
+|  |  | --help | 帮助 |
+|  |  | --version | 版本号 |
+
+## Env
+
+| key | value | 描述 |
+|:---|:---|:---|
+| HTTP_PROXY | string | 设置代理 |
+| http_proxy | string | 设置代理 |
+| HTTPS_PROXY | string | 设置代理 |
+| https_proxy | string | 设置代理 |
+| HTTP_HOST | string | 设置服务地址，默认是 https://comate.baidu.com |
+| DEBUG | boolean | 打开调试日志 |
+
+
+## 调试
+* 使用环境变量`DEBUG=true`，`STDOUT`会显示debug级别的日志
+* `~/.comate-engine/store`中获取对应轮次对话的详细日志
+
+## 最佳实践
+* 请注意，`Zulu CLI`使用`Turbo`模式，黑名单是空，这也意味着`Zulu`会默认执行所以指令，请注意安全风险
+* 目前版本只支持单轮次对话，请尽量准确描述任务
+
+## Dockerfile
+```dockerfile
+FROM node:current-alpine3.22
+
+# 安装 ripgrep
+RUN apk add --no-cache ripgrep
+
+# 全局安装 @comate/zulu-cli
+RUN npm install -g @comate/zulu
+
+WORKDIR /app
+
+CMD ["zulu", "--help"]
+```

package/comate-engine/bin/comate.js

@@ -1,10 +1,41 @@
 // ================ polyfill start ================
-import { compare } from 'compare-versions';
+import {compare} from 'compare-versions';
 if (compare(process.version, '18.0.0', '<')) {
     await import('web-streams-polyfill/polyfill');
 }
 // ================= polyfill end =================
 
+// TODO 重定向到日志系统
+[
+    'log',
+    'info',
+    'warn',
+    'error',
+    'debug',
+    'trace',
+    'dir',
+    'dirxml',
+    'table',
+    'time',
+    'timeEnd',
+    'timeLog',
+    'timeStamp',
+    'group',
+    'groupCollapsed',
+    'groupEnd',
+    'count',
+    'countReset',
+    'clear',
+    'assert',
+    'profile',
+    'profileEnd',
+]
+    .forEach(key => {
+        console[key] = function () {
+            // nothing to do
+        };
+    });
+
 // 通过await import延迟加载，使得polyfill在主模块之前执行
 const {run} = await import('../server.js');
 run();