@signageos/cli 2.6.1 → 2.7.1

package/docs/applet/test/index.md

@@ -1,7 +1,7 @@
 ---
 id: applet-test-index
 title: test
-sidebar_position: 24
+sidebar_position: 1014
 ---
 # test
 

package/docs/applet/test/run/index.md

@@ -1,7 +1,7 @@
 ---
 id: applet-test-run-index
 title: run
-sidebar_position: 26
+sidebar_position: 1156
 ---
 # run
 

package/docs/applet/test/upload/index.md

@@ -1,7 +1,7 @@
 ---
 id: applet-test-upload-index
 title: upload
-sidebar_position: 25
+sidebar_position: 1155
 ---
 # upload
 

package/docs/applet/upload/index.md

@@ -1,7 +1,7 @@
 ---
 id: applet-upload-index
 title: upload
-sidebar_position: 25
+sidebar_position: 1015
 ---
 # upload
 

package/docs/autocomplete/index.md

@@ -1,7 +1,7 @@
 ---
 id: autocomplete-index
 title: autocomplete
-sidebar_position: 70
+sidebar_position: 3000
 ---
 # autocomplete
 

package/docs/autocomplete/install/index.md

@@ -1,7 +1,7 @@
 ---
 id: autocomplete-install-index
 title: install
-sidebar_position: 71
+sidebar_position: 3011
 ---
 # install
 

package/docs/autocomplete/uninstall/index.md

@@ -1,7 +1,7 @@
 ---
 id: autocomplete-uninstall-index
 title: uninstall
-sidebar_position: 72
+sidebar_position: 3012
 ---
 # uninstall
 

package/docs/custom-script/generate/index.md

@@ -1,7 +1,7 @@
 ---
 id: custom-script-generate-index
 title: generate
-sidebar_position: 51
+sidebar_position: 1031
 ---
 # generate
 
@@ -11,8 +11,9 @@ Generate a local repository for developing a Custom Script
 ## Description
 
 Creates a new custom script project with boilerplate code and configuration files.
-This command sets up a complete development environment for custom script development,
-including necessary dependencies and project structure.
+Generates `.sosconfig.json`, platform directories, and sample implementations.
+
+Requires: name, description, dangerLevel (low/medium/high/critical).
 
 ## Usage
 
@@ -20,11 +21,23 @@ including necessary dependencies and project structure.
 sos custom-script generate [options]
 ```
 
+## Options
+
+| Option           | Description                                                                                                                                                                                                                   |
+| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--name`         | Custom script name (string)                                                                                                                                                                                                   |
+| `--description`  | Custom script description (string)                                                                                                                                                                                            |
+| `--danger-level` | Danger level - Can be one of the following: low, medium, high, critical. It represents the danger level of the Custom Script. It should be set according to the potential impact of the Custom Script on the device. (string) |
+| `--yes`          | Skip confirmation prompts and use provided values (boolean)                                                                                                                                                                   |
+
 ## Examples
 
 ```bash
-# Generate custom script project
+# Interactive generation
 sos custom-script generate
+
+# Non-interactive (CI/CD)
+sos custom-script generate --name brightness-control --description "Device brightness" --danger-level low --yes
 ```
 
 ## Since
@@ -62,5 +75,6 @@ sos --profile production organization list
 
 ## See Also
 
