@guangnao/agent-cli 1.1.3 → 1.1.4

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.
Files changed (5) hide show
  1. package/README.md +68 -47
  2. package/dist/cli.js +12258 -0
  3. package/package.json +26 -23
  4. package/gcli.cjs +0 -941
  5. package/logo.png +0 -0
package/README.md CHANGED
@@ -1,101 +1,122 @@
1
- <!-- 用户向 README：发布到 npm 时由 scripts/bundle.mjs 拷成 dist/pkg/README.md（npm 包页展示）。 -->
1
+ <!-- 用户向 README：发布到 npm 时由 scripts/bundle.mjs 拷成 dist/pkg 内的 README.md（npm 包页展示）。 -->
2
2
  # Agent-cli（`gcli`）
3
3
 
4
- **通用 LLM 端点的终端 AI 编码助理**：在命令行里用一句话让它读改文件、执行命令、多步推理、自主把任务做完——全程走 **OpenAI 标准 `/v1`** 端点，连任意 OpenAI 兼容服务（OpenAI / DeepSeek / 自建网关等）都行。
4
+ **终端里的自主 AI 编码助理**：一句话让它读改文件、执行命令、搜代码、多步推理，自己把任务做完——构建在 AgentOS 微内核之上（进程化 Agent、计量上下文、快照/回放、会话持久化），配一层尽可能强的终端 UX。支持任意 **OpenAI 兼容 `/v1`** 端点（Guangnao / OpenAI / DeepSeek / 自建网关等）。
5
5
 
6
6
  ```sh
7
7
  npm i -g @guangnao/agent-cli
8
8
  gcli
9
9
  ```
10
10
 
11
- 装好直接敲 `gcli`，首次运行会弹引导帮你配好端点 / API Key / 模型，然后就能用。
11
+ 装好直接敲 `gcli`，首次运行会弹引导帮你选端点 / 填 Key / 选模型，然后就能用。
12
12
 
13
13
  ---
14
14
 
15
15
  ## 安装
16
16
 
17
17
  ```sh
18
- npm i -g @guangnao/agent-cli # 全局安装，得到 gcli 命令
18
+ npm i -g @guangnao/agent-cli # 全局安装，得到 gcli 命令（别名 agent-cli）
19
19
  ```
20
20
 
21
- 要求 **Node ≥ 18**。零运行时依赖（已打包），安装很快。
21
+ 要求 **Node ≥ 20.12**。**零运行时依赖**（内核与 UI 已全部打包进单文件），安装很快。
22
22
 
23
23
  ## 快速开始
24
24
 
25
- **方式一：首启引导（推荐）** —— 直接运行，按提示填即可：
25
+ **方式一：首启引导（推荐）** —— 直接运行，按提示选即可：
26
26
 
27
27
  ```sh
28
28
  gcli
29
- # → 填 API Key、端点（默认即可）、自动检测并选择模型 → 进入交互
29
+ # → 选服务商（Guangnao / DeepSeek / OpenAI / Anthropic / Gemini）→ 贴 Key → 自动列模型并选 → 进入交互
30
30
  ```
31
31
 
32
- **方式二：环境变量** —— 适合脚本 / CI / 固定配置：
32
+ 配置存到 `~/.agentos/config.json`，下次直接进，无需重填。
33
+
34
+ **方式二：环境变量** —— 适合脚本 / CI / 固定配置（**环境变量优先于已保存配置**）：
33
35
 
34
36
  ```sh
35
- export TUI_API_KEY="<你的 API Key>" # 必填
36
- export TUI_BASE_URL="https://api.openai.com/v1" # 任意 OpenAI 兼容 /v1 端点
37
- export TUI_MODEL="<模型名>" # 可选，默认按端点自动选
37
+ # 任意 OpenAI 兼容端点：
38
+ export LLM_PROVIDER="openai" # 服务商 id
39
+ export LLM_BASE_URL="https://api.openai.com/v1" # 任意 OpenAI 兼容 /v1 端点
40
+ export LLM_API_KEY="sk-..." # API Key
41
+ export LLM_MODEL="<模型名>" # 可选，默认按服务商自动选
38
42
  gcli
39
43
  ```
40
44
 
