/cli

Stream Deck CLI tool for building with Stream Deck.

Primary LanguageTypeScriptMIT LicenseMIT

Stream Deck SDK banner

Stream Deck CLI

SDK documentation Elgato homepage Join the Marketplace Makers Discord Stream Deck CLI npm package Build status

Installation

npm install -g @elgato/cli@latest

Usage

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

Creating a Stream Deck plugin

The streamdeck create command enables you to scaffold a new Stream Deck plugin with ease. Running the command will initialize the creation wizard, and guide you through creating a new plugin.

Further Reading