@signageos/cli 2.6.0 → 2.7.0

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:

package/docs/runner/upload/index.md

@@ -1,13 +1,21 @@
 ---
 id: runner-upload-index
 title: upload
-sidebar_position: 0
+sidebar_position: 1072
 ---
 # upload
 
 Uploads current runner version
 
 
+## Description
+
+Uploads current runner version to the signageOS platform based on configuration
+and schema files in the current directory. Handles runner and version management automatically.
+
+May prompt for confirmation when creating new runners or versions.
+Use `--yes` to skip confirmation prompts for automated deployments.
+
 ## Usage
 
 ```bash
@@ -16,10 +24,25 @@ sos runner 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 runner or version creation (boolean) |
+
+## Examples
+
+```bash
+# Upload runner from current directory
+sos runner upload
+
+# Upload with specific organization, skip prompts
+sos runner upload --organization-uid abc123def456 --yes
+```
+
+## Since
+
+2.6.0
 
 ## Global Options
 

package/docs/timing/index.md

@@ -1,7 +1,7 @@
 ---
 id: timing-index
 title: timing
-sidebar_position: 40
+sidebar_position: 2020
 ---
 # timing
 

package/docs/timing/list/index.md

@@ -1,7 +1,7 @@
 ---
 id: timing-list-index
 title: list
-sidebar_position: 41
+sidebar_position: 2051
 ---
 # list
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/cli",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "main": "./dist/index.js",
   "author": "signageOS.io <dev@signageos.io>",
   "files": [
@@ -16,7 +16,7 @@
   },
   "scripts": {
     "clean": "rm -rf dist/*",
-    "build": "npx check-engine@latest && tsc && npm run build:templates && npm run docs",
+    "build": "tsc && npm run build:templates && npm run docs",
     "build:templates": "node tools/include-templates.mjs",
     "clean-build": "npm run clean && npm run build",
     "watch": "tsc --watch",