41
- > 任意 **OpenAI 兼容 `/v1`** 端点都可用：填该服务的 base URL + 对应的 API Key 即可（如 OpenAI 用 `https://api.openai.com/v1` + `sk-...`）。
45
+ 也认各服务商专属 Key（任填其一即可）：`GAPI_API_KEY`（Guangnao）·`DEEPSEEK_API_KEY`·`OPENAI_API_KEY`·`ANTHROPIC_API_KEY`·`GEMINI_API_KEY`。其它可选：`LLM_CHEAP_MODEL`（子代理 / 廉价档模型）。
46
+
47
+ > Guangnao·Gmodel 端点一把 Key 通所有模型（`api.guangnao.com`，推荐）。
42
48
 
43
49
  ## 用法
44
50
 
45
51
  ```sh
46
52
  gcli # 交互式常驻：像结对一样持续对话
47
- gcli "给这个项目补单元测试" # 一次性跑完该任务后退出
48
- gcli -y "修复所有 lint 报错" # 自动批准改文件/执行命令（脚本 / CI 用，慎用）
49
- ```
50
-
51
- 交互态里直接说需求即可——它会读代码、搜仓库、改文件（**改动/命令默认弹审批，看彩色 diff 再放行**）、跑测试验证，一步步把事做完。
52
-
53
- ## 子命令
54
-
55
- ```sh
56
- gcli reset # 清除已保存的端点 / Key / 模型（下次重新引导）
57
- gcli version # 显示版本
53
+ gcli "给这个项目补单元测试" # 一次性跑完该任务后打印结果退出
54
+ gcli version # 显示版本（亦可 -v / --version）
58
55
  ```
59
56
 
60
- **更新到最新版**：
61
-
62
- ```sh
63
- npm i -g @guangnao/agent-cli@latest
64
- ```
57
+ 交互态里直接说需求即可——它会读代码、搜仓库、改文件、跑测试验证，一步步把事做完。**改文件 / 执行命令默认弹审批，看彩色 diff 再放行。** 它还会读项目里的 `CLAUDE.md` / `AGENTS.md` 与 `package.json` 脚本，按本项目约定写代码、用对的命令做校验。
65
58
 
66
59
  ## 会话内斜杠命令
67
60
 
68
- 交互态输入 `/` 会弹出可上下选择的命令菜单。常用：
61
+ 交互态输入 `/` 会弹出可上下选择的命令菜单。完整清单：
69
62
 
70
63
  | 命令 | 作用 |
71
64
  |---|---|
72
- | `/login` | 随时换端点 / Key / 模型 |
73
- | `/models` `/model` | 上下选 / 指定模型 |
74
- | `/auto` | 切权限模式（逐项确认 / 自动改文件 / 全自动） |
75
- | `/sessions` `/resume` | 选历史会话恢复接着聊 |
76
- | `/new` `/clear` | 新会话 / 清空当前上下文 |
77
- | `/skills` | 查看 / 管理可复用技能包（Skills） |
78
- | `/memory` | 查看 / 管理项目长期记忆 |
79
- | `/theme` | 切主题强调色 |
80
- | `/tools` `/permissions` | 查看可用工具 / 权限规则 |
81
- | `/cost` | 本会话 token / 花费统计 |
82
- | `/cwd` | 切工作目录 |
83
65
  | `/help` | 全部命令与快捷键 |
66
+ | `/mode <arg>` | 权限模式：`confirm`（逐项确认）/ `auto-edits`（自动改文件）/ `auto`（全自动） |
67
+ | `/new` | 开新会话 |
68
+ | `/sessions` `/resume <id>` | 选历史会话恢复接着聊 |
69
+ | `/clear` | 清屏（历史保留） |
70
+ | `/models` | 上下选 / 切换服务商与模型 |
71
+ | `/login` | 重新连接 / 换服务商（重跑引导） |
72
+ | `/config <arg>` | 配置重置——清除已保存的 Key 并退出 |
73
+ | `/theme` | 切主题强调色 |
74
+ | `/notify` | 开关「失焦时任务完成」提醒 |
75
+ | `/voice` | 语音输入（或按 F5）：录音 → 转写 → 落进输入框 |
76
+ | `/skills` | 查看可复用技能包（Skills） |
77
+ | `/personas` `/specialize <域>` | 切专家人格 / 从记忆里铸一个领域人格 |
78
+ | `/memory` | 查看蒸馏出的项目长期经验 |
79
+ | `/cwd <path>` | 切本会话工作目录（`-g` 设全局默认） |
80
+ | `/expand <id>` | 展开被折叠的工具组，如 `/expand #e1` |
81
+ | `/version` | 显示版本 |
82
+
83
+ ## 快捷键
84
+
85
+ ```
86
+ @path 把文件内容内联进消息 Enter 发送
87
+ 粘贴 / 拖入图片 → [Image #N]（送视觉模型识图）
88
+ ↑↓ 历史 · ⌘V 粘贴 · F5 语音 · Ctrl+O 折叠计划 · Ctrl+C 打断 / 退出
89
+ ```
84
90
 