-- [Custom Scripts Documentation](https://developers.signageos.io/docs/custom-scripts/)
-- [Upload custom script command](../upload/)
+- [Documentation](https://developers.signageos.io/docs/custom-scripts/)
+- [Config File](https://developers.signageos.io/docs/custom-scripts/#config-file)
+- [Upload command](../upload/)

package/docs/custom-script/index.md

@@ -1,7 +1,7 @@
 ---
 id: custom-script-index
 title: custom-script
-sidebar_position: 50
+sidebar_position: 1010
 ---
 # custom-script
 
@@ -10,9 +10,10 @@ Custom Script management
 
 ## Description
 
-Provides commands for developing and deploying custom scripts to signageOS devices.
-Custom Scripts enable advanced device functionality beyond standard applets,
-including system-level operations and device-specific configurations.
+Custom Scripts management for advanced device operations.
+
+Allows sending OS-specific scripts with native API access to signageOS devices.
+Supports JavaScript (browser), PowerShell (Windows), Bash/Shell (Linux/Android).
 
 ## Usage
 
@@ -46,10 +47,10 @@ sos custom-script generate [options]
 ## Examples
 
 ```bash
-# Generate new custom script project
+# Generate new project
 sos custom-script generate
 
-# Upload custom script to platform
+# Upload to platform
 sos custom-script upload
 ```
 
@@ -93,4 +94,5 @@ sos --profile production organization list
 
 ## See Also
 
-- [Custom Scripts Documentation](https://developers.signageos.io/docs/custom-scripts/)
+- [Documentation](https://developers.signageos.io/docs/custom-scripts/)
+- [Config File](https://developers.signageos.io/docs/custom-scripts/#config-file)

package/docs/custom-script/upload/index.md

@@ -1,7 +1,7 @@
 ---
 id: custom-script-upload-index
 title: upload
-sidebar_position: 52
+sidebar_position: 1032
 ---
 # upload
 
@@ -10,10 +10,11 @@ Upload custom script to the signageOS platform
 
 ## Description
 
-Uploads custom script code and configuration to the signageOS platform based on
-the .sosconfig.json configuration file. Custom Scripts enable advanced device
-functionality beyond standard applets, including system-level operations and
-device-specific configurations for multiple platforms.
+Uploads custom script code and configuration to signageOS platform from `.sosconfig.json`.
+Creates/updates script, uploads platform-specific files, and provides script UID for execution.
+
+May prompt for confirmation when creating new scripts or versions.
+Use `--yes` to skip prompts for automated deployments.
 
 ## Usage
 
@@ -32,14 +33,14 @@ sos custom-script upload [options]
 ## Examples
 
 ```bash
-# Upload custom script from current directory
+# Upload interactively
 sos custom-script upload
 
-# Upload with specific organization
-sos custom-script upload --organization-uid abc123def456
-
-# Skip confirmation prompts (useful for CI/CD)
+# Skip confirmations (CI/CD)
 sos custom-script upload --yes
+
+# Specific organization
+sos custom-script upload --organization-uid abc123def456
 ```
 
 ## Since
@@ -77,6 +78,6 @@ sos --profile production organization list
 
 ## See Also
 
-- [Custom Scripts Documentation](https://developers.signageos.io/docs/custom-scripts/)
-- [Generate custom script project](../generate/)
-- [Custom Script management commands](../)
+- [Documentation](https://developers.signageos.io/docs/custom-scripts/)
+- [REST API](https://developers.signageos.io/api/#tag/DeviceCustom-Script)
+- [Generate command](../generate/)

package/docs/device/connect/index.md

@@ -1,7 +1,7 @@
 ---
 id: device-connect-index
 title: connect
-sidebar_position: 31
+sidebar_position: 2011
 ---
 # connect
 

package/docs/device/index.md

@@ -1,7 +1,7 @@
 ---
 id: device-index
 title: device
-sidebar_position: 30
+sidebar_position: 2000
 ---
 # device
 

package/docs/device/power-action/index.md

@@ -1,7 +1,7 @@
 ---
 id: device-power-action-index
 title: power-action
-sidebar_position: 32
+sidebar_position: 2012
 ---
 # power-action
 

package/docs/device/set-content/index.md

@@ -1,7 +1,7 @@
 ---
 id: device-set-content-index
 title: set-content
-sidebar_position: 33
+sidebar_position: 2013
 ---
 # set-content
 
@@ -22,19 +22,23 @@ sos device set-content [options]
 
 ## Options
 
-| Option                      | Description                                                      |
-| --------------------------- | ---------------------------------------------------------------- |
-| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
-| `--organization-uid`        | Organization UID (string)                                        |
-| `--applet-uid`              | Applet UID (string)                                              |
-| `--device-uid`              | Device UID (string)                                              |
+| Option                      | Description                                                                               |
+| --------------------------- | ----------------------------------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)                          |
+| `--organization-uid`        | Organization UID (string)                                                                 |
+| `--applet-uid`              | Applet UID (string)                                                                       |
+| `--device-uid`              | Device UID (string)                                                                       |
+| `--yes`                     | Skip selection prompts (requires explicit device-uid and applet-uid for safety) (boolean) |
 
 ## Examples
 
 ```bash
-# Deploy applet to device
+# Deploy applet to device (interactive, allows selection if multiple versions exist)
 sos device set-content --device-uid device123 --applet-uid my-applet
 
+# Skip selection prompts (requires explicit UIDs, fails if multiple versions)
+sos device set-content --device-uid device123 --applet-uid my-applet --yes
+
 # Deploy with organization override
 sos device set-content --device-uid device123 --applet-uid my-applet --organization-uid org456
 ```

package/docs/index.md

@@ -73,6 +73,14 @@ access to all available command groups.
 
 ## Commands
 
+### Authentication
+
+#### `sos login`
+
+Authenticate user with signageOS
+
+[→ See detailed documentation](/cli/login/)
+
 ### Development
 
 #### `sos applet`
@@ -91,13 +99,21 @@ Custom Script management
 
 [→ See detailed documentation](/cli/custom-script/)
 
-### Authentication
+#### `sos plugin`
 
-#### `sos login`
+Plugin management
 
-Authenticate user with signageOS
+**Available commands**: `sos plugin generate`, `sos plugin upload`
 
-[→ See detailed documentation](/cli/login/)
+[→ See detailed documentation](/cli/plugin/)
+
+#### `sos runner`
+
+Runner management
+
+**Available commands**: `sos runner generate`, `sos runner upload`
+
+[→ See detailed documentation](/cli/runner/)
 
 ### Management
 

package/docs/login/index.md

@@ -11,8 +11,8 @@ Authenticate user with signageOS
 ## Description
 
 Handles user authentication using username/email and password credentials.
-Supports both Auth0 and legacy authentication methods. Stores credentials
-securely in the ~/.sosrc configuration file for subsequent CLI operations.
+Supports Auth0 authentication method. Stores credentials securely in the
+~/.sosrc configuration file for subsequent CLI operations.
 
 ## Usage
 

package/docs/organization/get/index.md

@@ -1,7 +1,7 @@
 ---
 id: organization-get-index
 title: get
-sidebar_position: 62
+sidebar_position: 2032
 ---
 # get
 

package/docs/organization/index.md

@@ -1,7 +1,7 @@
 ---
 id: organization-index
 title: organization
-sidebar_position: 60
+sidebar_position: 2010
 ---
 # organization
 

package/docs/organization/list/index.md

@@ -1,7 +1,7 @@
 ---
 id: organization-list-index
 title: list
-sidebar_position: 61
+sidebar_position: 2031
 ---
 # list
 

package/docs/organization/set-default/index.md

@@ -1,7 +1,7 @@
 ---
 id: organization-set-default-index
 title: set-default
-sidebar_position: 63
+sidebar_position: 2033
 ---
 # set-default
 

package/docs/plugin/generate/index.md

@@ -1,19 +1,49 @@
 ---
 id: plugin-generate-index
 title: generate
-sidebar_position: 0
+sidebar_position: 1051
 ---
 # generate
 
 Generates a local repository for developing a Plugin
 
 
+## Description
+
+Generates a local repository for developing a Plugin with boilerplate code and configuration files.
+Sets up complete development environment with necessary dependencies and project structure.
+
+Runs interactively by default or non-interactively with `--yes` option.
+Requires Git to be installed and accessible.
+
 ## Usage
 
 ```bash
 sos plugin generate [options]
 ```
 
+## Options
+
+| Option          | Description                                                 |
+| --------------- | ----------------------------------------------------------- |
+| `--name`        | Plugin name (string)                                        |
+| `--description` | Plugin description (string)                                 |
+| `--yes`         | Skip confirmation prompts and use provided values (boolean) |
+
+## Examples
+
+```bash
+# Generate plugin project interactively
+sos plugin generate
+
+# Generate non-interactively (suitable for CI/CD)
+sos plugin generate --name my-plugin --description "My custom plugin" --yes
+```
+
+## Since
+
+2.6.0
+
 ## Global Options
 
 All commands support the following global options:

package/docs/plugin/index.md

@@ -1,13 +1,23 @@
 ---
 id: plugin-index
 title: plugin
-sidebar_position: 0
+sidebar_position: 1020
 ---
 # plugin
 
 Plugin management
 
 
+## Description
+
+Plugin management operations for developing and deploying signageOS plugins.
+
+Plugins extend native signageOS features and integrate with system policies.
+They run periodically to ensure configuration is consistently enforced on devices.
+
+Plugins must implement `set` and `get` methods.
+Upload reads `.sosconfig.json` for configuration.
+
 ## Usage
 
 ```bash
@@ -37,6 +47,29 @@ sos plugin upload [options]
 [→ See detailed documentation](/cli/plugin/upload/)
 
 
+## Examples
+
+```bash
+# Generate a new plugin project interactively
+sos plugin generate
+
+# Generate plugin with all parameters (non-interactive, suitable for CI/CD)
+sos plugin generate --name my-plugin --description "Custom functionality" --yes
+
+# Upload plugin to signageOS platform
+sos plugin upload
+
+# Upload plugin non-interactively (for CI/CD pipelines)
+sos plugin upload --yes
+
+# Upload with specific organization
+sos plugin upload --organization-uid abc123def456
+```
+
+## Since
+
+2.6.0
+
 ## Global Options
 
 All commands support the following global options:

package/docs/plugin/upload/index.md

@@ -1,13 +1,21 @@
 ---
 id: plugin-upload-index
 title: upload
-sidebar_position: 0
+sidebar_position: 1052
 ---
 # upload
 
 Uploads current plugin version
 
 
+## Description
+
+Uploads current plugin version to the signageOS platform based on configuration
+and schema files in the current directory. Handles plugin and version management automatically.
+
+May prompt for confirmation when creating new plugins or versions.
+Use `--yes` to skip confirmation prompts for automated deployments.
+
 ## Usage
 
 ```bash
@@ -16,10 +24,25 @@ sos plugin upload [options]
 
 ## Options
 
-| Option                      | Description                                                      |
-| --------------------------- | ---------------------------------------------------------------- |
-| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
-| `--organization-uid`        | Organization UID (string)                                        |
+| Option                      | Description                                                        |
+| --------------------------- | ------------------------------------------------------------------ |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)   |
+| `--organization-uid`        | Organization UID (string)                                          |
+| `--yes`                     | Skip confirmation prompts for plugin or version creation (boolean) |
+
+## Examples
+
+```bash
+# Upload plugin from current directory
+sos plugin upload
+
+# Upload with specific organization, skip prompts
+sos plugin upload --organization-uid abc123def456 --yes
+```
+
+## Since
+
+2.6.0
 
 ## Global Options
 

package/docs/runner/generate/index.md

@@ -1,19 +1,49 @@
 ---
 id: runner-generate-index
 title: generate
-sidebar_position: 0
+sidebar_position: 1071
 ---
 # generate
 
 Generates a local repository for developing a Runner
 
 
+## Description
+
+Generates a local repository for developing a Runner with boilerplate code and configuration files.
+Sets up complete development environment with necessary dependencies and project structure.
+
+Runs interactively by default or non-interactively with `--yes` option.
+Requires Git to be installed and accessible.
+
 ## Usage
 
 ```bash
 sos runner generate [options]
 ```
 
+## Options
+
+| Option          | Description                                                 |
+| --------------- | ----------------------------------------------------------- |
+| `--name`        | Runner name (string)                                        |
+| `--description` | Runner description (string)                                 |
+| `--yes`         | Skip confirmation prompts and use provided values (boolean) |
+
+## Examples
+
+```bash
+# Generate runner project interactively
+sos runner generate
+
+# Generate non-interactively (suitable for CI/CD)
+sos runner generate --name my-runner --description "My custom runner" --yes
+```
+
+## Since
+
+2.6.0
+
 ## Global Options
 
 All commands support the following global options:

package/docs/runner/index.md

@@ -1,13 +1,24 @@
 ---
 id: runner-index
 title: runner
-sidebar_position: 0
+sidebar_position: 1030
 ---
 # runner
 
 Runner management
 
 
+## Description
+
+Runner management operations for developing and deploying signageOS runners.
+
+Runners are designed for continuous execution as background processes on devices.
+Once activated, they run indefinitely with active health monitoring and automatic
+restart capabilities for stability.
+
+Runners must implement `run`, `set`, and `get` methods.
+Upload reads `.sosconfig.json` for configuration.
+
 ## Usage
 
 ```bash
@@ -37,6 +48,20 @@ sos runner upload [options]
 [→ See detailed documentation](/cli/runner/upload/)
 
 
+## Examples
+
+```bash
+# Generate new runner project
+sos runner generate --name my-runner --description "Background service" --yes
+
+# Upload runner to platform
+sos runner upload --yes
+```
+
+## Since
+
+2.6.0
+
 ## Global Options
 
 All commands support the following global options: