# @seeed-studio/sensecraft-cli 中文文档

规范地址：https://npmcn.com/package/%40seeed-studio/sensecraft-cli/

版本：0\.4\.6
npm 元数据更新时间：2026-11-02T09:48:46.280Z
中文译文更新时间：2026-11-02T10:33:11.496Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40seeed-studio/sensecraft-cli
原文对照：https://npmcn.com/package/%40seeed-studio/sensecraft-cli/?lang=original
项目主页：https://github.com/Seeed-Solution/sensecraft-cli#readme
源码仓库：https://github.com/Seeed-Solution/sensecraft-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：281 kB，40 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=16
- 运行依赖：0 个
- 首次发布：2026-06-11T03:28:43.629Z
- 最新版本发布：2026-11-02T09:48:46.115Z
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

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

## 安装

```sh
npm install @seeed-studio/sensecraft-cli
```

也可以使用：`pnpm add @seeed-studio/sensecraft-cli`、`yarn add @seeed-studio/sensecraft-cli`、`bun add @seeed-studio/sensecraft-cli`

## README

# sensecraft-cli

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/LICENSE) [![Go Version](https://img.shields.io/badge/go-%3E%3D1.25-blue.svg)](https://go.dev/) [![npm version](https://img.shields.io/npm/v/@seeed-studio/sensecraft-cli.svg)](https://www.npmjs.com/package/@seeed-studio/sensecraft-cli)

[中文](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/README.zh.md) | [English](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/README.md)

[SenseCAP](https://sensecap.seeed.cc/) 设备与 [SenseCraft AI](https://sensecraft.seeed.cc/) 的命令行工具。一把 OpenAPI Access Key 即可访问设备、遥测、应用、模型、文件和云设备。给人用，也给 AI Agent 用。Skills 在 [`skills/`](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/skills/)。

[安装](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/#readme-%E5%AE%89%E8%A3%85) · [AI Agent](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/#readme-%E7%BB%99-ai-agent) · [Skills](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/#readme-agent-skills) · [登录](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/#readme-%E7%99%BB%E5%BD%95) · [命令](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/#readme-%E5%91%BD%E4%BB%A4) · [进阶](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/#readme-%E8%BF%9B%E9%98%B6) · [安全](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/#readme-%E5%AE%89%E5%85%A8)

## 能做什么

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

网页控制台是 [https://sensecraft.seeed.cc](https://sensecraft.seeed.cc/)。

## 安装

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

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

Windows 上的命令名是 `sensecraft-cli.cmd`。PATH、升级和卸载见 [`INSTALL.md`](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/INSTALL.md)。

### 三步上手

在 SenseCAP 门户创建 OpenAPI Access Key，然后：

```bash
# 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.  如果没有命令，先安装：

```bash
npx @seeed-studio/sensecraft-cli install
```

2.  请用户在自己的电脑上运行 `auth add`。
3.  确认钥匙已经生效：

```bash
sensecraft-cli auth info
```

4.  再跑只读命令，例如 `sensecraft-cli device list` 或 `sensecraft-cli app list --public`。
5.  先读 [`skills/sensecraft-cli/SKILL.md`](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/skills/sensecraft-cli/SKILL.md)，它会转到对应的产品说明。

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

## Agent Skills

| Skill | 说明 |
| --- | --- |
| [`sensecraft-cli`](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/skills/sensecraft-cli/SKILL.md) | SenseCraft Data、SenseCraft AI 和 CodeCraft Hub |
| [`create-app`](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/skills/sensecraft-cli/create-app/SKILL.md) | 把本地项目做成 CodeCraft Hub 应用 |

全局 npm 安装之后：

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

## 登录

| 命令 | 说明 |
| --- | --- |
| `auth add` | 校验 Access Key，写入本机，并设为当前钥匙 |
| `auth info` | 显示站点、组织 ID 和 Key ID |

```bash
sensecraft-cli auth add --key-id <Key ID> --access-key <Access Key> --site Global
sensecraft-cli auth info
```

| `--site` | SenseCAP OpenAPI | SenseCraft AI OpenAPI |
| --- | --- | --- |
| `Global` | `https://sensecap.seeed.cc/openapi` | `https://api-gateway.seeed.cc/openapi` |
| `China` | `https://sensecap.seeed.cn/openapi` | `https://api-gateway.seeed.cc/openapi` |

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

## 命令

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

```bash
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` | 最新遥测、历史、折线点 |
| `app` | CodeCraft 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]`。

## 从源码构建

```bash
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](https://npmcn.com/package/%40seeed-studio/sensecraft-cli/LICENSE)

## 常见问题

### @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 和提交记录判断。