@guangnao/agent-cli 1.0.0 → 1.0.1
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.
- package/README.md +84 -5
- package/gcli.cjs +131 -131
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,17 +1,96 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- 用户向 README：发布到 npm 时由 scripts/bundle.mjs 拷成 dist/pkg/README.md（npm 包页展示）。 -->
|
|
2
|
+
# Agent-cli（`gcli`）
|
|
2
3
|
|
|
3
|
-
|
|
4
|
+
**通用 LLM 端点的终端 AI 编码助理**：在命令行里用一句话让它读改文件、执行命令、多步推理、自主把任务做完——全程走 **OpenAI 标准 `/v1`** 端点，连任意 OpenAI 兼容服务（OpenAI / DeepSeek / 自建网关等）都行。
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
npm i -g @guangnao/agent-cli
|
|
8
|
+
gcli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
装好直接敲 `gcli`，首次运行会弹引导帮你配好端点 / API Key / 模型，然后就能用。
|
|
12
|
+
|
|
13
|
+
---
|
|
4
14
|
|
|
5
15
|
## 安装
|
|
6
16
|
|
|
7
17
|
```sh
|
|
8
|
-
npm i -g @guangnao/agent-cli
|
|
18
|
+
npm i -g @guangnao/agent-cli # 全局安装，得到 gcli 命令
|
|
9
19
|
```
|
|
10
20
|
|
|
11
|
-
|
|
21
|
+
要求 **Node ≥ 18**。零运行时依赖（已打包），安装很快。
|
|
22
|
+
|
|
23
|
+
## 快速开始
|
|
24
|
+
|
|
25
|
+
**方式一：首启引导（推荐）** —— 直接运行，按提示填即可：
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
gcli
|
|
29
|
+
# → 填 API Key、端点（默认即可）、自动检测并选择模型 → 进入交互
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**方式二：环境变量** —— 适合脚本 / CI / 固定配置：
|
|
12
33
|
|
|
13
34
|
```sh
|
|
35
|
+
export TUI_API_KEY="<你的 API Key>" # 必填
|
|
36
|
+
export TUI_BASE_URL="https://api.openai.com/v1" # 任意 OpenAI 兼容 /v1 端点
|
|
37
|
+
export TUI_MODEL="<模型名>" # 可选，默认按端点自动选
|
|
14
38
|
gcli
|
|
15
39
|
```
|
|
16
40
|
|
|
17
|
-
|
|
41
|
+
> 任意 **OpenAI 兼容 `/v1`** 端点都可用：填该服务的 base URL + 对应的 API Key 即可（如 OpenAI 用 `https://api.openai.com/v1` + `sk-...`）。
|
|
42
|
+
|
|
43
|
+
## 用法
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
gcli # 交互式常驻：像结对一样持续对话
|
|
47
|
+
gcli "给这个项目补单元测试" # 一次性跑完该任务后退出
|
|
48
|
+
gcli -y "修复所有 lint 报错" # 自动批准改文件/执行命令（脚本 / CI 用，慎用）
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
交互态里直接说需求即可——它会读代码、搜仓库、改文件（**改动/命令默认弹审批，看彩色 diff 再放行**）、跑测试验证，一步步把事做完。
|
|
52
|
+
|
|
53
|
+
## 子命令
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
gcli reset # 清除已保存的端点 / Key / 模型（下次重新引导）
|
|
57
|
+
gcli update # 更新到最新版（npm 装的也可 npm i -g @guangnao/agent-cli@latest）
|
|
58
|
+
gcli version # 显示版本
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## 会话内斜杠命令
|
|
62
|
+
|
|
63
|
+
交互态输入 `/` 会弹出可上下选择的命令菜单。常用：
|
|
64
|
+
|
|
65
|
+
| 命令 | 作用 |
|
|
66
|
+
|---|---|
|
|
67
|
+
| `/login` | 随时换端点 / Key / 模型 |
|
|
68
|
+
| `/models` `/model` | 上下选 / 指定模型 |
|
|
69
|
+
| `/auto` | 切权限模式（逐项确认 / 自动改文件 / 全自动） |
|
|
70
|
+
| `/sessions` `/resume` | 选历史会话恢复接着聊 |
|
|
71
|
+
| `/new` `/clear` | 新会话 / 清空当前上下文 |
|
|
72
|
+
| `/skills` | 查看 / 管理可复用技能包（Skills） |
|
|
73
|
+
| `/memory` | 查看 / 管理项目长期记忆 |
|
|
74
|
+
| `/theme` | 切主题强调色 |
|
|
75
|
+
| `/tools` `/permissions` | 查看可用工具 / 权限规则 |
|
|
76
|
+
| `/cost` | 本会话 token / 花费统计 |
|
|
77
|
+
| `/cwd` | 切工作目录 |
|
|
78
|
+
| `/help` | 全部命令与快捷键 |
|
|
79
|
+
|
|
80
|
+
## 核心能力
|
|
81
|
+
|
|
82
|
+
- **自主编码 Agent**：读文件 / 改代码 / 跑命令 / 搜代码多步自主推进，一口气把任务做完。
|
|
83
|
+
- **并行子代理**：面大的调研一条指令并行派多个只读子代理分头摸清，再综合动手。
|
|
84
|
+
- **自学进化**：把跑通的可复用流程沉淀成技能（手动或重复成功自动结晶）、按相关性召回；项目级长期记忆跨会话记住约定与坑——越用越强。
|
|
85
|
+
- **视觉 / 多模态**：直接把截图 / 报错图贴进终端识图（按 OpenAI `image_url` 标准）。
|
|
86
|
+
- **流式渲染**：旁白 / 工具卡片 / diff / 命令输出实时打字机式呈现。
|
|
87
|
+
- **会话持久化**：完整历史本地留存，`/resume` 接着上次聊；上下文超限自动压缩，长任务不撑爆。
|
|
88
|
+
|
|
89
|
+
## 安全
|
|
90
|
+
|
|
91
|
+
- 默认 **HITL 审批**：改文件 / 执行命令前弹确认，看彩色 diff 再放行。
|
|
92
|
+
- `/auto` 可升到「自动改文件」或「全自动」；但 **危险操作**（`rm -rf`、`git push`、改密钥等）即使全自动也会拦截或强制确认。
|
|
93
|
+
|
|
94
|
+
## 许可
|
|
95
|
+
|
|
96
|
+
专有软件（UNLICENSED）。
|