@elgato/cli v0.2.0

Maker CLI

Installation

npm install -g @elgato/cli

Usage

Usage: streamdeck [options] [command]

Options:
  -h, --help        display help for command

Commands:
  create            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.
  config            Manage the local configuration.
  help [command]    display help for command

Alias:
  streamdeck
  sd

Commands

• createCreation wizard.
• linkLinks the plugin to Stream Deck.
• restartStarts the plugin in Stream Deck; if the plugin is already running, it is stopped first.
• stopStops the plugin in Stream Deck.
• devEnables developer mode.
• configManage the local configuration.

✏️ create

Creation wizard.

Synopsis

streamdeck create

Description

The creation wizard will guide you through creating Stream Deck plugins with our official Node.js SDK, and provides all scaffolding required to get started quickly. As part of the wizard, developer mode is enabled, and the plugin built and linked to Stream Deck making it ready for use.

See Also

• dev
• link

🔗 link

Links the plugin to Stream Deck.

Synopsis

streamdeck link [path]

Description

Links the specified path (folder) to Stream Deck, effectively installing the plugin, allowing it to be accessed from within Stream Deck. When the path is unspecified, the current working directory is used.

Note: The folder name should reflect the UUID of the plugin, and must be suffixed with .sdPlugin, eg. com.elgato.wave-link.sdPlugin.

♻️ restart

Starts the plugin in Stream Deck; if the plugin is already running, it is stopped first.

Synopsis

streamdeck restart <uuid>

alias: r

Description

Instructs Stream Deck to start the plugin, as determined by the UUID. If the plugin is already running within Stream Deck, it is first stopped and then started. As part of restarting the plugin all resources associated with the plugin, including manifest definitions, are reloaded.

See Also

• stop

🛑 stop

Stops the plugin in Stream Deck.

Synopsis

streamdeck stop <uuid>

alias: s

Description

Instructs Stream Deck to stop the plugin, as determined by the UUID. When stopped, the plugin and all of its resources are unloaded from Stream Deck allowing the plugin to be changed.

See Also

• restart

🏗️ dev

Enables developer mode.

Synopsis

streamdeck dev [-d|--disable]

Description

Developer mode enables the local development of Stream Deck plugins, and provides the Maker with additional capabilities for building and debugging with Stream Deck. Whilst enabled, Node.js plugins can be executed, and it is also possible to debug the property inspector locally at http://localhost:23654/.

⚙️ config

Manage the local configuration.

Synopsis

streamdeck config set <key>=<value> [<key>=<value>...]
streamdeck config unset <key> [<key>...]
streamdeck config list
streamdeck config reset

Description

The CLI gets its configuration settings from the user's local environment. These configuration settings define the output of commands and how they're executed, and enable customization of interaction. The streamdeck config command can be used to update and manage these settings.

Sub-commands

set

streamdeck config set <key>=<value> [<key>=<value>...]

Sets each of the configuration keys to the value provided.

unset

streamdeck config <key> [<key>...]

Sets each of the configuration keys to their default values.

reset

streamdeck config reset

Resets all configuration keys to their default values.

list

streamdeck config list

Lists the defined configuration, eg. values defined using config set.

Configuration

create.mode

• Default: prod
• Type: prod or dev
  • prod, the latest supported published version.
  • dev, the version defined within npm.streamDeck.

Specifies the npm version of @elgato/streamdeck to use when creating a Stream Deck plugin via create.

npm.streamDeck

• Default: undefined
• Type: String

The development npm version of @elgato/streamdeck to use when creating a Stream Deck plugin via create. The value can be a version or local path.

reduceMotion

• Default: false
• Type: Boolean

Determines whether feedback provided should prefer reduced motion; when true, the busy indicator will be rendered as a static indicator.