Stream Deck CLI

https://docs.elgato.com/streamdeck/cli/
Admin
Stream Deck CLI is a command-line interface tool for building, managing, and packaging Stream Deck...
Tokens:2,995
Snippets:55
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Set Configuration Examples

Source: https://docs.elgato.com/streamdeck/cli/commands/config

Examples of updating specific configuration properties.

```bash
streamdeck config set packageManager=yarn
```

```bash
streamdeck config set reduceMotion=true
```

--------------------------------

### Install Stream Deck CLI

Source: https://docs.elgato.com/streamdeck/cli/intro

Global installation of the Stream Deck CLI package from npm.

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

--------------------------------

### Execute Stream Deck plugin creation

Source: https://docs.elgato.com/streamdeck/cli/commands/create

Run the command to start the interactive scaffolding wizard.

```bash
streamdeck create
```

--------------------------------

### Install Node.js via nvm

Source: https://docs.elgato.com/streamdeck/cli/intro

Commands to install and activate Node.js version 24 using a version manager.

```bash
nvm install 24
```

```bash
nvm use 24
```

```bash
node -v
```

--------------------------------

### List all plugins

Source: https://docs.elgato.com/streamdeck/cli/commands/list

Displays all installed plugins, regardless of their link status.

```bash
streamdeck list --all
```

--------------------------------

### Verify CLI Installation

Source: https://docs.elgato.com/streamdeck/cli/intro

Checks that the Stream Deck CLI is installed and accessible.

```bash
streamdeck -v
```

--------------------------------

### streamdeck list

Source: https://docs.elgato.com/streamdeck/cli/commands/list

Displays a list of installed plugins and their source paths.

```APIDOC
## streamdeck list

### Description
Displays a list of installed plugins and their source paths.

### Synopsis
`streamdeck list [options]`

### Options
- **-a, --all** (boolean) - Optional - Show all plugins. Default is false.

### Examples
- `streamdeck list`
- `streamdeck -l`
- `streamdeck list --all`
```

--------------------------------

### Stream Deck creation wizard output

Source: https://docs.elgato.com/streamdeck/cli/commands/create

Example of the interactive terminal prompts and success feedback provided by the wizard.

```text
.___ _                        ___         _ 
/ __| |_ _ _ ___ __ _ _ __   |   \ ___ __| |__
\__ \  _| '_/ -_) _` | '  \  | |) / -_) _| / /
|___/\__|_| \___\__,_|_|_|_| |___/\___\__|\_\_

Welcome to the Stream Deck Plugin creation wizard.

This utility will guide you through creating a local development environment for a plugin.
For more information on building plugins see https://docs.elgato.com.

Press ^C at any time to quit.

? Author: Elgato
? Plugin Name: Counter
? Plugin UUID: com.elgato.counter
? Description: A simple counter that increments on each press

? Create Stream Deck plugin from information above? Yes

Creating Counter...
✔ Enabling developer mode
✔ Generating plugin
✔ Installing dependencies
✔ Building plugin
✔ Finalizing setup

Successfully created plugin!

? Would you like to open the plugin in VS Code? (Y/n)
```

--------------------------------

### streamdeck link

Source: https://docs.elgato.com/streamdeck/cli/commands/link

Links a directory to the Stream Deck application to install a plugin. The directory must follow the naming convention [UUID].sdPlugin.

```APIDOC
## streamdeck link

### Description
Links the specified directory to Stream Deck, effectively installing the plugin. If no path is provided, the current working directory is used.

### Usage
`streamdeck link <path>`

### Arguments
- **path** (string) - Optional - The path to the plugin directory. The directory name must match the plugin UUID and end with .sdPlugin.

### Examples
Link current directory:
`streamdeck link`

