Introduction

Stream Deck CLI is a command-line interface tool for building, managing, and packaging Stream Deck plugins, and is the quickest way to get up-and-running when developing for Stream Deck.

Installation

Prerequisites

• Node.js version 20 or higher.
• Stream Deck version 6.4 or higher.
• Stream Deck device.

Learn more about installing Node.js.

Installing Node.js is best achieved with a Node version manager, such as:

• nvm for macOS
• nvm-windows for Windows

With one of the aforementioned nvm(-windows) installed, run the following commands:

1. Install Node.js:

   Terminal

   nvm install 20

2. Switch to the installed version of Node.js:

   Terminal

   nvm use 20

3. Restart your terminal and verify the version of Node.js is at least version 20:

   Terminal

   node -v

info

For more information on installing Node.js on Windows, we recommend Microsoft's how-to Install Node.js on Windows, or Node.js' download page.

Stream Deck

If you do not own a Stream Deck device, you can try Stream Deck Mobile for free.

Installing from NPM

We recommend installing Stream Deck CLI from npmjs using the command:

Terminal

npm install -g @elgato/cli@latest

Verifying

You can verify the installation was successful with the following command:

Terminal

streamdeck -v

The version of Stream Deck CLI should have printed in your terminal.

tip

In addition to streamdeck, you can also use the shorthand alias sd, for example streamdeck create and sd create are the same command.

Overview

With the Stream Deck CLI installed, you can run streamdeck to see an overview of what commands are available. This should look similar to the following.

Usage: streamdeck [options] [command]

Options:
  -v                            display CLI version
  -h, --help                    display help for command

Commands:
  create                        Stream Deck plugin creation wizard.
  link [path]                   Links the plugin to Stream Deck.
  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.
  help [command]                display help for command

Alias:
  streamdeck
  sd

What's next?

• Create your first Stream Deck plugin using the streamdeck create command.
• Join our wonderful Marketplace Maker Discord community.