@seeed-studio/sensecraft-cli 0.3.2 → 0.4.0
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/INSTALL.md +151 -190
- package/README-zh.md +463 -0
- package/README.md +9 -13
- package/package.json +2 -1
- package/scripts/test-install.js +1 -1
- package/skills/README.md +14 -35
- package/skills/sensecraft-cli/SKILL.md +131 -0
- package/skills/{sensecraft-apps → sensecraft-cli}/create-app/SKILL.md +16 -16
- package/skills/{sensecraft-apps → sensecraft-cli}/create-app/assets/manifest-template.json +1 -1
- package/skills/{sensecraft-apps/create-app/reference-manifest.md → sensecraft-cli/create-app/references/manifest.md} +17 -14
- package/skills/{sensecraft-apps/commands.md → sensecraft-cli/references/app-commands.md} +8 -10
- package/skills/{sensecraft-apps/reference-app-fields.md → sensecraft-cli/references/app-fields.md} +2 -2
- package/skills/{sensecraft-apps/SKILL.md → sensecraft-cli/references/apps.md} +26 -38
- package/skills/{sensecraft-devices-cloud/commands.md → sensecraft-cli/references/cloud-commands.md} +1 -1
- package/skills/{sensecraft-devices-cloud/SKILL.md → sensecraft-cli/references/cloud.md} +4 -14
- package/skills/{confirmation.md → sensecraft-cli/references/confirmation.md} +2 -2
- package/skills/{sensecraft-data/commands.md → sensecraft-cli/references/data-commands.md} +2 -2
- package/skills/{sensecraft-data/SKILL.md → sensecraft-cli/references/data.md} +10 -18
- package/skills/{sensecraft-files/commands.md → sensecraft-cli/references/file-commands.md} +1 -1
- package/skills/{sensecraft-files/SKILL.md → sensecraft-cli/references/files.md} +3 -11
- package/skills/{sensecraft-models/commands.md → sensecraft-cli/references/model-commands.md} +5 -5
- package/skills/{sensecraft-models/SKILL.md → sensecraft-cli/references/models.md} +17 -27
- package/skills/{sensecraft-recamera/commands.md → sensecraft-cli/references/recamera-commands.md} +3 -3
- package/skills/{sensecraft-recamera/SKILL.md → sensecraft-cli/references/recamera.md} +6 -16
- package/skills/{sensecraft-apps/reference-tool-blocks.md → sensecraft-cli/references/tool-blocks.md} +19 -3
- package/skills/sensecraft-ai/SKILL.md +0 -134
- /package/skills/{sensecraft-apps → sensecraft-cli}/create-app/assets/validate_manifest.py +0 -0
- /package/skills/{sensecraft-models/reference-model-fields.md → sensecraft-cli/references/model-fields.md} +0 -0
package/README-zh.md
ADDED
|
@@ -0,0 +1,463 @@
|
|
|
1
|
+
# SenseCraft CLI
|
|
2
|
+
|
|
3
|
+
[English](README.md) | 中文
|
|
4
|
+
|
|
5
|
+
SenseCraft CLI(`sensecraft-cli`)是 [SenseCraft](https://sensecraft.seeed.cc) 的官方命令行工具,供开发者和 AI Agent 使用。可以在终端里读取传感数据、创建模型、发布应用,并管理设备和 reCamera。
|
|
6
|
+
|
|
7
|
+
它覆盖这三块产品:
|
|
8
|
+
|
|
9
|
+
| 产品 | 管什么 | 子命令 |
|
|
10
|
+
|------|--------|--------|
|
|
11
|
+
| [SenseCraft Data](https://sensecap.seeed.cc) | 设备、分组、传感数据 | `device` · `group` · `data` |
|
|
12
|
+
| [SenseCraft AI](https://sensecraft.seeed.cc) | 模型库,以及 reCamera | `model` · `recamera` · `cloud` |
|
|
13
|
+
| [CodeCraft Hub](https://codecraft.seeed.cc/hub) | 应用 | `app` |
|
|
14
|
+
|
|
15
|
+
三个平台均以开放 Access Key 访问。在 [SenseCraft 用户中心](https://account.seeed.cc/account/access-keys) 创建和管理钥匙,再用 `auth add` 写入本机。运行 `auth init`,使用 OAuth2 Device Flow 授权 CLI 访问你的账号。
|
|
16
|
+
|
|
17
|
+
也可以放进脚本和 CI。Agent Skills 见 `skills/`。
|
|
18
|
+
|
|
19
|
+
**安装与排障请先读 → [`INSTALL.md`](INSTALL.md)**(平台要求、PATH、升级卸载、离线镜像、Cursor Skills)。
|
|
20
|
+
|
|
21
|
+
## 环境要求
|
|
22
|
+
|
|
23
|
+
- Node.js >= 16(用于 npm 安装与分发)
|
|
24
|
+
- 构建源码:Go(见 `go.mod`)
|
|
25
|
+
|
|
26
|
+
## 安装
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx @seeed-studio/sensecraft-cli install
|
|
30
|
+
sensecraft-cli --version
|
|
31
|
+
sensecraft-cli update
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
完整步骤、Windows PATH、离线安装与 Skills 接入见 [`INSTALL.md`](INSTALL.md)。
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
sensecraft-cli --help
|
|
38
|
+
# 或
|
|
39
|
+
npx @seeed-studio/sensecraft-cli device list
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 快速开始
|
|
43
|
+
|
|
44
|
+
### 1. 初始化认证
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
# 使用 OAuth2 Device Flow 授权 CLI 访问你的账号。交互选择站点:Global / China
|
|
48
|
+
sensecraft-cli auth init
|
|
49
|
+
|
|
50
|
+
# 已在账号页创建好钥匙时,直接写入本机
|
|
51
|
+
sensecraft-cli auth add --key-id <Key ID> --access-key <Access Key>
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
创建和管理 Access Key:<https://account.seeed.cc/account/access-keys>。
|
|
55
|
+
|
|
56
|
+
中国站仅支持 SenseCraft Data。如果需要使用 SenseCraft CLI 访问 SenseCraft AI 和 CodeCraft Hub,请选择国际站(Global)。
|
|
57
|
+
|
|
58
|
+
### 2. 查看配置
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
sensecraft-cli auth info
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### 3. 示例
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# SenseCraft Data
|
|
68
|
+
sensecraft-cli device list
|
|
69
|
+
sensecraft-cli data latest --eui <EUI>
|
|
70
|
+
|
|
71
|
+
# SenseCraft AI。任务编号用 model constants 查,不要猜一个数字
|
|
72
|
+
sensecraft-cli model constants
|
|
73
|
+
sensecraft-cli model list --public --uniform-type 40
|
|
74
|
+
sensecraft-cli recamera check --model-id <id>
|
|
75
|
+
sensecraft-cli recamera open --model-id <id> --print-only
|
|
76
|
+
sensecraft-cli cloud device list --uniform-type 26
|
|
77
|
+
|
|
78
|
+
# CodeCraft Hub
|
|
79
|
+
sensecraft-cli app list --public --name "vision"
|
|
80
|
+
sensecraft-cli app list --public --uniform-type 40
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
`--uniform-type`:`40` 是 reCamera,`32` 是 XIAO ESP32S3,`53` 是 reCamera Pro。`cloud device list` 里的 `26` 是 Jetson 云设备界面常用的设备类型。
|
|
84
|
+
|
|
85
|
+
删除、解绑、发布、部署这类写操作必须加 `--yes`。Agent 的确认步骤见 [skills/sensecraft-cli/references/confirmation.md](skills/sensecraft-cli/references/confirmation.md)。
|
|
86
|
+
|
|
87
|
+
## 配置
|
|
88
|
+
|
|
89
|
+
| 项 | 说明 |
|
|
90
|
+
|----|------|
|
|
91
|
+
| npm 安装默认 | macOS/Linux:`~/.config/sensecraft-cli/sensecraft.json`;Windows:`%APPDATA%\sensecraft-cli\sensecraft.json`(wrapper 注入 `SENSECRAFT_CLI_PATH`) |
|
|
92
|
+
| 源码直接运行默认 | 当前工作目录下的 `sensecraft.json` |
|
|
93
|
+
| `SENSECRAFT_CLI_PATH` | 配置目录(文件名为 `sensecraft.json`) |
|
|
94
|
+
| `SENSECRAFT_CONFIG_FILE` | 配置文件完整路径(优先于上面两项) |
|
|
95
|
+
|
|
96
|
+
## 输出格式
|
|
97
|
+
|
|
98
|
+
- 业务命令成功:stdout JSON(缩进 2 空格)
|
|
99
|
+
- `auth info` / `auth init`:人类可读文本(非 JSON)
|
|
100
|
+
- 失败:stderr + 非 0 退出码
|
|
101
|
+
- 版本:`sensecraft-cli --version`(与 npm 包版本一致)
|
|
102
|
+
|
|
103
|
+
## 用在脚本和 CI
|
|
104
|
+
|
|
105
|
+
无交互环境不会打开浏览器。用 `auth add` 写入钥匙,并用 `SENSECRAFT_CONFIG_FILE` 指到项目自己的配置文件,避免写进本机的 `~/.config/sensecraft-cli/`。
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
export SENSECRAFT_CONFIG_FILE="$PWD/.sensecraft/sensecraft.json"
|
|
109
|
+
sensecraft-cli auth add \
|
|
110
|
+
--key-id "$SENSECRAFT_KEY_ID" \
|
|
111
|
+
--access-key "$SENSECRAFT_ACCESS_KEY" \
|
|
112
|
+
--site Global
|
|
113
|
+
sensecraft-cli device list
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
这个文件含有 Access Key,不要提交到仓库。`--site` 省略时是 `Global`。业务命令成功时解析 stdout 的 JSON;失败看退出码,错误在 stderr。`auth info` 的输出是文本。
|
|
117
|
+
|
|
118
|
+
## AI Agent Skills
|
|
119
|
+
|
|
120
|
+
入口是 [`skills/sensecraft-cli/SKILL.md`](skills/sensecraft-cli/SKILL.md)。设备、模型、应用等说明在 `skills/sensecraft-cli/references/`。从本地工程生成应用用嵌套技能 `skills/sensecraft-cli/create-app/`。
|
|
121
|
+
|
|
122
|
+
安装后把这个目录软链到 Agent 的技能目录,不要复制。升级 CLI 时技能会一起更新。步骤见 [`INSTALL.md` §9](INSTALL.md#9-agent-skills-cursor-and-others)。
|
|
123
|
+
|
|
124
|
+
## 从源码构建
|
|
125
|
+
|
|
126
|
+
完整说明见 [`INSTALL.md` §8](INSTALL.md#8-build-from-source)。摘要:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
# 本机调试
|
|
130
|
+
go build -o sensecraft-cli .
|
|
131
|
+
./sensecraft-cli --version
|
|
132
|
+
|
|
133
|
+
# 多平台发布二进制 → dist/(注入 -ldflags 版本信息)
|
|
134
|
+
./script/build.sh
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
贡献本仓库时的自检:`./script/smoke-ai.sh`、`./script/smoke-sensecap.sh`。隔离安装检查要先 `./script/build.sh`,再在 `packages/cli` 里运行 `npm run test:install`。使用 CLI 的项目不需要这些脚本。
|
|
138
|
+
|
|
139
|
+
## 许可证
|
|
140
|
+
|
|
141
|
+
[MIT](LICENSE)
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## 命令文档
|
|
146
|
+
|
|
147
|
+
本文展开 SenseCraft Data。其它命令的参数、限制和示例:
|
|
148
|
+
|
|
149
|
+
| 范围 | 文档 |
|
|
150
|
+
|------|------|
|
|
151
|
+
| SenseCraft Data | [data-commands.md](skills/sensecraft-cli/references/data-commands.md) |
|
|
152
|
+
| 模型库 | [model-commands.md](skills/sensecraft-cli/references/model-commands.md) |
|
|
153
|
+
| reCamera | [recamera-commands.md](skills/sensecraft-cli/references/recamera-commands.md) |
|
|
154
|
+
| 云设备部署与订单 | [cloud-commands.md](skills/sensecraft-cli/references/cloud-commands.md) |
|
|
155
|
+
| CodeCraft Hub 应用 | [app-commands.md](skills/sensecraft-cli/references/app-commands.md) |
|
|
156
|
+
| 文件上传 | [file-commands.md](skills/sensecraft-cli/references/file-commands.md) |
|
|
157
|
+
|
|
158
|
+
## 命令参考(SenseCraft Data)
|
|
159
|
+
|
|
160
|
+
### auth — 认证与配置
|
|
161
|
+
|
|
162
|
+
#### `auth init`
|
|
163
|
+
|
|
164
|
+
使用 OAuth2 Device Flow 授权 CLI 访问你的账号。交互选择站点:Global / China。
|
|
165
|
+
|
|
166
|
+
| 参数 | 说明 |
|
|
167
|
+
|------|------|
|
|
168
|
+
| `--sandbox` | 沙盒:不发真实网络请求 |
|
|
169
|
+
|
|
170
|
+
#### `auth add`
|
|
171
|
+
|
|
172
|
+
把已有的 Access Key 写入本机,并设为当前钥匙。无交互环境必须带上 `--key-id` 和 `--access-key`。
|
|
173
|
+
|
|
174
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
175
|
+
|------|------|--------|------|
|
|
176
|
+
| `--key-id` | 交互终端可省略 | — | Key ID |
|
|
177
|
+
| `--access-key` | 交互终端可省略 | — | Access Key |
|
|
178
|
+
| `--site` | 否 | `Global` | `Global` 或 `China` |
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
sensecraft-cli auth add --key-id <Key ID> --access-key <Access Key> --site Global
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
#### `auth info`
|
|
185
|
+
|
|
186
|
+
`info` 展示当前 Access Key 的站点、组织 ID 和 Key ID,不打印密钥。
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
### device — 设备管理(SenseCraft Data)
|
|
191
|
+
|
|
192
|
+
#### `device list`
|
|
193
|
+
|
|
194
|
+
获取当前账号下的设备列表。
|
|
195
|
+
|
|
196
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
197
|
+
|------|------|--------|------|
|
|
198
|
+
| `--device-type` | 否 | `2` | 设备类型:`1`=网关,`2`=节点,`3`=开发套件 |
|
|
199
|
+
| `--group-uuid` | 否 | — | 按分组 UUID 筛选;不传则返回所有分组下的设备 |
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
# 列出所有节点(默认)
|
|
203
|
+
sensecraft-cli device list
|
|
204
|
+
|
|
205
|
+
# 列出网关
|
|
206
|
+
sensecraft-cli device list --device-type 1
|
|
207
|
+
|
|
208
|
+
# 列出开发套件
|
|
209
|
+
sensecraft-cli device list --device-type 3
|
|
210
|
+
|
|
211
|
+
# 列出指定分组下的设备
|
|
212
|
+
sensecraft-cli device list --group-uuid <group-uuid>
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
#### `device view`
|
|
216
|
+
|
|
217
|
+
获取设备详情(最多 50 个 EUI)。
|
|
218
|
+
|
|
219
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
220
|
+
|------|------|--------|------|
|
|
221
|
+
| `--eui` | 是 | — | 设备 EUI,可多次指定 |
|
|
222
|
+
| `--device-type` | 否 | `2` | 设备类型:`1`=网关,`2`=节点,`3`=开发套件 |
|
|
223
|
+
|
|
224
|
+
```bash
|
|
225
|
+
sensecraft-cli device view --eui 0123456789ABCDEF
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
#### `device channels`
|
|
229
|
+
|
|
230
|
+
查询节点通道列表(最多 50 个 EUI)。
|
|
231
|
+
|
|
232
|
+
| 参数 | 必填 | 说明 |
|
|
233
|
+
|------|------|------|
|
|
234
|
+
| `--eui` | 是 | 设备 EUI,可多次指定 |
|
|
235
|
+
|
|
236
|
+
```bash
|
|
237
|
+
sensecraft-cli device channels --eui 0123456789ABCDEF
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
#### `device status`
|
|
241
|
+
|
|
242
|
+
获取设备运行状态(最多 50 个 EUI)。
|
|
243
|
+
|
|
244
|
+
| 参数 | 必填 | 说明 |
|
|
245
|
+
|------|------|------|
|
|
246
|
+
| `--eui` | 是 | 设备 EUI,可多次指定 |
|
|
247
|
+
|
|
248
|
+
```bash
|
|
249
|
+
sensecraft-cli device status --eui 0123456789ABCDEF
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
#### `device bind`
|
|
253
|
+
|
|
254
|
+
将设备绑定到当前账号。
|
|
255
|
+
|
|
256
|
+
| 参数 | 必填 | 说明 |
|
|
257
|
+
|------|------|------|
|
|
258
|
+
| `--eui` | 是 | 设备 EUI |
|
|
259
|
+
| `--code` | 是 | 设备绑定码 |
|
|
260
|
+
| `--name` | 否 | 设备名称 |
|
|
261
|
+
| `--group-uuid` | 否 | 目标分组 UUID |
|
|
262
|
+
| `--longitude` | 否 | 经度 |
|
|
263
|
+
| `--latitude` | 否 | 纬度 |
|
|
264
|
+
|
|
265
|
+
```bash
|
|
266
|
+
sensecraft-cli device bind --eui 0123456789ABCDEF --code ABCD1234 --name "我的传感器"
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
#### `device unbind`
|
|
270
|
+
|
|
271
|
+
解绑设备(最多 50 个 EUI)。须加 `--yes`。
|
|
272
|
+
|
|
273
|
+
| 参数 | 必填 | 说明 |
|
|
274
|
+
|------|------|------|
|
|
275
|
+
| `--eui` | 是 | 设备 EUI,可多次指定 |
|
|
276
|
+
| `--yes` | 是 | 确认执行 |
|
|
277
|
+
|
|
278
|
+
```bash
|
|
279
|
+
sensecraft-cli device unbind --eui 0123456789ABCDEF --yes
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
#### `device sim`
|
|
283
|
+
|
|
284
|
+
查看 SIM 卡状态。
|
|
285
|
+
|
|
286
|
+
| 参数 | 必填 | 说明 |
|
|
287
|
+
|------|------|------|
|
|
288
|
+
| `--iccid` | 是 | SIM 卡 ICCID |
|
|
289
|
+
|
|
290
|
+
```bash
|
|
291
|
+
sensecraft-cli device sim --iccid 89860000000000000000
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
### device devkit — 开发套件
|
|
297
|
+
|
|
298
|
+
#### `device devkit create`
|
|
299
|
+
|
|
300
|
+
创建开发套件设备。同一组织下每个 SKU 最多创建 5 个。
|
|
301
|
+
|
|
302
|
+
| 参数 | 必填 | 说明 |
|
|
303
|
+
|------|------|------|
|
|
304
|
+
| `--sku` | 是 | 开发套件 SKU |
|
|
305
|
+
| `--name` | 否 | 设备名称 |
|
|
306
|
+
|
|
307
|
+
支持的 SKU:
|
|
308
|
+
|
|
309
|
+
| SKU | 说明 |
|
|
310
|
+
|-----|------|
|
|
311
|
+
| `blank_device` | Blank Device |
|
|
312
|
+
| `xiao` | XIAO |
|
|
313
|
+
| `grove_vision_ai` | Grove Vision AI V2 |
|
|
314
|
+
|
|
315
|
+
```bash
|
|
316
|
+
sensecraft-cli device devkit create --sku xiao --name "我的 XIAO 套件"
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
#### `device devkit key`
|
|
320
|
+
|
|
321
|
+
查看开发套件设备的 `device_key` 与 `token`(仅支持开发套件设备,EUI 为 16 位字符)。
|
|
322
|
+
|
|
323
|
+
| 参数 | 必填 | 说明 |
|
|
324
|
+
|------|------|------|
|
|
325
|
+
| `--eui` | 是 | 开发套件设备 EUI(16 位) |
|
|
326
|
+
|
|
327
|
+
```bash
|
|
328
|
+
sensecraft-cli device devkit key --eui 0123456789ABCDEF
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
---
|
|
332
|
+
|
|
333
|
+
### group — 设备分组
|
|
334
|
+
|
|
335
|
+
#### `group list`
|
|
336
|
+
|
|
337
|
+
列出当前账号下的所有设备分组。
|
|
338
|
+
|
|
339
|
+
#### `group create`
|
|
340
|
+
|
|
341
|
+
创建设备分组(最多 50 个分组)。
|
|
342
|
+
|
|
343
|
+
| 参数 | 必填 | 说明 |
|
|
344
|
+
|------|------|------|
|
|
345
|
+
| `--name` | 是 | 分组名称 |
|
|
346
|
+
|
|
347
|
+
```bash
|
|
348
|
+
sensecraft-cli group create --name "温室传感器"
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
#### `group update`
|
|
352
|
+
|
|
353
|
+
更新设备分组名称。
|
|
354
|
+
|
|
355
|
+
| 参数 | 必填 | 说明 |
|
|
356
|
+
|------|------|------|
|
|
357
|
+
| `--group-uuid` | 是 | 分组 UUID |
|
|
358
|
+
| `--name` | 是 | 新分组名称 |
|
|
359
|
+
|
|
360
|
+
```bash
|
|
361
|
+
sensecraft-cli group update --group-uuid <uuid> --name "新名称"
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
#### `group delete`
|
|
365
|
+
|
|
366
|
+
删除设备分组(组内设备将移至默认分组)。须加 `--yes`。
|
|
367
|
+
|
|
368
|
+
| 参数 | 必填 | 说明 |
|
|
369
|
+
|------|------|------|
|
|
370
|
+
| `--group-uuid` | 是 | 分组 UUID |
|
|
371
|
+
| `--yes` | 是 | 确认执行 |
|
|
372
|
+
|
|
373
|
+
```bash
|
|
374
|
+
sensecraft-cli group delete --group-uuid <uuid> --yes
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
#### `group move-devices`
|
|
378
|
+
|
|
379
|
+
将设备移动到指定分组。须加 `--yes`。
|
|
380
|
+
|
|
381
|
+
| 参数 | 必填 | 说明 |
|
|
382
|
+
|------|------|------|
|
|
383
|
+
| `--group-uuid` | 是 | 目标分组 UUID |
|
|
384
|
+
| `--eui` | 是 | 设备 EUI,可多次指定 |
|
|
385
|
+
| `--yes` | 是 | 确认执行 |
|
|
386
|
+
|
|
387
|
+
```bash
|
|
388
|
+
sensecraft-cli group move-devices --group-uuid <uuid> --eui 0123456789ABCDEF --yes
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
---
|
|
392
|
+
|
|
393
|
+
### data — 传感数据
|
|
394
|
+
|
|
395
|
+
#### `data latest`
|
|
396
|
+
|
|
397
|
+
获取设备最近一年内的最新遥测数据;未指定通道时返回每个通道下最新数据点。
|
|
398
|
+
|
|
399
|
+
| 参数 | 必填 | 说明 |
|
|
400
|
+
|------|------|------|
|
|
401
|
+
| `--eui` | 是 | 设备 EUI |
|
|
402
|
+
| `--measurement-id` | 否 | 测量值 ID |
|
|
403
|
+
| `--channel-index` | 否 | 通道编号 |
|
|
404
|
+
|
|
405
|
+
```bash
|
|
406
|
+
sensecraft-cli data latest --eui 0123456789ABCDEF --measurement-id 4097 --channel-index 1
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
#### `data list`
|
|
410
|
+
|
|
411
|
+
获取设备历史遥测数据(单次最长约一个月,且仅可查近三个月内数据)。
|
|
412
|
+
|
|
413
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
414
|
+
|------|------|--------|------|
|
|
415
|
+
| `--eui` | 是 | — | 设备 EUI |
|
|
416
|
+
| `--measurement-id` | 否 | — | 测量值 ID |
|
|
417
|
+
| `--channel-index` | 否 | — | 通道编号 |
|
|
418
|
+
| `--limit` | 否 | — | 返回记录数 |
|
|
419
|
+
| `--time-start` | 否 | — | 起始时间戳(毫秒) |
|
|
420
|
+
| `--time-end` | 否 | — | 结束时间戳(毫秒) |
|
|
421
|
+
|
|
422
|
+
```bash
|
|
423
|
+
sensecraft-cli data list --eui 0123456789ABCDEF --limit 100 --time-start 1700000000000 --time-end 1700086400000
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
#### `data chart`
|
|
427
|
+
|
|
428
|
+
获取设备遥测折线聚合点(最长一年;每个测量最多约 250 个点)。
|
|
429
|
+
|
|
430
|
+
| 参数 | 必填 | 默认值 | 说明 |
|
|
431
|
+
|------|------|--------|------|
|
|
432
|
+
| `--eui` | 是 | — | 设备 EUI |
|
|
433
|
+
| `--measurement-id` | 否 | — | 测量值 ID |
|
|
434
|
+
| `--channel-index` | 否 | — | 通道编号 |
|
|
435
|
+
| `--interval` | 否 | `60` | 时间段长度(分钟) |
|
|
436
|
+
| `--time-start` | 否 | — | 起始时间戳(毫秒) |
|
|
437
|
+
| `--time-end` | 否 | — | 结束时间戳(毫秒) |
|
|
438
|
+
|
|
439
|
+
```bash
|
|
440
|
+
sensecraft-cli data chart --eui 0123456789ABCDEF --interval 60 --time-start 1700000000000 --time-end 1702592000000
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
---
|
|
444
|
+
|
|
445
|
+
## 典型工作流
|
|
446
|
+
|
|
447
|
+
```bash
|
|
448
|
+
# 安装并初始化
|
|
449
|
+
npx @seeed-studio/sensecraft-cli install
|
|
450
|
+
|
|
451
|
+
# 查看分组
|
|
452
|
+
sensecraft-cli group list
|
|
453
|
+
|
|
454
|
+
# 列出节点设备
|
|
455
|
+
sensecraft-cli device list
|
|
456
|
+
|
|
457
|
+
# 查看设备详情与通道
|
|
458
|
+
sensecraft-cli device view --eui 0123456789ABCDEF
|
|
459
|
+
sensecraft-cli device channels --eui 0123456789ABCDEF
|
|
460
|
+
|
|
461
|
+
# 查询最新数据
|
|
462
|
+
sensecraft-cli data latest --eui 0123456789ABCDEF
|
|
463
|
+
```
|
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @seeed-studio/sensecraft-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The official command-line tool for [SenseCraft](https://sensecraft.seeed.cc). Read sensor data, create models, and publish applications — for developers and AI agents.
|
|
4
|
+
|
|
5
|
+
Chinese: [README-zh.md](README-zh.md).
|
|
4
6
|
|
|
5
7
|
## Install
|
|
6
8
|
|
|
@@ -11,27 +13,21 @@ sensecraft-cli --version
|
|
|
11
13
|
|
|
12
14
|
Requires Node.js ≥ 16. Downloads a platform binary pinned to this package version.
|
|
13
15
|
|
|
14
|
-
**Full guide** (PATH, Windows, upgrade
|
|
16
|
+
**Full guide** (PATH, Windows, upgrade, uninstall, offline mirror, Cursor Skills): [`INSTALL.md`](INSTALL.md).
|
|
15
17
|
|
|
16
18
|
## Agent Skills
|
|
17
19
|
|
|
18
20
|
After install, Skill markdown lives under this package's `skills/` directory:
|
|
19
21
|
|
|
20
|
-
|
|
21
|
-
|-------|------|
|
|
22
|
-
| Meta router | `skills/sensecraft-ai/SKILL.md` |
|
|
23
|
-
| SenseCAP PaaS | `skills/sensecraft-data/` |
|
|
24
|
-
| Application Plaza | `skills/sensecraft-apps/` |
|
|
25
|
-
| File upload | `skills/sensecraft-files/` |
|
|
26
|
-
| Model library | `skills/sensecraft-models/` |
|
|
27
|
-
| Classic reCamera 40 | `skills/sensecraft-recamera/` |
|
|
28
|
-
| Cloud devices | `skills/sensecraft-devices-cloud/` |
|
|
22
|
+
One skill: `skills/sensecraft-cli/SKILL.md`. Product procedures are in `references/`. `create-app/` is the nested skill for turning a local project into an app.
|
|
29
23
|
|
|
30
24
|
```bash
|
|
31
|
-
|
|
25
|
+
SRC="$(npm root -g)/@seeed-studio/sensecraft-cli/skills/sensecraft-cli"
|
|
26
|
+
mkdir -p ~/.cursor/skills
|
|
27
|
+
ln -sfn "$SRC" ~/.cursor/skills/sensecraft-cli
|
|
32
28
|
```
|
|
33
29
|
|
|
34
|
-
|
|
30
|
+
Symlink the directory. Do not copy it. `sensecraft-cli update` refreshes the files behind the link. See `INSTALL.md` §9.
|
|
35
31
|
|
|
36
32
|
## Config
|
|
37
33
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seeed-studio/sensecraft-cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "SenseCAP / SenseCraft AI cloud CLI (devices, apps, models, files, cloud deploy)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -26,6 +26,7 @@
|
|
|
26
26
|
"skills",
|
|
27
27
|
"LICENSE",
|
|
28
28
|
"README.md",
|
|
29
|
+
"README-zh.md",
|
|
29
30
|
"INSTALL.md"
|
|
30
31
|
],
|
|
31
32
|
"os": [
|
package/scripts/test-install.js
CHANGED
|
@@ -104,7 +104,7 @@ function main() {
|
|
|
104
104
|
}
|
|
105
105
|
|
|
106
106
|
// Skills must be present in the package (synced by prepack / sync script).
|
|
107
|
-
const skillsIndex = path.join(packageRoot, 'skills', 'sensecraft-
|
|
107
|
+
const skillsIndex = path.join(packageRoot, 'skills', 'sensecraft-cli', 'SKILL.md');
|
|
108
108
|
if (!fs.existsSync(skillsIndex)) {
|
|
109
109
|
console.warn(
|
|
110
110
|
`WARN: ${skillsIndex} missing — run ./script/sync-skills-to-npm.sh before publish`
|
package/skills/README.md
CHANGED
|
@@ -1,38 +1,17 @@
|
|
|
1
|
-
# Skills
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
| `skills/sensecraft-files/` | Access Key | Upload file and obtain `file_url` |
|
|
14
|
-
| `skills/sensecraft-models/` | Access Key | Model library |
|
|
15
|
-
| `skills/sensecraft-recamera/` | `sensecap` Access Key | Classic reCamera 40 pick / check / open |
|
|
16
|
-
| `skills/sensecraft-devices-cloud/` | Access Key | Jetson / cloud kit deploy |
|
|
17
|
-
|
|
18
|
-
**Sub-skill naming:** `sensecraft-apps/create-app` is a nested sub-skill inside the `sensecraft-apps` family. The leaf name `create-app` follows the verb-noun rule (`create` + `app`). Top-level folders keep the `sensecraft-*` domain prefix. Document any new exception here before publishing it.
|
|
19
|
-
|
|
20
|
-
**Archived drafts:** superseded drafts may be kept locally in `*-legacy/` directories. They are not routable skills, are not committed, and are excluded from the npm package by `script/sync-skills-to-npm.sh`.
|
|
21
|
-
|
|
22
|
-
## Cursor / Agent setup
|
|
23
|
-
|
|
24
|
-
1. 安装 CLI:见仓库根目录 [`INSTALL.md`](../INSTALL.md) §2 / §9。
|
|
25
|
-
2. Point the agent at this repo (or copy/symlink these Skill folders into the agent’s skills path).
|
|
26
|
-
3. Prefer loading **`sensecraft-ai`** first for any SenseCraft AI question — it routes to domain skills (including SenseCAP via `sensecraft-data`).
|
|
27
|
-
4. **L2 writes:** follow [`confirmation.md`](confirmation.md). Never pass `--yes` on the same turn as the user's first request.
|
|
28
|
-
5. Binary: `sensecraft-cli` must be on `PATH` (`npx @seeed-studio/sensecraft-cli install` or build from repo root).
|
|
29
|
-
|
|
30
|
-
Finding skills after a global npm install:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
ls "$(npm root -g)/@seeed-studio/sensecraft-cli/skills"
|
|
1
|
+
# Skills
|
|
2
|
+
|
|
3
|
+
One skill directory. The folder name matches `name` in `SKILL.md`.
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
sensecraft-cli/
|
|
7
|
+
├── SKILL.md # only entry
|
|
8
|
+
├── references/ # product procedures, opened when needed
|
|
9
|
+
├── create-app/ # nested skill: local project → app
|
|
10
|
+
│ ├── SKILL.md
|
|
11
|
+
│ ├── references/
|
|
12
|
+
│ └── assets/
|
|
34
13
|
```
|
|
35
14
|
|
|
36
|
-
|
|
15
|
+
`SKILL.md` links straight to a file in `references/` or to `create-app/`. Do not add another folder between them.
|
|
37
16
|
|
|
38
|
-
|
|
17
|
+
Install by symlinking this directory into the agent skills folder. Do not copy it. Steps: [`../INSTALL.md`](../INSTALL.md) §9.
|