@seeed-studio/sensecraft-cli

中文文档
0.4.6发布于 2026/11/02MIT零依赖

SenseCAP / SenseCraft AI cloud CLI (devices, apps, models, files, cloud deploy)

原始使用文档
文档目录11 节
  1. 能做什么
  2. 安装
  3. 三步上手
  4. 给 AI Agent
  5. Agent Skills
  6. 登录
  7. 命令
  8. 进阶
  9. 从源码构建
  10. 安全
  11. 许可证

sensecraft-cli

License: MIT Go Version npm version

中文 | English

SenseCAP 设备与 SenseCraft AI 的命令行工具。一把 OpenAPI Access Key 即可访问设备、遥测、应用、模型、文件和云设备。给人用,也给 AI Agent 用。Skills 在 skills/。

安装 · AI Agent · Skills · 登录 · 命令 · 进阶 · 安全

能做什么

类别能力
设备列出、查看、绑定、解绑网关、节点和开发套件
分组创建分组、移动设备
遥测最新值、历史记录、折线聚合点
应用CodeCraft Hub:浏览应用,管理自己的应用、物料和活动
模型搜索模型库,上传和发布模型
文件上传本地文件,得到 file_url
云设备列出 Jetson 等云设备,部署模型
reCamera检查经典 reCamera 的应用或模型,并打开控制台部署页

网页控制台是 https://sensecraft.seeed.cc。

安装

需要 Node.js 16 及以上,以及能访问 SenseCAP 和 SenseCraft AI 的网络。从源码构建另需 Go 1.25 及以上(见 go.mod)。

npx @seeed-studio/sensecraft-cli install
sensecraft-cli --version

Windows 上的命令名是 sensecraft-cli.cmd。PATH、升级和卸载见 INSTALL.md。

三步上手

在 SenseCAP 门户创建 OpenAPI Access Key,然后:

# 1. 写入钥匙。--site 为 Global 或 China,省略时是 Global
sensecraft-cli auth add --key-id <Key ID> --access-key <Access Key> --site Global

# 2. 确认。不会打印 Access Key
sensecraft-cli auth info

# 3. 调用接口
sensecraft-cli device list

交互终端里可以不带参数运行 auth add,按提示填写。

给 AI Agent

和用户一起完成。不要让用户把 Access Key 贴进对话,也不要在会被记录的命令行里带上这串密钥。

  1. 如果没有命令,先安装:
npx @seeed-studio/sensecraft-cli install
  1. 请用户在自己的电脑上运行 auth add。
  2. 确认钥匙已经生效:
sensecraft-cli auth info
  1. 再跑只读命令,例如 sensecraft-cli device list 或 sensecraft-cli app list --public。
  2. 先读 skills/sensecraft-cli/SKILL.md,它会转到对应的产品说明。

解绑、删除、发布、部署这类写操作,要等用户单独确认之后才能加 --yes。

Agent Skills

Skill说明
sensecraft-cliSenseCraft Data、SenseCraft AI 和 CodeCraft Hub
create-app把本地项目做成 CodeCraft Hub 应用

全局 npm 安装之后:

ls "$(npm root -g)/@seeed-studio/sensecraft-cli/skills"

登录

命令说明
auth add校验 Access Key,写入本机,并设为当前钥匙
auth info显示站点、组织 ID 和 Key ID
sensecraft-cli auth add --key-id <Key ID> --access-key <Access Key> --site Global
sensecraft-cli auth info
--siteSenseCAP OpenAPISenseCraft AI OpenAPI
Globalhttps://sensecap.seeed.cc/openapihttps://api-gateway.seeed.cc/openapi
Chinahttps://sensecap.seeed.cn/openapihttps://api-gateway.seeed.cc/openapi

中国站仅支持 SenseCraft Data。SenseCraft AI 和 CodeCraft Hub 请用 Global。同一把 Access Key 用 HTTP Basic 调用接口:用户名是 Key ID,密码是 Access Key。

命令

参数用 sensecraft-cli <command> --help 查看。每一类一条示例:

sensecraft-cli device list --device-type 1
sensecraft-cli data latest --eui <EUI>

sensecraft-cli app list --public --sort popular
sensecraft-cli model list --public
sensecraft-cli file upload --type 1 --path ./cover.png --for-app
sensecraft-cli cloud device list
sensecraft-cli recamera check --model-id <id>
命令说明
device网关(--device-type 1)、节点(2,默认)、开发套件(3)
group设备分组
data最新遥测、历史、折线点
appCodeCraft Hub 和我的应用。不传 --public 时列出自己的应用
model模型库。不传 --mine 时列出公开模型
file上传。--type:1 图片,2 模型,3 应用,4 固件,5 静态资源(需要 --flow-id),6 压缩包
cloud云设备,以及部署模型
recamera检查,或打开控制台页面。烧录在网页上完成
update安装 npm 上的最新版本

app list --sort 取 popular、newest 或 likes。常用 --uniform-type:40 reCamera,32 XIAO ESP32S3,53 reCamera Pro。

进阶

成功的数据命令把缩进 JSON 打到 stdout。auth add 和 auth info 打可读文本。失败在 stderr,退出码非 0。

sensecraft-cli --version 打印 npm 包版本。直接 go build 的二进制打印 dev。

配置文件名是 sensecraft.json。

运行方式文件位置
npm 安装macOS / Linux:~/.config/sensecraft-cli/sensecraft.json。Windows:%APPDATA%\sensecraft-cli\sensecraft.json
go build 的二进制当前目录下的 sensecraft.json

命令成功后,stderr 上可能各出现一条英文提示,同一条 24 小时内只出现一次:Warning: 表示有新版本,运行 sensecraft-cli update;Notice: 写出正在进行的活动名称、日期和链接。交互终端里会再问 Ignore this activity? [y/N]。

从源码构建

go build -o sensecraft-cli .
./sensecraft-cli --version

./script/build.sh

./script/build.sh 按 packages/cli/package.json 的版本号交叉编译到 dist/。

安全

Access Key 是密钥。不要提交进仓库,也不要贴进 Agent 对话。auth info 只打印 Key ID。

解绑、删除、发布、部署在带上 --yes 之前不会执行。Agent 必须先得到用户对这一次操作的确认,再加这个参数。

本工具不通过 USB 或串口烧录固件。recamera open 只打开控制台部署页。

许可证

MIT

版本与发布记录

@seeed-studio/sensecraft-cli 共发布 21 个版本,首次发布于 2026/06/11;过去 12 个月发布了 21 个版本。

版本发布日期距今
0.4.6latest2026/11/021 天前
0.4.52026/10/295 天前
0.4.42026/10/295 天前
0.4.32026/10/286 天前
0.4.22026/10/286 天前
0.4.12026/10/286 天前

关于 @seeed-studio/sensecraft-cli 的常见问题

@seeed-studio/sensecraft-cli 是什么?

SenseCAP / SenseCraft AI云CLI(设备、应用、模型、文件、云部署)

如何安装 @seeed-studio/sensecraft-cli?

在项目目录运行 npm install @seeed-studio/sensecraft-cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 sensecraft-cli,可以用 npx sensecraft-cli 直接运行。

@seeed-studio/sensecraft-cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/seeed-studio__sensecraft-cli 是否存在。

@seeed-studio/sensecraft-cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@seeed-studio/sensecraft-cli 可以商用吗?

@seeed-studio/sensecraft-cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@seeed-studio/sensecraft-cli 还在维护吗?

最新版本 0.4.6 发布于 2026/11/02(1 天前);至今共发布 21 个版本,其中过去 12 个月发布了 21 个;首次发布于 2026/06/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。