@comate/comatecli
v1.0.5
Published
Comate of Terminal —— 交互式终端 AI 编码助手
Downloads
1,270
Readme
Comate of Terminal
comatecli —— 交互式终端 AI 编码助手。裸 comatecli 进入交互式对话,comatecli <子命令>
提供完整的命令行能力。
安装
npm install -g comatecli安装后即可在任意目录使用 comatecli 命令(需 Node.js ≥ 20.10.0)。
使用
comatecli # 交互式终端对话(默认)
comatecli --help # 帮助 + 子命令清单(亦可 comatecli help)
comatecli --version # 版本
comatecli run -q "重构这个模块" --display event-stream # 主 agent(headless,流式 JSON)
comatecli serve --port 8000 # 本地 HTTP SSE 服务(comatecli serve kill 关闭)
comatecli search --query "关键词" # 本地代码搜索
comatecli inspect # 列 rules/mcp/agents/commands/skills
comatecli list-model # 可用模型
comatecli skill install <name|zip|url> # 安装 skill
comatecli indexing # 本地代码库索引
comatecli ping # 连通性自检
comatecli config model_token <token> # 写配置各子命令的完整选项见 comatecli <子命令> --help(如 comatecli run --help)。
包内容与运行结构
comatecli 是自包含发布产物——npm install 后即可运行,不再额外拉取运行时依赖。包内主要内容:
| 路径 | 作用 |
|------|------|
| bin/zulu-tui.mjs | 可执行入口 / 启动器:Node 版本预检、参数解析,按需加载交互界面或命令行核心 |
| dist/index.js | 交互式终端界面的打包产物 |
| dist/zulu/index.js | 命令行核心(各子命令能力)的打包产物;交互对话的真实模式也由它承载 |
| comate-engine/ | 内嵌 AI 引擎,运行时以独立子进程启动(可用环境变量 COMATE_ENGINE_PATH 指向外部引擎覆盖) |
| comate-engine/node_modules/ | 引擎的原生依赖(本地代码索引 / 搜索用的 sqlite-vec、tree-sitter 等多平台二进制),因平台相关无法内联进 JS,随包分发 |
| scripts/postinstall.js | 安装钩子:自举 ripgrep(系统已装 rg ≥ 12 直接复用,否则下载预编译二进制到包内) |
三个 JS 主体(界面 / 命令行核心 / 引擎)均为经打包压缩(minified)的单文件;原生二进制与
ripgrep因平台相关无法并入 JS,随包分发。引擎作为独立子进程运行,与主进程隔离。
