@gird/ccli 2.0.2 → 2.0.3
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 +7 -39
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,17 +4,7 @@
|
|
|
4
4
|
[](./LICENSE)
|
|
5
5
|
[](https://nodejs.org)
|
|
6
6
|
|
|
7
|
-
**CCLI**
|
|
8
|
-
|
|
9
|
-
> ⚠️ **重建中（work in progress）**：本项目正在从零逐步重写，力求每一步都简单、可读、可运行。
|
|
10
|
-
> 当前进度见下方「实现进度」。每一步都配有说明文档，放在 [`docs/steps/`](docs/steps/)。
|
|
11
|
-
|
|
12
|
-
## 为什么重写
|
|
13
|
-
|
|
14
|
-
上一版实现一次性堆了太多功能，代码复杂到难以通读。现在推倒重来，遵循一个原则：
|
|
15
|
-
**从最小可运行的骨架开始，每次只加一个能独立讲清楚的功能，并为它写一份文档**
|
|
16
|
-
（这一步做什么、怎么做的、遇到什么问题、下一步是什么）。目标是过程可追、代码好懂，
|
|
17
|
-
最终长成一个可发布的工具。
|
|
7
|
+
**CCLI** 是一个运行在终端里的 AI 助手。在命令行直接和大模型多轮对话，回复逐字流式输出。
|
|
18
8
|
|
|
19
9
|
## 安装
|
|
20
10
|
|
|
@@ -27,20 +17,19 @@ npm install -g @gird/ccli
|
|
|
27
17
|
## 用法
|
|
28
18
|
|
|
29
19
|
```bash
|
|
30
|
-
ccli #
|
|
20
|
+
ccli # 进入交互式对话
|
|
31
21
|
ccli --version # 打印版本号
|
|
32
22
|
ccli --help # 打印帮助
|
|
33
23
|
```
|
|
34
24
|
|
|
35
|
-
|
|
25
|
+
进入对话后：
|
|
36
26
|
|
|
37
|
-
|
|
27
|
+
- 直接输入即与 AI 对话，模型会记住上文（多轮对话）。
|
|
28
|
+
- `/exit` 或 `/quit` 退出，也可按 Ctrl-C / Ctrl-D。
|
|
38
29
|
|
|
39
|
-
|
|
30
|
+
## 配置
|
|
40
31
|
|
|
41
|
-
|
|
42
|
-
export ANTHROPIC_API_KEY=sk-ant-...
|
|
43
|
-
```
|
|
32
|
+
密钥来源优先级：**环境变量 > 项目 `.env` > 全局 `~/.ccli/config.json`**。
|
|
44
33
|
|
|
45
34
|
**OpenAI 兼容（通义千问 / DeepSeek / GLM…）**
|
|
46
35
|
|
|
@@ -51,27 +40,6 @@ export QWEN_MODEL=qwen-plus
|
|
|
51
40
|
# 或通用：OPENAI_API_KEY / OPENAI_BASE_URL / OPENAI_MODEL
|
|
52
41
|
```
|
|
53
42
|
|
|
54
|
-
## 实现进度
|
|
55
|
-
|
|
56
|
-
| 步骤 | 内容 | 文档 |
|
|
57
|
-
| --- | --- | --- |
|
|
58
|
-
| 01 | 最小可执行入口 | [docs/steps/01-入口.md](docs/steps/01-入口.md) |
|
|
59
|
-
| 02 | 命令行参数解析（`--version` / `--help`） | [docs/steps/02-参数解析.md](docs/steps/02-参数解析.md) |
|
|
60
|
-
| 03 | 交互式会话循环（REPL） | [docs/steps/03-交互循环.md](docs/steps/03-交互循环.md) |
|
|
61
|
-
| 04 | 配置与密钥读取 | [docs/steps/04-配置读取.md](docs/steps/04-配置读取.md) |
|
|
62
|
-
| … | 接入 AI、工具调用、代理循环… | 进行中 |
|
|
63
|
-
|
|
64
|
-
## 本地开发
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
git clone https://github.com/GridGit/ai-cli.git
|
|
68
|
-
cd ai-cli
|
|
69
|
-
npm install
|
|
70
|
-
cp .env.example .env # 填入密钥
|
|
71
|
-
npm run dev # 用 tsx 直接运行源码（免编译）
|
|
72
|
-
npm run build # 编译到 dist/
|
|
73
|
-
```
|
|
74
|
-
|
|
75
43
|
## 许可
|
|
76
44
|
|
|
77
45
|
[MIT](./LICENSE)
|