@kriston-ai/kst-im-cli 0.0.8 → 0.0.9
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 +115 -109
- package/dist/index.js +72 -72
- package/package.json +1 -1
- package/skills/kst-im-cli/SKILL.md +23 -3
package/README.md
CHANGED
|
@@ -1,109 +1,115 @@
|
|
|
1
|
-
# kst-im-cli
|
|
2
|
-
|
|
3
|
-
快商通 IM 命令行工具，用于管理渠道账号、网页站点、查询统计看板和历史会话。
|
|
4
|
-
|
|
5
|
-
## 安装
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install -g @kriston-ai/kst-im-cli
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
需要 Node.js >= 18。
|
|
12
|
-
|
|
13
|
-
## 快速开始
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
# 登录
|
|
17
|
-
kst-im-cli auth login -k <API_KEY>
|
|
18
|
-
|
|
19
|
-
#
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
kst-im-cli
|
|
25
|
-
|
|
26
|
-
#
|
|
27
|
-
kst-im-cli
|
|
28
|
-
kst-im-cli
|
|
29
|
-
|
|
30
|
-
#
|
|
31
|
-
kst-im-cli
|
|
32
|
-
kst-im-cli
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
kst-im-cli
|
|
37
|
-
kst-im-cli
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
|
48
|
-
|
|
49
|
-
| `
|
|
50
|
-
| `
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
55
|
-
| `
|
|
56
|
-
| `
|
|
57
|
-
| `
|
|
58
|
-
| `
|
|
59
|
-
| `
|
|
60
|
-
| `
|
|
61
|
-
| `
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
##
|
|
108
|
-
|
|
109
|
-
|
|
1
|
+
# kst-im-cli
|
|
2
|
+
|
|
3
|
+
快商通 IM 命令行工具，用于管理渠道账号、网页站点、查询统计看板和历史会话。
|
|
4
|
+
|
|
5
|
+
## 安装
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @kriston-ai/kst-im-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
需要 Node.js >= 18。
|
|
12
|
+
|
|
13
|
+
## 快速开始
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# 登录
|
|
17
|
+
kst-im-cli auth login -k <API_KEY>
|
|
18
|
+
|
|
19
|
+
# Agent / CI：通过环境变量注入 key，无需 auth login
|
|
20
|
+
export KST_ONLINE_CLI_API_KEY=<API_KEY>
|
|
21
|
+
kst-im-cli channel type list
|
|
22
|
+
|
|
23
|
+
# 查看登录状态
|
|
24
|
+
kst-im-cli auth status
|
|
25
|
+
|
|
26
|
+
# 渠道账号
|
|
27
|
+
kst-im-cli channel type list
|
|
28
|
+
kst-im-cli channel account list --channelKey weixin
|
|
29
|
+
|
|
30
|
+
# 网页站点
|
|
31
|
+
kst-im-cli site list
|
|
32
|
+
kst-im-cli site get --siteId 118501
|
|
33
|
+
|
|
34
|
+
# 统计看板
|
|
35
|
+
kst-im-cli stats init
|
|
36
|
+
kst-im-cli stats basic-board channel --period today --accounts 101,102
|
|
37
|
+
kst-im-cli stats basic-board web --period today --sites 118501,118503
|
|
38
|
+
|
|
39
|
+
# 历史会话
|
|
40
|
+
kst-im-cli history schema
|
|
41
|
+
kst-im-cli history web --start "2026-06-01 00:00:00" --end "2026-06-03 23:59:59"
|
|
42
|
+
kst-im-cli history channel --start "2026-06-01 00:00:00" --end "2026-06-03 23:59:59"
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## 命令列表
|
|
46
|
+
|
|
47
|
+
| 命令 | 说明 |
|
|
48
|
+
|------|------|
|
|
49
|
+
| `auth login -k <key>` | 登录认证 |
|
|
50
|
+
| `auth logout` | 登出 |
|
|
51
|
+
| `auth status` | 查看登录状态 |
|
|
52
|
+
| `config get <key>` | 获取配置项 |
|
|
53
|
+
| `config set <key> <value>` | 设置配置项 |
|
|
54
|
+
| `channel type list` | 列出渠道类型 |
|
|
55
|
+
| `channel type get --key <key>` | 查询单个渠道类型 |
|
|
56
|
+
| `channel account list [--channelKey <keys>] [--keyword <text>]` | 列出渠道账号 |
|
|
57
|
+
| `channel account get --accountId <id>` | 查询单个渠道账号 |
|
|
58
|
+
| `site list [--with-codes]` | 列出网页站点 |
|
|
59
|
+
| `site get --siteId <id> [--with-codes]` | 查询单个站点 |
|
|
60
|
+
| `stats init` | 拉取并缓存统计基础数据 |
|
|
61
|
+
| `stats basic-board channel` | 渠道基础看板 |
|
|
62
|
+
| `stats basic-board web` | 网页站点看板 |
|
|
63
|
+
| `history schema` | 历史记录字段说明 |
|
|
64
|
+
| `history web --start <time> --end <time>` | 查询网页历史会话 |
|
|
65
|
+
| `history channel --start <time> --end <time>` | 查询渠道历史会话 |
|
|
66
|
+
|
|
67
|
+
## 输出格式
|
|
68
|
+
|
|
69
|
+
所有命令支持 `--format` 选项：
|
|
70
|
+
|
|
71
|
+
- `json` — JSON 信封（默认）：`{ ok: true, data: ..., meta: { count: N } }`
|
|
72
|
+
- `table` — 表格
|
|
73
|
+
- `pretty` — 格式化 JSON
|
|
74
|
+
|
|
75
|
+
## 统计看板用法
|
|
76
|
+
|
|
77
|
+
### 时间范围
|
|
78
|
+
|
|
79
|
+
`--period` 快捷值：`today`、`yesterday`、`week`、`last-week`
|
|
80
|
+
|
|
81
|
+
也可用自定义时间：`--start "yyyy-MM-dd HH:mm:ss" --end "yyyy-MM-dd HH:mm:ss"`
|
|
82
|
+
|
|
83
|
+
两者互斥。
|
|
84
|
+
|
|
85
|
+
### 筛选对象
|
|
86
|
+
|
|
87
|
+
- `--accounts <ids>`：渠道账号 ID（逗号分隔，来源 `channel account list`）
|
|
88
|
+
- `--sites <ids>`：站点 ID（逗号分隔，来源 `site list`）
|
|
89
|
+
|
|
90
|
+
省略则查询全部对象的指标汇总。
|
|
91
|
+
|
|
92
|
+
## 历史会话用法
|
|
93
|
+
|
|
94
|
+
查询前建议先执行 `history schema` 了解返回字段含义。
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
kst-im-cli history web \
|
|
98
|
+
--start "2026-06-01 00:00:00" \
|
|
99
|
+
--end "2026-06-03 23:59:59" \
|
|
100
|
+
--site-ids 118501,118504 \
|
|
101
|
+
--page 1 --page-size 500
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
- `--page-size` 最大 1000，大范围查询请分页
|
|
105
|
+
- 时间格式固定为 `yyyy-MM-dd HH:mm:ss`
|
|
106
|
+
|
|
107
|
+
## 配置
|
|
108
|
+
|
|
109
|
+
配置文件位于 `~/.config/.kst-im-cli/config.json`，可通过环境变量 `KST_IM_CLI_CONFIG_DIR` 覆盖路径。
|
|
110
|
+
|
|
111
|
+
API Key 也可通过环境变量 `KST_ONLINE_CLI_API_KEY` 注入（优先级高于配置文件），适合 Agent 沙箱场景。
|
|
112
|
+
|
|
113
|
+
## License
|
|
114
|
+
|
|
115
|
+
ISC
|