@seeed-studio/sensecraft-cli 0.1.2 → 0.1.4
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 +443 -0
- package/LICENSE +21 -0
- package/README.md +51 -0
- package/package.json +28 -5
- package/scripts/constants.js +18 -3
- package/scripts/download.js +64 -16
- package/scripts/download.test.js +110 -0
- package/scripts/paths.js +28 -4
- package/scripts/paths.test.js +92 -0
- package/scripts/platform.js +8 -2
- package/scripts/postinstall.js +28 -7
- package/scripts/test-install.js +121 -0
- package/skills/README.md +33 -0
- package/skills/confirmation.md +56 -0
- package/skills/sensecraft-ai/SKILL.md +132 -0
- package/skills/sensecraft-apps/SKILL.md +198 -0
- package/skills/sensecraft-apps/commands.md +196 -0
- package/skills/sensecraft-apps/reference-app-fields.md +95 -0
- package/skills/sensecraft-apps/reference-tool-blocks.md +132 -0
- package/skills/sensecraft-data/SKILL.md +180 -0
- package/skills/sensecraft-data/commands.md +858 -0
- package/skills/sensecraft-devices-cloud/SKILL.md +53 -0
- package/skills/sensecraft-devices-cloud/commands.md +58 -0
- package/skills/sensecraft-files/SKILL.md +73 -0
- package/skills/sensecraft-files/commands.md +61 -0
- package/skills/sensecraft-models/SKILL.md +196 -0
- package/skills/sensecraft-models/commands.md +180 -0
- package/skills/sensecraft-models/reference-model-fields.md +139 -0
- package/skills/sensecraft-recamera/SKILL.md +79 -0
- package/skills/sensecraft-recamera/commands.md +87 -0
package/INSTALL.md
ADDED
|
@@ -0,0 +1,443 @@
|
|
|
1
|
+
# SenseCraft CLI 安装指南
|
|
2
|
+
|
|
3
|
+
本文说明如何安装、升级、卸载 `sensecraft-cli`,以及如何把 Agent Skills 接到 Cursor 等工具。命令参考与业务用法见 [`README.md`](README.md)。
|
|
4
|
+
|
|
5
|
+
## 1. 环境要求
|
|
6
|
+
|
|
7
|
+
| 项 | 要求 |
|
|
8
|
+
|----|------|
|
|
9
|
+
| Node.js | **≥ 16**(推荐 18 / 20 LTS) |
|
|
10
|
+
| 网络 | 能访问 npm registry,以及二进制下载源(默认阿里云 OSS) |
|
|
11
|
+
| 可选 | Go(仅从源码构建时需要,版本见 `go.mod`) |
|
|
12
|
+
|
|
13
|
+
### 支持的平台
|
|
14
|
+
|
|
15
|
+
| OS | 架构 | 二进制名 |
|
|
16
|
+
|----|------|----------|
|
|
17
|
+
| macOS | Intel (`x64`) | `sensecraft-cli-darwin-amd64` |
|
|
18
|
+
| macOS | Apple Silicon (`arm64`) | `sensecraft-cli-darwin-arm64` |
|
|
19
|
+
| Linux | `x64` / `arm64` | `sensecraft-cli-linux-amd64` / `…-arm64` |
|
|
20
|
+
| Windows | `x64` / `arm64` | `sensecraft-cli-windows-amd64.exe` / `…-arm64.exe` |
|
|
21
|
+
|
|
22
|
+
其它组合会在安装时报 `Unsupported platform`。
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## 2. 推荐安装(npm / npx)
|
|
27
|
+
|
|
28
|
+
适用于大多数用户。安装器会:
|
|
29
|
+
|
|
30
|
+
1. 按当前平台下载**与本 npm 包版本一致**的二进制
|
|
31
|
+
2. 全局注册 `sensecraft-cli` 命令
|
|
32
|
+
3. 若本地尚无配置,在交互终端下引导 `auth init`
|
|
33
|
+
|
|
34
|
+
### macOS / Linux
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
# 确认 Node
|
|
38
|
+
node -v # >= v16
|
|
39
|
+
|
|
40
|
+
# 安装(首次会下载二进制)
|
|
41
|
+
npx @seeed-studio/sensecraft-cli install
|
|
42
|
+
|
|
43
|
+
# 验证
|
|
44
|
+
sensecraft-cli --version
|
|
45
|
+
sensecraft-cli --help
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
若提示找不到命令,把 npm 全局 bin 加入 PATH:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm prefix -g
|
|
52
|
+
# 常见路径:
|
|
53
|
+
# macOS (Homebrew Node): /opt/homebrew/bin 或 /usr/local/bin
|
|
54
|
+
# Linux: ~/.npm-global/bin 或 /usr/bin
|
|
55
|
+
echo 'export PATH="$(npm prefix -g)/bin:$PATH"' >> ~/.zshrc # 或 ~/.bashrc
|
|
56
|
+
source ~/.zshrc
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Windows(PowerShell 或 cmd)
|
|
60
|
+
|
|
61
|
+
```powershell
|
|
62
|
+
node -v
|
|
63
|
+
npx @seeed-studio/sensecraft-cli install
|
|
64
|
+
sensecraft-cli --version
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
- 全局命令一般为 `sensecraft-cli.cmd`,装在 `npm prefix -g` 目录下。
|
|
68
|
+
- 若新开终端仍找不到命令:把该目录加入系统 **PATH**,或注销后重开终端。
|
|
69
|
+
- 建议使用 **PowerShell 5+** 或 Windows Terminal;Git Bash 一般也可用。
|
|
70
|
+
|
|
71
|
+
### 不全局安装、临时调用
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npx @seeed-studio/sensecraft-cli --version
|
|
75
|
+
npx @seeed-studio/sensecraft-cli auth info
|
|
76
|
+
npx @seeed-studio/sensecraft-cli device list
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
`npx` 每次仍可能触发 postinstall 下载/复用本地缓存的二进制。
|
|
80
|
+
|
|
81
|
+
### 指定版本安装
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npx @seeed-studio/sensecraft-cli@0.1.3 install
|
|
85
|
+
# 或
|
|
86
|
+
npm install -g @seeed-studio/sensecraft-cli@0.1.3
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
二进制 URL 形如:
|
|
90
|
+
|
|
91
|
+
`{RELEASE_BASE}/v{版本}/sensecraft-cli-{os}-{arch}[.exe]`
|
|
92
|
+
|
|
93
|
+
默认 `RELEASE_BASE`:
|
|
94
|
+
|
|
95
|
+
`https://sensecraft-statics.seeed.cc/static/bin/sensecraft-cli`
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## 3. 首次认证
|
|
100
|
+
|
|
101
|
+
安装完成后初始化:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# SenseCAP Access Key(设备 / 分组 / 数据,以及 AI 应用 / 模型 / 云部署)
|
|
105
|
+
sensecraft-cli auth init --kind sensecap
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
AI 初始化时选择站点:
|
|
109
|
+
|
|
110
|
+
| 选项 | 用途 |
|
|
111
|
+
|------|------|
|
|
112
|
+
| Global | 国际生产 |
|
|
113
|
+
| China | 国内账号(AI API host 与 Global 相同) |
|
|
114
|
+
| Develop | 测试环境(`test-sensecraft.seeed.cc`) |
|
|
115
|
+
|
|
116
|
+
查看与刷新:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
sensecraft-cli auth info
|
|
120
|
+
sensecraft-cli auth refresh # 仅 AI profile
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
无交互环境(CI)不会自动跑 `auth init`,需事先准备好配置文件或自行执行初始化。
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## 4. 配置文件位置
|
|
128
|
+
|
|
129
|
+
| 场景 | 路径 |
|
|
130
|
+
|------|------|
|
|
131
|
+
| **npm / npx 安装(默认)** | macOS/Linux:`~/.config/sensecraft-cli/sensecraft.json`;Windows:`%APPDATA%\sensecraft-cli\sensecraft.json` |
|
|
132
|
+
| **源码 `go build` 直接运行** | 当前工作目录下的 `sensecraft.json`(除非设置了环境变量) |
|
|
133
|
+
|
|
134
|
+
环境变量(优先级从高到低):
|
|
135
|
+
|
|
136
|
+
| 变量 | 含义 |
|
|
137
|
+
|------|------|
|
|
138
|
+
| `SENSECRAFT_CONFIG_FILE` | 配置文件完整路径 |
|
|
139
|
+
| `SENSECRAFT_CLI_PATH` | 配置**目录**(文件名固定为 `sensecraft.json`) |
|
|
140
|
+
|
|
141
|
+
npm 包装器会自动注入 `SENSECRAFT_CLI_PATH` 指向上述默认目录,因此 **npm 装的 CLI 与纯 `go build` 二进制默认读的不是同一个文件**。
|
|
142
|
+
|
|
143
|
+
### 迁移配置
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
# 示例:把 cwd 下的配置迁到 npm 默认位置
|
|
147
|
+
mkdir -p ~/.config/sensecraft-cli
|
|
148
|
+
cp ./sensecraft.json ~/.config/sensecraft-cli/sensecraft.json
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Windows:
|
|
152
|
+
|
|
153
|
+
```powershell
|
|
154
|
+
New-Item -ItemType Directory -Force "$env:APPDATA\sensecraft-cli"
|
|
155
|
+
Copy-Item .\sensecraft.json "$env:APPDATA\sensecraft-cli\sensecraft.json"
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## 5. 升级
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
# 升级到最新
|
|
164
|
+
npm install -g @seeed-studio/sensecraft-cli@latest
|
|
165
|
+
# 或
|
|
166
|
+
npx @seeed-studio/sensecraft-cli@latest install
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
安装器会比较 `vendor/.version` 与当前 npm 包版本:
|
|
170
|
+
|
|
171
|
+
- **版本一致** → 复用已下载二进制
|
|
172
|
+
- **版本不同或缺少戳记** → 重新下载对应版本的二进制
|
|
173
|
+
|
|
174
|
+
验证:
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
sensecraft-cli --version
|
|
178
|
+
# 应与 npm 包版本一致,例如 0.1.3
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## 6. 卸载
|
|
184
|
+
|
|
185
|
+
```bash
|
|
186
|
+
npm uninstall -g @seeed-studio/sensecraft-cli
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
可选清理:
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
# 配置(会删除本地 Token / Access Key,请先备份)
|
|
193
|
+
rm -rf ~/.config/sensecraft-cli # macOS / Linux
|
|
194
|
+
# Windows: Remove-Item -Recurse "$env:APPDATA\sensecraft-cli"
|
|
195
|
+
|
|
196
|
+
# npx 缓存(可选)
|
|
197
|
+
npm cache clean --force
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
包目录下的 `vendor/` 二进制会随全局包卸载一起消失。
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## 7. 离线 / 内网 / 自定义二进制源
|
|
205
|
+
|
|
206
|
+
### 使用本地已编译的 `dist/`
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
./script/build.sh
|
|
210
|
+
export SENSECRAFT_CLI_LOCAL_DIST="$PWD/dist"
|
|
211
|
+
npx @seeed-studio/sensecraft-cli install
|
|
212
|
+
# 或在已 clone 的 packages/cli 下:
|
|
213
|
+
# SENSECRAFT_CLI_LOCAL_DIST=$PWD/../../dist npm run postinstall
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### 覆盖下载基址
|
|
217
|
+
|
|
218
|
+
默认从 OSS 拉 `{base}/v{version}/{artifact}`。内网镜像时:
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
export SENSECRAFT_CLI_RELEASE_BASE="https://your-mirror.example.com/sensecraft-cli"
|
|
222
|
+
npx @seeed-studio/sensecraft-cli install
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
镜像目录结构须与发版一致,例如:
|
|
226
|
+
|
|
227
|
+
```text
|
|
228
|
+
…/sensecraft-cli/v0.1.3/sensecraft-cli-darwin-arm64
|
|
229
|
+
…/sensecraft-cli/v0.1.3/sensecraft-cli-linux-amd64
|
|
230
|
+
…
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### 跳过下载(仅复用已有 vendor)
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
export SENSECRAFT_CLI_SKIP_DOWNLOAD=1
|
|
237
|
+
# 若 vendor 中没有匹配当前版本的二进制,安装会失败
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### 可选校验和
|
|
241
|
+
|
|
242
|
+
若发版方提供了 SHA256,可设置:
|
|
243
|
+
|
|
244
|
+
```bash
|
|
245
|
+
export SENSECRAFT_CLI_SHA256="<hex>"
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
与下载内容不一致时安装失败。
|
|
249
|
+
|
|
250
|
+
### 代理
|
|
251
|
+
|
|
252
|
+
遵循 Node / 系统代理环境变量,例如:
|
|
253
|
+
|
|
254
|
+
```bash
|
|
255
|
+
export HTTPS_PROXY=http://proxy.example.com:8080
|
|
256
|
+
export HTTP_PROXY=http://proxy.example.com:8080
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## 8. 从源码构建
|
|
262
|
+
|
|
263
|
+
```bash
|
|
264
|
+
git clone <本仓库 URL>
|
|
265
|
+
cd sensecraft-data-terminal
|
|
266
|
+
|
|
267
|
+
# 本机调试
|
|
268
|
+
go build -o sensecraft-cli .
|
|
269
|
+
./sensecraft-cli --version
|
|
270
|
+
|
|
271
|
+
# 全平台发布产物 → dist/
|
|
272
|
+
./script/build.sh
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
本地用源码二进制时,配置默认落在**当前目录** `sensecraft.json`。若希望与 npm 安装共用配置:
|
|
276
|
+
|
|
277
|
+
```bash
|
|
278
|
+
export SENSECRAFT_CLI_PATH="$HOME/.config/sensecraft-cli"
|
|
279
|
+
./sensecraft-cli auth info
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
开发自检:
|
|
283
|
+
|
|
284
|
+
```bash
|
|
285
|
+
./script/smoke-ai.sh
|
|
286
|
+
./script/smoke-sensecap.sh
|
|
287
|
+
cd packages/cli && SENSECRAFT_CLI_LOCAL_DIST=$PWD/../../dist npm run test:install
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
发版流程见 [`README.md`](README.md)(GitLab CI:`.gitlab-ci.yml`)。
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
294
|
+
## 9. Agent Skills(Cursor 等)
|
|
295
|
+
|
|
296
|
+
Skills 是给 Agent 读的 Markdown 能力说明,**不是** CLI 子命令。
|
|
297
|
+
|
|
298
|
+
### 安装来源
|
|
299
|
+
|
|
300
|
+
| 来源 | 路径 |
|
|
301
|
+
|------|------|
|
|
302
|
+
| 本仓库 | `skills/` |
|
|
303
|
+
| npm 包安装后 | 全局包目录下的 `skills/`(与 `bin`、`scripts` 同级) |
|
|
304
|
+
|
|
305
|
+
查找全局包目录:
|
|
306
|
+
|
|
307
|
+
```bash
|
|
308
|
+
npm root -g
|
|
309
|
+
# 例如 …/node_modules/@seeed-studio/sensecraft-cli/skills/sensecraft-ai/SKILL.md
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### 推荐布局
|
|
313
|
+
|
|
314
|
+
| Skill | 路径 | 鉴权 |
|
|
315
|
+
|-------|------|------|
|
|
316
|
+
| Meta 路由(优先加载) | `skills/sensecraft-ai/SKILL.md` | — |
|
|
317
|
+
| SenseCAP PaaS | `skills/sensecraft-data/` | SenseCAP |
|
|
318
|
+
| 应用广场 | `skills/sensecraft-apps/` | Access Key |
|
|
319
|
+
| 文件上传 | `skills/sensecraft-files/` | Access Key |
|
|
320
|
+
| 模型库 | `skills/sensecraft-models/` | Access Key |
|
|
321
|
+
| 经典 reCamera 40 | `skills/sensecraft-recamera/` | Access Key |
|
|
322
|
+
| 云设备 | `skills/sensecraft-devices-cloud/` | Access Key |
|
|
323
|
+
|
|
324
|
+
更细的发现说明:[`skills/README.md`](skills/README.md)。
|
|
325
|
+
|
|
326
|
+
### 接到 Cursor
|
|
327
|
+
|
|
328
|
+
任选其一:
|
|
329
|
+
|
|
330
|
+
1. **工作区即本仓库**
|
|
331
|
+
打开 `sensecraft-data-terminal` 作为 Cursor 项目,Agent 可直接读 `skills/`。
|
|
332
|
+
|
|
333
|
+
2. **拷贝 / 软链到 Cursor skills 目录**(路径以你本机 Cursor 版本为准,常见为用户目录下的 skills 配置):
|
|
334
|
+
|
|
335
|
+
```bash
|
|
336
|
+
# 示例:软链 meta + 各域 skill(按需调整目标目录)
|
|
337
|
+
ln -s "$PWD/skills/sensecraft-ai" ~/.cursor/skills/sensecraft-ai
|
|
338
|
+
ln -s "$PWD/skills/sensecraft-apps" ~/.cursor/skills/sensecraft-apps
|
|
339
|
+
# …
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
3. **只用 npm 包里的 skills**
|
|
343
|
+
把 `$(npm root -g)/@seeed-studio/sensecraft-cli/skills` 链到 Agent 可发现的路径。
|
|
344
|
+
|
|
345
|
+
### 接到 Claude Code / 其他 Agent
|
|
346
|
+
|
|
347
|
+
这些 skill 只依赖标准 `SKILL.md`(YAML `name`/`description` + Markdown 正文),不包含 Cursor 私有指令。支持 Agent Skills 的宿主可以直接复制或软链整个 skill 目录:
|
|
348
|
+
|
|
349
|
+
```bash
|
|
350
|
+
# Claude Code:项目级
|
|
351
|
+
mkdir -p .claude/skills
|
|
352
|
+
for d in "$PWD"/skills/*; do
|
|
353
|
+
ln -s "$d" ".claude/skills/$(basename "$d")"
|
|
354
|
+
done
|
|
355
|
+
|
|
356
|
+
# Claude Code:用户级(可选)
|
|
357
|
+
mkdir -p ~/.claude/skills
|
|
358
|
+
ln -s "$PWD/skills/sensecraft-ai" ~/.claude/skills/sensecraft-ai
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
其他 Agent:
|
|
362
|
+
|
|
363
|
+
1. 若支持 `SKILL.md` 自动发现,把 `skills/*/` 原样放入其项目级或用户级 skills 目录;具体目录以宿主文档为准。
|
|
364
|
+
2. 若不支持 Skills,把 `skills/sensecraft-ai/SKILL.md` 和命中的领域 skill 作为系统/项目上下文加载。
|
|
365
|
+
3. Agent 必须具有本机命令执行能力,才能调用 `sensecraft-cli`;纯聊天宿主只能读取说明,不能声称命令已执行。
|
|
366
|
+
4. `auth init`、本地 USB/IP 部署与烧录仍需用户交互,不能因为换了 Agent 就降级安全级别。
|
|
367
|
+
|
|
368
|
+
使用约定:
|
|
369
|
+
|
|
370
|
+
- SenseCraft AI 相关问题先走 **`sensecraft-ai`** 路由 skill。
|
|
371
|
+
- 确保机器上 `sensecraft-cli` 在 PATH 中,且已 `auth init`。
|
|
372
|
+
|
|
373
|
+
---
|
|
374
|
+
|
|
375
|
+
## 10. 验证清单
|
|
376
|
+
|
|
377
|
+
```bash
|
|
378
|
+
sensecraft-cli --version
|
|
379
|
+
sensecraft-cli auth info
|
|
380
|
+
|
|
381
|
+
# 不消耗真实配额的冒烟(需已有对应 profile 或临时 config)
|
|
382
|
+
sensecraft-cli model constants --sandbox
|
|
383
|
+
sensecraft-cli app list --mine --sandbox
|
|
384
|
+
sensecraft-cli device list --sandbox
|
|
385
|
+
sensecraft-cli group list --sandbox
|
|
386
|
+
sensecraft-cli data latest --eui SANDBOXEUI000001 --sandbox
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
## 11. 常见问题
|
|
392
|
+
|
|
393
|
+
### `sensecraft-cli: command not found`
|
|
394
|
+
|
|
395
|
+
- 确认已执行 `npx @seeed-studio/sensecraft-cli install` 或 `npm install -g …`
|
|
396
|
+
- 把 `$(npm prefix -g)/bin`(Windows 为 `npm prefix -g`)加入 PATH
|
|
397
|
+
- 新开一个终端再试
|
|
398
|
+
|
|
399
|
+
### 二进制下载失败
|
|
400
|
+
|
|
401
|
+
安装器会提示可尝试:
|
|
402
|
+
|
|
403
|
+
1. 确认发版产物已上传到 `{RELEASE_BASE}/v{version}/`
|
|
404
|
+
2. `SENSECRAFT_CLI_LOCAL_DIST` 指向本地 `dist/`
|
|
405
|
+
3. `SENSECRAFT_CLI_RELEASE_BASE` 指向可用镜像
|
|
406
|
+
|
|
407
|
+
公司网络拦截 OSS 时,优先用本地 `dist/` 或内网镜像。
|
|
408
|
+
|
|
409
|
+
### `auth info` 显示未初始化 / 装完又提示 init
|
|
410
|
+
|
|
411
|
+
- npm 安装认 **SenseCAP Access Key**(`app_config_list`)。
|
|
412
|
+
- 确认读写的是同一配置文件:`echo $SENSECRAFT_CLI_PATH` / `%SENSECRAFT_CLI_PATH%`。
|
|
413
|
+
- 应用 / 模型 / 云设备:`sensecraft-cli auth init --kind sensecap`。
|
|
414
|
+
|
|
415
|
+
### npm 装的和 `go build` 的配置不一致
|
|
416
|
+
|
|
417
|
+
见上文「配置文件位置」:前者默认 `~/.config/…`,后者默认 cwd。用 `SENSECRAFT_CLI_PATH` 或 `SENSECRAFT_CONFIG_FILE` 统一。
|
|
418
|
+
|
|
419
|
+
### Windows 杀毒软件拦截
|
|
420
|
+
|
|
421
|
+
首次下载的 `sensecraft-cli.exe` 可能被隔离。将安装目录或 `vendor` 加入白名单后重装。
|
|
422
|
+
|
|
423
|
+
### 升级后版本号不变
|
|
424
|
+
|
|
425
|
+
```bash
|
|
426
|
+
npm uninstall -g @seeed-studio/sensecraft-cli
|
|
427
|
+
npm cache clean --force
|
|
428
|
+
npx @seeed-studio/sensecraft-cli@<目标版本> install
|
|
429
|
+
sensecraft-cli --version
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
---
|
|
433
|
+
|
|
434
|
+
## 12. 相关文档
|
|
435
|
+
|
|
436
|
+
| 文档 | 内容 |
|
|
437
|
+
|------|------|
|
|
438
|
+
| [`README.md`](README.md) | 功能概览、命令参考、发版说明 |
|
|
439
|
+
| [`ARCHITECTURE.md`](ARCHITECTURE.md) | 架构分层、鉴权、业务规则、安全模型、CI |
|
|
440
|
+
| [`docs/sensecraft-cli-smoke.md`](docs/sensecraft-cli-smoke.md) | 发版冒烟清单 |
|
|
441
|
+
| [`docs/sensecraft-cli-test-cases.md`](docs/sensecraft-cli-test-cases.md) | 全量功能测试用例 |
|
|
442
|
+
| [`skills/README.md`](skills/README.md) | Skills 目录与 Agent 约定 |
|
|
443
|
+
| [`LICENSE`](LICENSE) | MIT |
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Seeed Studio
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @seeed-studio/sensecraft-cli
|
|
2
|
+
|
|
3
|
+
Cloud CLI for SenseCAP devices and SenseCraft AI (apps, models, files, cloud deploy).
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @seeed-studio/sensecraft-cli install
|
|
9
|
+
sensecraft-cli --version
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Requires Node.js ≥ 16. Downloads a platform binary pinned to this package version.
|
|
13
|
+
|
|
14
|
+
**Full guide** (PATH, Windows, upgrade/uninstall, offline mirror, Cursor Skills): see [`INSTALL.md`](INSTALL.md) in this package (same file as the repo root).
|
|
15
|
+
|
|
16
|
+
## Agent Skills
|
|
17
|
+
|
|
18
|
+
After install, Skill markdown lives under this package's `skills/` directory:
|
|
19
|
+
|
|
20
|
+
| Skill | Path |
|
|
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/` |
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
ls "$(npm root -g)/@seeed-studio/sensecraft-cli/skills"
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Point your Agent (Cursor, etc.) at these folders, or copy/symlink them into the Agent's skills path. See `skills/README.md` and `INSTALL.md` §9.
|
|
35
|
+
|
|
36
|
+
## Config
|
|
37
|
+
|
|
38
|
+
The npm wrapper sets `SENSECRAFT_CLI_PATH` to:
|
|
39
|
+
|
|
40
|
+
- macOS / Linux: `~/.config/sensecraft-cli/`
|
|
41
|
+
- Windows: `%APPDATA%\sensecraft-cli\`
|
|
42
|
+
|
|
43
|
+
Override with `SENSECRAFT_CONFIG_FILE` or `SENSECRAFT_CLI_PATH`.
|
|
44
|
+
|
|
45
|
+
## Version
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
sensecraft-cli --version
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
The binary version matches this npm package version.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seeed-studio/sensecraft-cli",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "SenseCraft
|
|
3
|
+
"version": "0.1.4",
|
|
4
|
+
"description": "SenseCAP / SenseCraft AI cloud CLI (devices, apps, models, files, cloud deploy)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -15,14 +15,37 @@
|
|
|
15
15
|
"sensecraft-cli": "bin/sensecraft-cli.js"
|
|
16
16
|
},
|
|
17
17
|
"scripts": {
|
|
18
|
+
"prepack": "bash ../../script/sync-skills-to-npm.sh",
|
|
18
19
|
"postinstall": "node scripts/postinstall.js",
|
|
19
|
-
"test
|
|
20
|
+
"test": "node scripts/paths.test.js && node scripts/download.test.js",
|
|
21
|
+
"test:install": "node scripts/test-install.js"
|
|
20
22
|
},
|
|
21
23
|
"files": [
|
|
22
24
|
"bin",
|
|
23
|
-
"scripts"
|
|
25
|
+
"scripts",
|
|
26
|
+
"skills",
|
|
27
|
+
"LICENSE",
|
|
28
|
+
"README.md",
|
|
29
|
+
"INSTALL.md"
|
|
30
|
+
],
|
|
31
|
+
"os": [
|
|
32
|
+
"darwin",
|
|
33
|
+
"linux",
|
|
34
|
+
"win32"
|
|
35
|
+
],
|
|
36
|
+
"cpu": [
|
|
37
|
+
"x64",
|
|
38
|
+
"arm64"
|
|
24
39
|
],
|
|
25
40
|
"engines": {
|
|
26
41
|
"node": ">=16"
|
|
27
|
-
}
|
|
42
|
+
},
|
|
43
|
+
"keywords": [
|
|
44
|
+
"sensecap",
|
|
45
|
+
"sensecraft",
|
|
46
|
+
"seeed",
|
|
47
|
+
"cli",
|
|
48
|
+
"iot",
|
|
49
|
+
"ai"
|
|
50
|
+
]
|
|
28
51
|
}
|
package/scripts/constants.js
CHANGED
|
@@ -1,16 +1,31 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
const
|
|
3
|
+
const path = require('path');
|
|
4
|
+
|
|
5
|
+
// Single source of truth: packages/cli/package.json "version".
|
|
6
|
+
// Release builds upload binaries to ${RELEASE_BASE}/v${VERSION}/...
|
|
7
|
+
const VERSION = require('../package.json').version;
|
|
4
8
|
|
|
5
9
|
const RELEASE_BASE =
|
|
6
10
|
process.env.SENSECRAFT_CLI_RELEASE_BASE ||
|
|
7
|
-
'https://sensecraft-statics.
|
|
8
|
-
// 'https://iteam-gitlab.seeed.cn/sensecap/sensecraft-data-terminal/-/releases';
|
|
11
|
+
'https://sensecraft-statics.seeed.cc/static/bin/sensecraft-cli';
|
|
9
12
|
|
|
10
13
|
const BINARY_NAME = 'sensecraft-cli';
|
|
11
14
|
|
|
15
|
+
function releaseArtifactURL(artifact) {
|
|
16
|
+
// Trailing slash on RELEASE_BASE is tolerated.
|
|
17
|
+
const base = RELEASE_BASE.replace(/\/+$/, '');
|
|
18
|
+
return `${base}/v${VERSION}/${artifact}`;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
function versionStampPath(vendorDir) {
|
|
22
|
+
return path.join(vendorDir, '.version');
|
|
23
|
+
}
|
|
24
|
+
|
|
12
25
|
module.exports = {
|
|
13
26
|
VERSION,
|
|
14
27
|
RELEASE_BASE,
|
|
15
28
|
BINARY_NAME,
|
|
29
|
+
releaseArtifactURL,
|
|
30
|
+
versionStampPath,
|
|
16
31
|
};
|