85
91
  ## 核心能力
86
92
 
87
- - **自主编码 Agent**：读文件 / 改代码 / 跑命令 / 搜代码多步自主推进，一口气把任务做完。
88
- - **并行子代理**：面大的调研一条指令并行派多个只读子代理分头摸清，再综合动手。
89
- - **自学进化**：把跑通的可复用流程沉淀成技能（手动或重复成功自动结晶）、按相关性召回；项目级长期记忆跨会话记住约定与坑——越用越强。
90
- - **视觉 / 多模态**：直接把截图 / 报错图贴进终端识图（按 OpenAI `image_url` 标准）。
91
- - **流式渲染**：旁白 / 工具卡片 / diff / 命令输出实时打字机式呈现。
93
+ - **自主编码 Agent**：读文件 / 改代码 / 跑命令 / 搜代码多步自主推进，一口气把任务做完；收尾自审、跑校验到绿才算完。
94
+ - **并行子代理**：面大的调研一条指令并行派多个只读子代理分头摸清（最多 5 个并行、其余排队），实时泳道看进度，再综合动手。
95
+ - **视觉 / 多模态**：直接把截图 / 报错图贴进终端（或拖入）识图，按 OpenAI `image_url` 标准送视觉模型——图片仅当次有效，不重复占上下文烧 token。
96
+ - **语音输入**：按 F5 录音 → 本地转写成文字落进输入框（macOS 原生设备端识别；其它系统用 whisper.cpp 回退）。
97
+ - **自学进化**：跑通的可复用流程沉淀成技能（Skills，可 `/名` 直呼）；项目级长期记忆跨会话记住约定与坑，越用越准。
98
+ - **流式渲染**：旁白 / 工具卡片 / diff / 命令输出实时打字机式呈现，markdown 边出边渲染。
92
99
  - **会话持久化**：完整历史本地留存，`/resume` 接着上次聊；上下文超限自动压缩，长任务不撑爆。
100
+ - **MCP**：放个 `mcp.json` 即接入 MCP 工具（同名内置工具优先，保安全边界）。
93
101
 
94
102
  ## 安全
95
103
 
96
104
  - 默认 **HITL 审批**：改文件 / 执行命令前弹确认，看彩色 diff 再放行。
97
- - `/auto` 可升到「自动改文件」或「全自动」；但 **危险操作**（`rm -rf`、`git push`、改密钥等）即使全自动也会拦截或强制确认。
105
+ - `/mode` 可升到 `auto-edits`（自动改文件）或 `auto`（全自动）；但**内置安全网始终在线**——毁灭性命令（`rm -rf`、写敏感文件等）即使全自动也**硬拦**，危险但偶有正当用途的操作**强制人工确认**。
106
+
107
+ ## 配置与环境变量
108
+
109
+ - 配置文件：`~/.agentos/config.json`（用 `AGENTOS_CONFIG` 改路径）。环境变量永远优先于已保存配置。
110
+ - 连接：`LLM_PROVIDER` · `LLM_BASE_URL` · `LLM_API_KEY`（或各服务商专属 Key）· `LLM_MODEL` · `LLM_CHEAP_MODEL`。
111
+ - 目录：`AGENTOS_SESSIONS_DIR`（会话）· `AGENTOS_SKILLS_DIR`（技能）· `AGENTOS_MCP_CONFIG`（MCP 配置）。
112
+ - 语音回退（非 macOS）：`REC_BIN`（sox/ffmpeg）· `WHISPER_BIN` · `WHISPER_MODEL`。
113
+
114
+ ## 更新
115
+
116
+ ```sh
117
+ npm i -g @guangnao/agent-cli@latest
118
+ ```
98
119
 
99
120
  ## 许可
100
121
 
101
- 专有软件（UNLICENSED）。
122
+ MIT。