@elgato/cli 0.1.0 → 0.3.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,6 +5,7 @@
5
5
  # Maker CLI (Beta)
6
6
 
7
7
  [![Maker CLI npm package](https://img.shields.io/npm/v/%40elgato/cli?logo=npm&logoColor=white)](https://www.npmjs.com/package/@elgato/cli)
8
+ [![Build status](https://img.shields.io/github/actions/workflow/status/elgatosf/cli/build.yml?branch=main&label=Build&logo=GitHub)](https://github.com/elgatosf/cli/actions)
8
9
  [![SDK documentation](https://img.shields.io/badge/Documentation-2ea043?labelColor=grey&logo=gitbook&logoColor=white)](https://docs.elgato.com/sdk)
9
10
  [![Join the Marketplace Makers Discord](https://img.shields.io/badge/Marketplace%20Makers-5662f6?labelColor=grey&logo=discord&logoColor=white)](https://discord.gg/GehBUcu627)
10
11
  [![Elgato homepage](https://img.shields.io/badge/Elgato-3431cf?labelColor=grey&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48dGl0bGU+RWxnYXRvPC90aXRsZT48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJtMTMuODgxOCA4LjM5NjQuMDI2MS4wMTk2IDkuOTQ5NCA1LjcxNzJjLS40ODg0IDIuNzI5LTEuOTE5NiA1LjIyMjMtNC4wMzg0IDcuMDI1M0ExMS45MjYyIDExLjkyNjIgMCAwIDEgMTIuMDk3IDI0Yy0zLjE5MjUgMC02LjE5MzktMS4yNDc3LTguNDUyNy0zLjUxNDRDMS4zODY4IDE4LjIxODguMTQyNyAxNS4yMDQ0LjE0MjcgMTJjMC0zLjIwNDIgMS4yNDQtNi4yMTg3IDMuNTAxNS04LjQ4NTRDNS45MDE5IDEuMjQ4IDguOTAzMiAwIDEyLjA5NyAwYzIuNDM5NCAwIDQuNzg0Ny43MzMzIDYuNzgzIDIuMTE4NyAxLjk1MjYgMS4zNTQgMy40NDY2IDMuMjM1NyA0LjMyMjcgNS40NDIyLjExMTIuMjgyOS4yMTQ5LjU3MzYuMzA1MS44NjU3bC0yLjEyNTUgMS4yMzU5YTkuNDkyNCA5LjQ5MjQgMCAwIDAtLjI2MTktLjg2OTRjLTEuMzU0LTMuODMwMy00Ljk4MTMtNi40MDQ4LTkuMDIzNy02LjQwNDhDNi44MTcxIDIuMzg4MyAyLjUyMiA2LjcwMDUgMi41MjIgMTJjMCA1LjI5OTUgNC4yOTUgOS42MTE1IDkuNTc0OCA5LjYxMTUgMi4wNTIgMCA0LjAwODQtLjY0NDIgNS42NTk2LTEuODY0NyAxLjYxNzItMS4xOTU1IDIuODAzNi0yLjgzMzcgMy40MzA5LTQuNzM2NGwuMDA2NS0uMDQxOUw5LjU5MDYgOC4zMDQ4djcuMjI1Nmw0LjAwMDQtMi4zMTM4IDIuMDYgMS4xODExLTUuOTk2MiAzLjQ2ODgtMi4xMi0xLjIxMjZWNy4xOTQzbDIuMTE3NC0xLjIyNDUgNC4yMzA5IDIuNDI3OS0uMDAxMy0uMDAxMyIvPjwvc3ZnPg==)](https://elgato.com)
@@ -23,16 +24,15 @@ npm install -g @elgato/cli
23
24
  Usage: streamdeck [options] [command]
24
25
 
25
26
  Options:
26
- -h, --help display help for command
27
+ -h, --help display help for command
27
28
 
28
29
  Commands:
29
- create Creation wizard.
30
- link [path] Links the plugin to Stream Deck.
31
- restart|r <uuid> Starts the plugin in Stream Deck; if the plugin is already running, it is stopped first.
32
- stop|s <uuid> Stops the plugin in Stream Deck.
33
- dev [options] Enables developer mode.
34
- config Manage the local configuration.
35
- help [command] display help for command
30
+ create Stream Deck plugin creation wizard.
31
+ link [path] Links the plugin to Stream Deck.
32
+ restart|r <uuid> Starts the plugin in Stream Deck; if the plugin is already running, it is stopped first.
33
+ stop|s <uuid> Stops the plugin in Stream Deck.
34
+ dev [options] Enables developer mode.
35
+ config Manage the local configuration.
36
36
 
37
37
  Alias:
38
38
  streamdeck
@@ -124,6 +124,38 @@ Instructs Stream Deck to stop the plugin, as determined by the UUID. When stoppe
124
124
  #### See Also
125
125
 
126
126
  - [restart](#%EF%B8%8F-restart)
127
+ <!--
128
+
129
+ ## ✅ validate
130
+
131
+ Validates the Stream Deck plugin.
132
+
133
+ ### Synopsis
134
+
135
+ ```
136
+ streamdeck validate [path]
137
+ ```
138
+
139
+ ### Description
140
+
141
+ Validates the Stream Deck plugin in the current working directory, or `path` when specified, and outputs the validation results. By default, the command will automatically check and install validation rule updates; this check occurs daily, unless forced with `--force-update-check` or prevented with `--no-update-check`.
142
+
143
+ ### Configuration
144
+
145
+ #### `--force-update-check`
146
+
147
+ - Default: `false`
148
+ - Type: Boolean
149
+
150
+ Forces an update check of new validation rules; by default, an update check will occur once a day. Cannot be used in conjunction with `--no-update-check`.
151
+
152
+ #### `--no-update-check`
153
+
154
+ - Default: `false`
155
+ - Type: Boolean
156
+
157
+ Prevents an update check of new validation rules. This configuration option is recommended when using the CLI as part of a build pipeline. Cannot be used in conjunction with `--force-update-check`.
158
+ -->
127
159
 
128
160
  ## 🏗️ dev
129
161
 
@@ -198,3 +230,10 @@ Lists the defined configuration, eg. values defined using [config set](#set).
198
230
  - Type: Boolean
199
231
 
200
232
  Determines whether feedback provided should prefer reduced motion; when `true`, the busy indicator will be rendered as a static indicator.
233
+
234
+ #### packageManager
235
+
236
+ - Default: `npm`
237
+ - Type: bun | npm | pnpm | yarn
238
+
239
+ Determines the package manager to use when installing dependencies for every new project.