Link specific directory:
`streamdeck link com.elgato.hello-world.sdPlugin`
```

--------------------------------

### Unlink a plugin via terminal

Source: https://docs.elgato.com/streamdeck/cli/commands/unlink

Removes the specified plugin from the Stream Deck installation.

```bash
streamdeck unlink com.elgato.hello-world
```

--------------------------------

### CLI Configuration Synopsis

Source: https://docs.elgato.com/streamdeck/cli/commands/config

Overview of available configuration commands for managing settings.

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

--------------------------------

### View CLI Help

Source: https://docs.elgato.com/streamdeck/cli/intro

Displays the usage information and available commands for the Stream Deck CLI.

```text
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
```

--------------------------------

### Pack a plugin to a specific directory

Source: https://docs.elgato.com/streamdeck/cli/commands/pack

Packages the plugin located in the specified path and saves the output to the designated directory.

```bash
streamdeck pack com.elgato.test.sdPlugin/ --output dist/
```

--------------------------------

### Sub-command Usage

Source: https://docs.elgato.com/streamdeck/cli/commands/config

Individual command syntax for managing configuration states.

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

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

```bash
streamdeck config reset
```

```bash
streamdeck config list
```

--------------------------------

### Perform a dry run of the packaging process

Source: https://docs.elgato.com/streamdeck/cli/commands/pack

Generates a report of the packaging process without creating the actual .streamDeckPlugin file.

```bash
streamdeck pack --dry-run
```

--------------------------------

### List linked plugins

Source: https://docs.elgato.com/streamdeck/cli/commands/list

Displays a list of currently linked plugins.

```bash
streamdeck list
```

```bash
streamdeck -l
```

--------------------------------

### Link plugin directory

Source: https://docs.elgato.com/streamdeck/cli/commands/link

Commands to link a plugin directory to the Stream Deck application.

```bash
streamdeck link
```

```bash
streamdeck link com.elgato.hello-world.sdPlugin
```

--------------------------------

### Enable developer mode

Source: https://docs.elgato.com/streamdeck/cli/commands/dev

Activates developer mode to allow debugging of plugins and property inspectors.

```bash
streamdeck dev
```

--------------------------------

### Pack current directory with a specific version

Source: https://docs.elgato.com/streamdeck/cli/commands/pack

Bundles the current working directory as a plugin and updates the manifest version.

```bash
streamdeck pack --version "0.8.2.12"
```

--------------------------------

### Restart a Stream Deck plugin

Source: https://docs.elgato.com/streamdeck/cli/commands/restart

Restarts the plugin identified by the provided UUID.

```bash
streamdeck restart <uuid>
```

```bash
streamdeck restart com.elgato.hello-world
```

--------------------------------

### Configure PowerShell Execution Policy

Source: https://docs.elgato.com/streamdeck/cli/intro

Sets the execution policy to allow running local PowerShell scripts on Windows.

```powershell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
```

--------------------------------

### Validate a specific plugin directory

Source: https://docs.elgato.com/streamdeck/cli/commands/validate

Validates the plugin located at the specified path.

```bash
streamdeck validate com.elgato.hello-world.sdPlugin
```

--------------------------------

### Disable developer mode

Source: https://docs.elgato.com/streamdeck/cli/commands/dev

Deactivates developer mode using the --disable flag.

```bash
streamdeck dev --disable
```

--------------------------------

### Stop a Stream Deck plugin

Source: https://docs.elgato.com/streamdeck/cli/commands/stop

Use this command to stop a specific plugin identified by its UUID.

```bash
streamdeck stop com.elgato.hello-world
```

--------------------------------

### streamdeck restart <uuid>

Source: https://docs.elgato.com/streamdeck/cli/commands/restart

Restarts the specified Stream Deck plugin by its UUID.

```APIDOC
## streamdeck restart <uuid>

### Description
Instructs Stream Deck to restart (stop and then start) the Stream Deck plugin, identified by the plugin's UUID. If the plugin is not already running, Stream Deck will start it. Restarting the plugin will result in all resources associated with the plugin, including the manifest JSON file, being reloaded.

### Usage
`streamdeck restart <uuid>`

### Parameters
- **uuid** (string) - Required - The unique identifier of the plugin to restart.

### Example
`streamdeck restart com.elgato.hello-world`
```

--------------------------------

### Validate with forced schema update

Source: https://docs.elgato.com/streamdeck/cli/commands/validate

Validates the current directory while forcing an update check for the latest validation schemas.

```bash
streamdeck validate --force-update-check
```

--------------------------------

### streamdeck unlink

Source: https://docs.elgato.com/streamdeck/cli/commands/unlink

Unlinks a developer plugin from the Stream Deck, effectively uninstalling it while preserving the source directory.

```APIDOC
## streamdeck unlink

### Description
Unlinks the linked (developer) plugin from Stream Deck, effectively uninstalling it. The plugin's original source directory remains unaffected.

### Usage
`streamdeck unlink [options] <uuid>`

### Arguments
- **uuid** (string) - Required - The unique identifier of the plugin to unlink.

### Options
- **-d, --delete** (boolean) - Optional - Enables deletion of non-linked plugins. Default is false.
```

--------------------------------

### streamdeck stop <uuid>

Source: https://docs.elgato.com/streamdeck/cli/commands/stop

Stops the Stream Deck plugin identified by the provided UUID.

```APIDOC
## streamdeck stop <uuid>

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

### Usage
`streamdeck stop <uuid>`

### Arguments
- **uuid** (string) - Required - The unique identifier of the plugin to be stopped.

### Example
`streamdeck stop com.elgato.hello-world`
```
Tokens:
Raw