Update: docs/CommandLineHelp.md

Screenly · Aug 16, 2024 · b48821d · b48821d
1 parent 6f91477
commit b48821d
Showing 1 changed file with 45 additions and 78 deletions.
diff --git a/docs/CommandLineHelp.md b/docs/CommandLineHelp.md
@@ -35,16 +35,15 @@ This document contains the help content for the `screenly` command-line program.
 * [`screenly edge-app list`↴](#screenly-edge-app-list)
 * [`screenly edge-app rename`↴](#screenly-edge-app-rename)
 * [`screenly edge-app run`↴](#screenly-edge-app-run)
-* [`screenly edge-app version`↴](#screenly-edge-app-version)
-* [`screenly edge-app version list`↴](#screenly-edge-app-version-list)
-* [`screenly edge-app version promote`↴](#screenly-edge-app-version-promote)
 * [`screenly edge-app setting`↴](#screenly-edge-app-setting)
 * [`screenly edge-app setting list`↴](#screenly-edge-app-setting-list)
 * [`screenly edge-app setting set`↴](#screenly-edge-app-setting-set)
-* [`screenly edge-app secret`↴](#screenly-edge-app-secret)
-* [`screenly edge-app secret list`↴](#screenly-edge-app-secret-list)
-* [`screenly edge-app secret set`↴](#screenly-edge-app-secret-set)
-* [`screenly edge-app upload`↴](#screenly-edge-app-upload)
+* [`screenly edge-app instance`↴](#screenly-edge-app-instance)
+* [`screenly edge-app instance list`↴](#screenly-edge-app-instance-list)
+* [`screenly edge-app instance create`↴](#screenly-edge-app-instance-create)
+* [`screenly edge-app instance delete`↴](#screenly-edge-app-instance-delete)
+* [`screenly edge-app instance update`↴](#screenly-edge-app-instance-update)
+* [`screenly edge-app deploy`↴](#screenly-edge-app-deploy)
 * [`screenly edge-app delete`↴](#screenly-edge-app-delete)
 * [`screenly edge-app validate`↴](#screenly-edge-app-validate)
 
@@ -426,10 +425,9 @@ Edge App related commands
 * `list` — Lists your Edge Apps
 * `rename` — Renames Edge App
 * `run` — Runs Edge App emulator
-* `version` — Version commands
 * `setting` — Settings commands
-* `secret` — Secrets commands
-* `upload` — Uploads assets and settings of the Edge App
+* `instance` — Instance commands
+* `deploy` — Deploys assets and settings of the Edge App and release it
 * `delete` — Deletes an Edge App. This cannot be undone
 * `validate` — Validates Edge App manifest file
 
@@ -470,7 +468,6 @@ Renames Edge App
 ###### **Options:**
 
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
-* `-a`, `--app-id <APP_ID>` — Edge App id. If not specified CLI will use the id from the manifest
 * `-n`, `--name <NAME>` — Edge App name
 
 
@@ -489,151 +486,122 @@ Runs Edge App emulator
 
 
 
-## `screenly edge-app version`
+## `screenly edge-app setting`
 
-Version commands
+Settings commands
 
-**Usage:** `screenly edge-app version <COMMAND>`
+**Usage:** `screenly edge-app setting <COMMAND>`
 
 ###### **Subcommands:**
 
-* `list` — Lists Edge App versions
-* `promote` — Promotes Edge App revision to channel
+* `list` — Lists Edge App settings
+* `set` — Sets Edge App setting
 
 
 
-## `screenly edge-app version list`
+## `screenly edge-app setting list`
 
-Lists Edge App versions
+Lists Edge App settings
 
-**Usage:** `screenly edge-app version list [OPTIONS]`
+**Usage:** `screenly edge-app setting list [OPTIONS]`
 
 ###### **Options:**
 
-* `-a`, `--app-id <APP_ID>` — Edge app id. If not specified CLI will use the id from the manifest
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
 * `-j`, `--json` — Enables JSON output
 
 
 
-## `screenly edge-app version promote`
+## `screenly edge-app setting set`
 
-Promotes Edge App revision to channel
+Sets Edge App setting
 
-**Usage:** `screenly edge-app version promote [OPTIONS]`
+**Usage:** `screenly edge-app setting set [OPTIONS] <SETTING_PAIR>`
 
-###### **Options:**
+###### **Arguments:**
 
-* `-r`, `--revision <REVISION>` — Edge app revision to promote
-* `-c`, `--channel <CHANNEL>` — Channel to promote to. If not specified CLI will use stable channel
+* `<SETTING_PAIR>` — Key value pair of the setting to be set in the form of `key=value`
 
-  Default value: `stable`
-* `-i`, `--installation-id <INSTALLATION_ID>` — Edge App Installation id. If not specified, CLI will use the installation_id from the manifest
-* `--latest` — Use the latest revision of the Edge App
+###### **Options:**
 
-  Default value: `false`
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
 
 
 
-## `screenly edge-app setting`
+## `screenly edge-app instance`
 
-Settings commands
+Instance commands
 
-**Usage:** `screenly edge-app setting <COMMAND>`
+**Usage:** `screenly edge-app instance <COMMAND>`
 
 ###### **Subcommands:**
 
-* `list` — Lists Edge App settings
-* `set` — Sets Edge App setting
+* `list` — Lists Edge App instances
+* `create` — Creates Edge App instance
+* `delete` — Deletes Edge App instance
+* `update` — Update Edge App instance based on changes in the instance.yml
 
 
 
-## `screenly edge-app setting list`
+## `screenly edge-app instance list`
 
-Lists Edge App settings
+Lists Edge App instances
 
-**Usage:** `screenly edge-app setting list [OPTIONS]`
+**Usage:** `screenly edge-app instance list [OPTIONS]`
 
 ###### **Options:**
 
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
-* `-i`, `--installation-id <INSTALLATION_ID>` — Edge App Installation id. If not specified, CLI will use the installation_id from the manifest
 * `-j`, `--json` — Enables JSON output
 
 
 
-## `screenly edge-app setting set`
+## `screenly edge-app instance create`
 
-Sets Edge App setting
+Creates Edge App instance
 
-**Usage:** `screenly edge-app setting set [OPTIONS] <SETTING_PAIR>`
-
-###### **Arguments:**
-
-* `<SETTING_PAIR>` — Key value pair of the setting to be set in the form of `key=value`
+**Usage:** `screenly edge-app instance create [OPTIONS]`
 
 ###### **Options:**
 
-* `-i`, `--installation-id <INSTALLATION_ID>` — Edge App Installation id. If not specified, CLI will use the installation_id from the manifest
+* `-n`, `--name <NAME>` — Name of the Edge App instance
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
 
 
 
-## `screenly edge-app secret`
+## `screenly edge-app instance delete`
 
-Secrets commands
+Deletes Edge App instance
 
-**Usage:** `screenly edge-app secret <COMMAND>`
-
-###### **Subcommands:**
-
-* `list` — Lists Edge App secrets
-* `set` — Sets Edge App secret
-
-
-
-## `screenly edge-app secret list`
-
-Lists Edge App secrets
-
-**Usage:** `screenly edge-app secret list [OPTIONS]`
+**Usage:** `screenly edge-app instance delete [OPTIONS]`
 
 ###### **Options:**
 
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
-* `-i`, `--installation-id <INSTALLATION_ID>` — Edge App Installation id. If not specified, CLI will use the installation_id from the manifest
-* `-j`, `--json` — Enables JSON output
-
 
 
-## `screenly edge-app secret set`
 
-Sets Edge App secret
+## `screenly edge-app instance update`
 
-**Usage:** `screenly edge-app secret set [OPTIONS] <SECRET_PAIR>`
-
-###### **Arguments:**
+Update Edge App instance based on changes in the instance.yml
 
-* `<SECRET_PAIR>` — Key value pair of the secret to be set in the form of `key=value`
+**Usage:** `screenly edge-app instance update [OPTIONS]`
 
 ###### **Options:**
 
-* `-i`, `--installation-id <INSTALLATION_ID>` — Edge App Installation id. If not specified, CLI will use the installation_id from the manifest
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
 
 
 
-## `screenly edge-app upload`
+## `screenly edge-app deploy`
 
-Uploads assets and settings of the Edge App
+Deploys assets and settings of the Edge App and release it
 
-**Usage:** `screenly edge-app upload [OPTIONS]`
+**Usage:** `screenly edge-app deploy [OPTIONS]`
 
 ###### **Options:**
 
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
-* `-a`, `--app-id <APP_ID>` — Edge App id. If not specified CLI will use the id from the manifest
 * `-d`, `--delete-missing-settings <DELETE_MISSING_SETTINGS>`
 
   Possible values: `true`, `false`
@@ -650,7 +618,6 @@ Deletes an Edge App. This cannot be undone
 ###### **Options:**
 
 * `-p`, `--path <PATH>` — Path to the directory with the manifest. If not specified CLI will use the current working directory
-* `-a`, `--app-id <APP_ID>` — Edge App id. If not specified CLI will use the id from the manifest