@elgato/cli 0.3.0-beta.5 → 0.3.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
@@ -34,7 +34,7 @@ Commands:
34
34
  stop|s <uuid> Stops the plugin in Stream Deck.
35
35
  dev [options] Enables developer mode.
36
36
  validate [options] [path] Validates the Stream Deck plugin.
37
- pack|bundle [options] [path] Create a .streamDeckPlugin file from the plugin.
37
+ pack|bundle [options] [path] Creates a .streamDeckPlugin file from the plugin.
38
38
  config Manage the local configuration.
39
39
  help [command] display help for command
40
40
 
@@ -45,14 +45,14 @@ Alias:
45
45
 
46
46
  ## Commands
47
47
 
48
- - [create](#%EF%B8%8F-create)<br />Creation wizard.
49
- - [link](#-link)<br />Links the plugin to Stream Deck.
50
- - [restart](#%EF%B8%8F-restart)<br />Starts the plugin in Stream Deck; if the plugin is already running, it is stopped first.
51
- - [stop](#-stop)<br />Stops the plugin in Stream Deck.
52
- - [validate](#sd-validate) (beta)<br />Validates the Stream Deck plugin.
53
- - [pack](#sd-pack) (beta)<br />Create a .streamDeckPlugin file from the plugin.
54
- - [dev](#%EF%B8%8F-dev)<br />Enables developer mode.
55
- - [config](#%EF%B8%8F-config)<br />Manage the local configuration.
48
+ - [create](#%EF%B8%8F-create)<br />Creation wizard.
49
+ - [link](#-link)<br />Links the plugin to Stream Deck.
50
+ - [restart](#%EF%B8%8F-restart)<br />Starts the plugin in Stream Deck; if the plugin is already running, it is stopped first.
51
+ - [stop](#-stop)<br />Stops the plugin in Stream Deck.
52
+ - [validate](#sd-validate)<br />Validates the Stream Deck plugin.
53
+ - [pack](#sd-pack)<br />Creates a .streamDeckPlugin file from the plugin.
54
+ - [dev](#%EF%B8%8F-dev)<br />Enables developer mode.
55
+ - [config](#%EF%B8%8F-config)<br />Manage the local configuration.
56
56
 
57
57
  ## ✏️ create
58
58
 
@@ -72,8 +72,8 @@ The creation wizard will guide you through creating Stream Deck plugins with our
72
72
 
73
73
  #### See Also
74
74
 
75
- - [dev](#%EF%B8%8F-dev)
76
- - [link](#-link)
75
+ - [dev](#%EF%B8%8F-dev)
76
+ - [link](#-link)
77
77
 
78
78
  ## 🔗 link
79
79
 
@@ -109,7 +109,7 @@ Instructs Stream Deck to start the plugin, as determined by the UUID. If the plu
109
109
 
110
110
  #### See Also
111
111
 
112
- - [stop](#-stop)
112
+ - [stop](#-stop)
113
113
 
114
114
  ## 🛑 stop
115
115
 
@@ -129,10 +129,10 @@ Instructs Stream Deck to stop the plugin, as determined by the UUID. When stoppe
129
129
 
130
130
  #### See Also
131
131
 
132
- - [restart](#%EF%B8%8F-restart)
132
+ - [restart](#%EF%B8%8F-restart)
133
133
 
134
134
  <h3 id="sd-validate">
135
- ✅ validate (beta)
135
+ ✅ validate
136
136
  </h3>
137
137
 
138
138
  Validates the Stream Deck plugin.
@@ -158,20 +158,20 @@ Validates the Stream Deck plugin in the current working directory, or `path` whe
158
158
 
159
159
  #### `--force-update-check`
160
160
 
161
- - Default: `false`
162
- - Type: Boolean
161
+ - Default: `false`
162
+ - Type: Boolean
163
163
 
164
164
  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`.
165
165
 
166
166
  #### `--no-update-check`
167
167
 
168
- - Default: `false`
169
- - Type: Boolean
168
+ - Default: `false`
169
+ - Type: Boolean
170
170
 
171
171
  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`.
172
172
 
173
173
  <h3 id="sd-pack">
174
- 📦 pack (beta)
174
+ 📦 pack
175
175
  </h3>
176
176
 
177
177
  Creates a .streamDeckPlugin file from the plugin.
@@ -225,43 +225,43 @@ streamdeck pack --dry-run
225
225
 
226
226
  #### `--dry-run`
227
227
 
228
- - Default: `false`
229
- - Type: Boolean
228
+ - Default: `false`
229
+ - Type: Boolean
230
230
 
231
231
  Generates a report without creating a package.
232
232
 
233
233
  #### `-f|--force`
234
234
 
235
- - Default: `false`
236
- - Type: Boolean
235
+ - Default: `false`
236
+ - Type: Boolean
237
237
 
238
238
  Determines whether to overwrite the existing `.streamDeckPlugin` file if one already exists at the specified `output` directory.
239
239
 
240
240
  #### `-o|--output <output>`
241
241
 
242
- - Default: `cwd`
243
- - Type: String
242
+ - Default: `cwd`
243
+ - Type: String
244
244
 
245
245
  Specifies the path for the output directory where the `.streamDeckPlugin` file will be created.
246
246
 
247
247
  #### `--version <version>`
248
248
 
249
- - Default: `undefined`
250
- - Type: String (semver)
249
+ - Default: `undefined`
250
+ - Type: String (semver)
251
251
 
252
252
  Plugin version; value will be written to the manifest's `Version` property prior to packaging the plugin.
253
253
 
254
254
  #### `--force-update-check`
255
255
 
256
- - Default: `false`
257
- - Type: Boolean
256
+ - Default: `false`
257
+ - Type: Boolean
258
258
 
259
259
  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`.
260
260
 
261
261
  #### `--no-update-check`
262
262
 
263
- - Default: `false`
264
- - Type: Boolean
263
+ - Default: `false`
264
+ - Type: Boolean
265
265
 
266
266
  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`.
267
267
 
@@ -334,14 +334,14 @@ Lists the defined configuration, eg. values defined using [config set](#set).
334
334
 
335
335
  #### reduceMotion
336
336
 
337
- - Default: `false`
338
- - Type: Boolean
337
+ - Default: `false`
338
+ - Type: Boolean
339
339
 
340
340
  Determines whether feedback provided should prefer reduced motion; when `true`, the busy indicator will be rendered as a static indicator.
341
341
 
342
342
  #### packageManager
343
343
 
344
- - Default: `npm`
345
- - Type: bun | npm | pnpm | yarn
344
+ - Default: `npm`
345
+ - Type: bun | npm | pnpm | yarn
346
346
 
347
347
  Determines the package manager to use when installing dependencies for every new project.