@zhizai/cli 0.0.3 → 0.0.5
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 +18 -40
- package/package.json +1 -1
- package/skills/zhizai-auth/SKILL.md +5 -2
- package/skills/zhizai-knowledge/SKILL.md +5 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
查笔记、写总结、管知识库——一条命令搞定,支持脚本和 AI Agent 调用。
|
|
6
6
|
|
|
7
|
-
> **当前版本:v0.0.
|
|
7
|
+
> **当前版本:v0.0.4**
|
|
8
8
|
> 已可用:`auth` / `doctor` / `capabilities` / `version` / `notes` / `note get` / `setup`。
|
|
9
9
|
> 其余业务命令(`note create` / `ask` / `team` 等)子命令已挂载,能力逐步完善中。
|
|
10
10
|
|
|
@@ -38,9 +38,7 @@ zz version
|
|
|
38
38
|
|
|
39
39
|
## 使用要求
|
|
40
40
|
|
|
41
|
-
-
|
|
42
|
-
- 获取入口:[智在记录开发者](https://www.zzjilu.com/pc/developer)
|
|
43
|
-
- 请求头:`Authorization: <api-key>`(**不要**加 `Bearer`)
|
|
41
|
+
- 通过 `zhizai auth login` 完成**网页授权登录**
|
|
44
42
|
- 限流:最高约 **2 次/秒**
|
|
45
43
|
|
|
46
44
|
---
|
|
@@ -50,19 +48,15 @@ zz version
|
|
|
50
48
|
### 1. 登录
|
|
51
49
|
|
|
52
50
|
```bash
|
|
53
|
-
# 直接传入 API Key(推荐脚本 / CI)
|
|
54
|
-
zhizai auth login --api-key <your-api-key>
|
|
55
|
-
|
|
56
|
-
# 或交互粘贴
|
|
57
51
|
zhizai auth login
|
|
58
52
|
```
|
|
59
53
|
|
|
60
|
-
|
|
54
|
+
按提示在浏览器确认授权即可。登录成功后写入 `~/.zhizai/config.json`。
|
|
61
55
|
|
|
62
|
-
|
|
56
|
+
刷新 OAuth access_token(业务请求也会在过期时自动刷新):
|
|
63
57
|
|
|
64
58
|
```bash
|
|
65
|
-
|
|
59
|
+
zhizai auth refresh
|
|
66
60
|
```
|
|
67
61
|
|
|
68
62
|
### 2. 检查状态
|
|
@@ -106,14 +100,18 @@ zhizai setup
|
|
|
106
100
|
|
|
107
101
|
| 命令 | 说明 |
|
|
108
102
|
|------|------|
|
|
109
|
-
| `zhizai auth login
|
|
110
|
-
| `zhizai auth
|
|
103
|
+
| `zhizai auth login` | 网页设备授权登录 |
|
|
104
|
+
| `zhizai auth refresh` | 刷新 OAuth access_token |
|
|
105
|
+
| `zhizai auth status` | 查看认证状态(凭证掩码) |
|
|
111
106
|
| `zhizai auth logout` | 清除本机凭证 |
|
|
112
107
|
| `zhizai doctor` | 检查安装、登录与 API 连通性 |
|
|
113
108
|
| `zhizai capabilities` | 查看当前版本的稳定能力契约 |
|
|
114
109
|
| `zhizai version` | 显示版本 |
|
|
115
110
|
| `zhizai notes [--limit\|--page\|--all]` | 笔记列表 |
|
|
116
111
|
| `zhizai note get <id> [--field ...]` | 笔记详情 |
|
|
112
|
+
| `zhizai knowledge list [--received]` | 笔记集列表(我创建的 / 收到的) |
|
|
113
|
+
| `zhizai knowledge get <id>` | 笔记集详情 |
|
|
114
|
+
| `zhizai knowledge notes <id>` | 笔记集内笔记 |
|
|
117
115
|
| `zhizai setup [--dry-run]` | 为本机 AI 安装原子 Skill 并引导授权 |
|
|
118
116
|
|
|
119
117
|
### 规划中
|
|
@@ -121,10 +119,10 @@ zhizai setup
|
|
|
121
119
|
| 命令 | 说明 |
|
|
122
120
|
|------|------|
|
|
123
121
|
| `zhizai note create\|update\|delete\|status` | 笔记写入与状态 |
|
|
122
|
+
| `zhizai knowledge create` | 新建笔记集(后端接口待开放) |
|
|
124
123
|
| `zhizai file upload` | 文件上传 |
|
|
125
124
|
| `zhizai ask "<问题>"` | 基于笔记的动态模版问答 / 总结 |
|
|
126
125
|
| `zhizai scene` | 场景与知识卡 |
|
|
127
|
-
| `zhizai knowledge` | 笔记集 |
|
|
128
126
|
| `zhizai team` | 团队与成员 |
|
|
129
127
|
| `zhizai msg` | 消息与录音卡 |
|
|
130
128
|
| `zhizai update` | 升级 CLI 并同步 Skill |
|
|
@@ -135,7 +133,6 @@ zhizai setup
|
|
|
135
133
|
|
|
136
134
|
| 参数 | 说明 |
|
|
137
135
|
|------|------|
|
|
138
|
-
| `--api-key <key>` | 临时覆盖 API Key |
|
|
139
136
|
| `-o, --output table\|json` | 输出格式(默认 `table`) |
|
|
140
137
|
|
|
141
138
|
机器 / AI Agent 调用时请加 `-o json`,统一读取:
|
|
@@ -154,36 +151,17 @@ zhizai setup
|
|
|
154
151
|
|
|
155
152
|
## 配置
|
|
156
153
|
|
|
157
|
-
凭证保存在 `~/.zhizai/config.json
|
|
158
|
-
|
|
159
|
-
```json
|
|
160
|
-
{
|
|
161
|
-
"api_key": "xxxx",
|
|
162
|
-
"expires_at": "2027-12-31 23:59:59",
|
|
163
|
-
"team_id": ""
|
|
164
|
-
}
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
凭证优先级:
|
|
168
|
-
|
|
169
|
-
```text
|
|
170
|
-
--api-key > 环境变量 ZHIZAI_REC_API_KEY > ~/.zhizai/config.json
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
| 环境变量 | 说明 |
|
|
174
|
-
|----------|------|
|
|
175
|
-
| `ZHIZAI_REC_API_KEY` | API Key |
|
|
176
|
-
| `ZHIZAI_API_URL` | 覆盖 API 基址(默认 `https://openapi.zzjilu.com/api/v1`) |
|
|
154
|
+
凭证保存在 `~/.zhizai/config.json`(含 OAuth `access_token` / `refresh_token` 等字段)。
|
|
177
155
|
|
|
178
156
|
### 鉴权说明
|
|
179
157
|
|
|
180
|
-
|
|
158
|
+
默认使用 **OAuth 设备授权**:`zhizai auth login` → 浏览器确认 → 业务请求头 `X-OAuth2-Access-Token: Bearer …`。
|
|
159
|
+
|
|
160
|
+
无头 / 连接器场景使用 `zhizai auth login --no-open`:不打开系统浏览器,打印 `[verify_url]` / `[device_code]` / `[expires_in]` / `[interval]`,后台继续轮询直至授权完成。
|
|
181
161
|
|
|
182
|
-
|
|
183
|
-
2. `zhizai auth login --api-key ...` 保存并探活
|
|
184
|
-
3. 后续请求自动带 `Authorization: <api-key>`
|
|
162
|
+
OAuth 过期时 CLI 会自动用 `refresh_token` 刷新;也可手动 `zhizai auth refresh`。
|
|
185
163
|
|
|
186
|
-
|
|
164
|
+
仅当网页授权失败时,CLI 会提示可改用 API Key 备用登录。
|
|
187
165
|
|
|
188
166
|
---
|
|
189
167
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: zhizai-auth
|
|
3
|
-
description:
|
|
3
|
+
description: 安装和连接智在记录,完成网页授权登录、环境诊断与 CLI 升级。用户说安装、连接、登录、检查为什么不能用时使用。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# 智在记录连接与诊断
|
|
@@ -11,9 +11,12 @@ description: 安装和连接智在记录,完成 API Key 配置、环境诊断
|
|
|
11
11
|
|
|
12
12
|
| 意图 | 命令 |
|
|
13
13
|
|---|---|
|
|
14
|
-
| 登录 | `zhizai auth login
|
|
14
|
+
| 登录 | `zhizai auth login` |
|
|
15
|
+
| 无头/连接器登录 | `zhizai auth login --no-open` |
|
|
15
16
|
| 查看状态 | `zhizai auth status` |
|
|
16
17
|
| 退出 | `zhizai auth logout` |
|
|
17
18
|
| 诊断 | `zhizai doctor -o json` |
|
|
18
19
|
| 能力契约 | `zhizai capabilities -o json` |
|
|
19
20
|
| 安装 Skill | `zhizai setup` |
|
|
21
|
+
|
|
22
|
+
默认使用网页设备授权。`--no-open` 时不打开浏览器,打印 `[verify_url]` / `[device_code]` / `[expires_in]` / `[interval]` 供宿主展示,后台继续轮询。仅当网页授权失败时,再提示用户使用 `zhizai auth login --api-key <key>`。
|
|
@@ -7,6 +7,10 @@ description: 查询和管理智在记录笔记集。
|
|
|
7
7
|
|
|
8
8
|
| 意图 | 命令 |
|
|
9
9
|
|---|---|
|
|
10
|
-
|
|
|
10
|
+
| 我创建的笔记集 | `zhizai knowledge list -o json` |
|
|
11
|
+
| 我收到的笔记集 | `zhizai knowledge list --received -o json` |
|
|
12
|
+
| 笔记集详情 | `zhizai knowledge get <id> -o json` |
|
|
13
|
+
| 集内笔记 | `zhizai knowledge notes <id> -o json` |
|
|
14
|
+
| 新建笔记集 | `zhizai knowledge create --name <名称>`(后端待开放) |
|
|
11
15
|
|
|
12
16
|
字段说明见 `skills/zhiji-open-platform/references/knowledge.md`。
|