@elgato/cli 0.3.0-beta.2 → 0.3.0-beta.4

package/README.md

@@ -24,15 +24,19 @@ npm install -g @elgato/cli
 Usage: streamdeck [options] [command]
 
 Options:
-  -h, --help                 display help for command
+  -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.
-  config                     Manage the local configuration.
+  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]  Create a .streamDeckPlugin file from the plugin.
+  config                        Manage the local configuration.
+  help [command]                display help for command
 
 Alias:
   streamdeck
@@ -45,6 +49,8 @@ Alias:
 - [link](#-link)<br />Links the plugin to Stream Deck.
 - [restart](#%EF%B8%8F-restart)<br />Starts the plugin in Stream Deck; if the plugin is already running, it is stopped first.
 - [stop](#-stop)<br />Stops the plugin in Stream Deck.
+- [validate](#sd-validate) (beta)<br />Validates the Stream Deck plugin.
+- [pack](#sd-pack) (beta)<br />Create a .streamDeckPlugin file from the plugin.
 - [dev](#%EF%B8%8F-dev)<br />Enables developer mode.
 - [config](#%EF%B8%8F-config)<br />Manage the local configuration.
 
@@ -124,9 +130,10 @@ Instructs Stream Deck to stop the plugin, as determined by the UUID. When stoppe
 #### See Also
 
 - [restart](#%EF%B8%8F-restart)
-<!--
 
-## ✅ validate
+<h3 id="sd-validate">
+	✅ validate (beta)
+</h3>
 
 Validates the Stream Deck plugin.
 
@@ -134,6 +141,13 @@ Validates the Stream Deck plugin.
 
 ```
 streamdeck validate [path]
+
+Arguments:
+  path                  Path of the plugin to validate
+
+Options:
+  --force-update-check  Forces an update check (default: false)
+  --no-update-check     Disables updating schemas
 ```
 
 ### Description
@@ -155,7 +169,101 @@ Forces an update check of new validation rules; by default, an update check will
 - Type: Boolean
 
 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`.
--->
+
+<h3 id="sd-pack">
+	📦 pack (beta)
+</h3>
+
+Creates a .streamDeckPlugin file from the plugin.
+
+### Synopsis
+
+```
+streamdeck pack [options] [path]
+
+Arguments:
+  path                  Path of the plugin to pack
+
+Options:
+  --dry-run             Generates a report without creating a package (default: false)
+  -f|--force            Forces saving, overwriting an package if it exists (default: false)
+  -o|--output <output>  Specifies the path for the output directory
+  --version <version>   Plugin version; value will be written to the manifest"
+  --force-update-check  Forces an update check (default: false)
+  --no-update-check     Disables updating schemas
+
+alias: bundle
+```
+
+### Description
+
+Creates a `.streamDeckPlugin` installer file allowing the plugin to be distributed. The plugin must pass [validation](#sd-validate) prior to bundling.
+
+By default, all files within the specified `path` are included except `.git`, `/.env*`, `*.log`, and `*.js.map` directories and files. To specify directories or files that should be ignored, a `.sdignore` file can be created in the root of the plugin, i.e. alongside the manifest, using [`.gitignore` specification](https://git-scm.com/docs/gitignore).
+
+### Example
+
+Create a `.streamDeckPlugin` of the plugin located in `com.elgato.test.sdPlugin/`, writing the packaged file to a `dist/` folder, specifying the new version.
+
+```
+streamdeck pack com.elgato.test.sdPlugin/ --output dist/
+```
+
+Create a `.streamDeckPlugin` of the current working directory, specifying a new version of the plugin.
+
+```
+streamdeck pack --version 0.8.2
+```
+
+Generate a report for the plugin in the current working directory, without creating a `.streamDeckPlugin` file.
+
+```
+streamdeck pack --dry-run
+```
+
+### Configuration
+
+#### `--dry-run`
+
+- Default: `false`
+- Type: Boolean
+
+Generates a report without creating a package.
+
+#### `-f|--force`
+
+- Default: `false`
+- Type: Boolean
+
+Determines whether to overwrite the existing `.streamDeckPlugin` file if one already exists at the specified `output` directory.
+
+#### `-o|--output <output>`
+
+- Default: `cwd`
+- Type: String
+
+Specifies the path for the output directory where the `.streamDeckPlugin` file will be created.
+
+#### `--version <version>`
+
+- Default: `undefined`
+- Type: String (semver)
+
+Plugin version; value will be written to the manifest's `Version` property prior to packaging the plugin.
+
+#### `--force-update-check`
+
+- Default: `false`
+- Type: Boolean
+
+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`.
+
+#### `--no-update-check`
+
+- Default: `false`
+- Type: Boolean
+
+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`.
 
 ## 🏗️ dev