# @elgato/cli 中文文档

规范地址：https://npmcn.com/package/%40elgato/cli/

版本：1\.10\.4
npm 元数据更新时间：2026-10-29T14:40:28.289Z
中文译文更新时间：2026-11-13T12:25:16.535Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40elgato/cli
原文对照：https://npmcn.com/package/%40elgato/cli/?lang=original
项目主页：https://github.com/elgatosf/streamdeck/tree/main/packages/cli#readme
源码仓库：https://github.com/elgatosf/streamdeck

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

- 包体积（解压后）：2.2 MB，24 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.1\.0
- 运行依赖：15 个
- 首次发布：2023-09-29T17:44:39.277Z
- 最新版本发布：2026-10-29T14:40:27.065Z
- 近 30 天下载量：56981（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 13 个）

## 中文简介

Stream Deck CLI 用于与 Stream Deck 一起构建的工具.

## 安装

```sh
npm install @elgato/cli
```

也可以使用：`pnpm add @elgato/cli`、`yarn add @elgato/cli`、`bun add @elgato/cli`

## README

[![Stream Deck SDK banner](https://images.ctfassets.net/8j9xr8kwdre8/1ihLKCwNWEfPixs27dq0c0/130be66a5173f332e4caa892a3462893/banner.png)](https://docs.elgato.com/sdk)

# 流出地标 CLI

[![SDK documentation](https://img.shields.io/badge/Documentation-2ea043?labelColor=grey&logo=gitbook&logoColor=white)](https://docs.elgato.com/streamdeck/cli) [![Elgato homepage](https://img.shields.io/badge/Elgato-3431cf?labelColor=grey&logo=elgato)](https://elgato.com/) [![Join the Marketplace Makers Discord](https://img.shields.io/badge/Marketplace%20Makers-5662f6?labelColor=grey&logo=discord&logoColor=white)](https://discord.gg/GehBUcu627) [![Stream Deck CLI npm package](https://img.shields.io/npm/v/%40elgato/cli?logo=npm&logoColor=white)](https://www.npmjs.com/package/@elgato/cli) [![Build status](https://img.shields.io/github/actions/workflow/status/elgatosf/streamdeck/build.yml?branch=main&label=Build&logo=GitHub)](https://github.com/elgatosf/streamdeck/actions)

## 安装

```
npm install -g @elgato/cli@latest
```

## 使用量

```
Usage: streamdeck [options] [command]

Options:
  -v                            display CLI version
  -l, --list                    display list of installed plugins
  -h, --help                    display help for command

Commands:
  create                        Stream Deck plugin creation wizard.
  link [path]                   Links the plugin to Stream Deck.
  unlink [options] <uuid>       Unlinks the plugin from Stream Deck.
  list [options]                Display list of installed plugins.
  restart|r <uuid>              Starts the plugin in Stream Deck; if the plugin is already running, it is stopped first.
  stop|s <uuid>                 Stops the plugin in Stream Deck.
  dev [options]                 Enables developer mode.
  validate [options] [path]     Validates the Stream Deck plugin.
  pack|bundle [options] [path]  Creates a .streamDeckPlugin file from the plugin.
  config                        Manage the local configuration.

Alias:
  streamdeck
  sd
```

## 创建 Stream Deck 插件

这个 `streamdeck create` 命令使您能够轻松地脚手架上一个新的 Stream Deck 插件。 运行命令将初始化创建向导,并通过创建新插件引导您 .

![](https://npmcn.com/package/%40elgato/cli/assets/cli-create.gif)

## 进一步阅读

-   学习更多关于 [流出 Deck CLI 命令](https://docs.elgato.com/streamdeck/cli)。 。 。 .
-   阅读 [开始使用 SDK](https://docs.elgato.com/sdk)。 。 。 .

## 常见问题

### @elgato/cli 是什么？

Stream Deck CLI 用于与 Stream Deck 一起构建的工具\.

### 如何安装 @elgato/cli？

在项目目录运行 npm install @elgato/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 sd、streamdeck，可以用 npx sd 直接运行。

### @elgato/cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @elgato/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @elgato/cli 需要什么版本的 Node\.js？

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

### @elgato/cli 可以商用吗？

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

### @elgato/cli 的下载量有多少？

根据 npm 官方下载统计，@elgato/cli 在 2026/10/14 – 2026/11/12 这 30 天内被下载 56,981 次，日均约 1,899 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @elgato/cli 还在维护吗？

最新版本 1\.10\.4 发布于 2026/10/29（15 天前）；至今共发布 39 个版本，其中过去 12 个月发布了 13 个；首次发布于 2023/09/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。