@signageos/cli 2.4.1 → 2.6.0-rc.0

package/dist/Device/Connect/connectCommand.js

@@ -45,9 +45,58 @@ const OPTION_LIST = [
     appletServerHelper_1.HOT_RELOAD_OPTION,
     appletUploadCommandHelper_1.APPLET_PATH_OPTION,
 ];
+/**
+ * Establishes a connection between a signageOS device and the local development environment,
+ * allowing real-time testing and debugging of applets during development. Supports both
+ * local network (LAN) and forward server connections for different network configurations.
+ *
+ * The command sets up a development server and configures the device to load the applet
+ * from the local machine, enabling hot reload and live debugging capabilities.
+ *
+ * @group Management:1
+ *
+ * @example
+ * ```bash
+ * # Connect device with basic configuration
+ * sos device connect --device-uid device123 --applet-uid my-applet
+ *
+ * # Connect with custom server port
+ * sos device connect --device-uid device123 --server-port 8080
+ *
+ * # Connect using forward server (for remote devices)
+ * sos device connect --device-uid device123 --use-forward-server
+ *
+ * # Connect with hot reload enabled
+ * sos device connect --device-uid device123 --hot-reload
+ *
+ * # Connect with custom organization
+ * sos device connect --device-uid device123 --organization-uid org456
+ *
+ * # Connect with custom public URL
+ * sos device connect --device-uid device123 --server-public-url https://my-domain.com
+ *
+ * # Connect and run in background
+ * sos device connect --device-uid device123 --detach
+ *
+ * # Force connection (terminate existing servers)
+ * sos device connect --device-uid device123 --force
+ * ```
+ *
+ * @throws {Error} When device or applet cannot be found or accessed
+ *
+ * @throws {Error} When network connection to device fails
+ *
+ * @throws {Error} When development server cannot be started
+ *
+ * @throws {Error} When hot reload configuration is invalid
+ *
+ * @see {@link https://developers.signageos.io/docs/applets/connect-to-device-cli/ Device Connection and Development Documentation}
+ *
+ * @since 0.9.0
+ */
 exports.connect = (0, commandDefinition_1.createCommandDefinition)({
     name: 'connect',
-    description: 'Set ip for device',
+    description: 'Connect device to local development server',
     optionList: OPTION_LIST,
     commands: [],
     run: function (options) {

package/dist/Device/Content/setContentCommand.d.ts

@@ -2,7 +2,7 @@ import { CommandLineOptions } from '../../Command/commandDefinition';
 declare const OPTION_LIST: readonly [{
     readonly name: "no-default-organization";
     readonly type: BooleanConstructor;
-    readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+    readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
 }, {
     readonly name: "organization-uid";
     readonly type: StringConstructor;
@@ -16,13 +16,39 @@ declare const OPTION_LIST: readonly [{
     readonly type: StringConstructor;
     readonly description: "Device UID";
 }];
+/**
+ * Deploys an applet to a specific device by creating a timing configuration
+ * that activates the specified applet version on the target device. This command
+ * establishes the applet-to-device relationship for production deployment.
+ *
+ * @group Management:3
+ *
+ * @example
+ * ```bash
+ * # Deploy applet to device
+ * sos device set-content --device-uid device123 --applet-uid my-applet
+ *
+ * # Deploy with organization override
+ * sos device set-content --device-uid device123 --applet-uid my-applet --organization-uid org456
+ * ```
+ *
+ * @throws {Error} When device or applet cannot be found or accessed
+ *
+ * @throws {Error} When timing configuration creation fails
+ *
+ * @throws {Error} When organization access is denied
+ *
+ * @throws {Error} When applet version cannot be determined
+ *
+ * @since 0.9.0
+ */
 export declare const setContent: {
     name: "set-content";
     description: string;
     optionList: readonly [{
         readonly name: "no-default-organization";
         readonly type: BooleanConstructor;
-        readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+        readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
     }, {
         readonly name: "organization-uid";
         readonly type: StringConstructor;

package/dist/Device/Content/setContentCommand.js

@@ -21,9 +21,35 @@ const helper_1 = require("../../helper");
 const organizationFacade_1 = require("../../Organization/organizationFacade");
 const deviceFacade_1 = require("../deviceFacade");
 const OPTION_LIST = [organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION, organizationFacade_1.ORGANIZATION_UID_OPTION, appletFacade_1.APPLET_UID_OPTION, deviceFacade_1.DEVICE_UID_OPTION];
+/**
+ * Deploys an applet to a specific device by creating a timing configuration
+ * that activates the specified applet version on the target device. This command
+ * establishes the applet-to-device relationship for production deployment.
+ *
+ * @group Management:3
+ *
+ * @example
+ * ```bash
+ * # Deploy applet to device
+ * sos device set-content --device-uid device123 --applet-uid my-applet
+ *
+ * # Deploy with organization override
+ * sos device set-content --device-uid device123 --applet-uid my-applet --organization-uid org456
+ * ```
+ *
+ * @throws {Error} When device or applet cannot be found or accessed
+ *
+ * @throws {Error} When timing configuration creation fails
+ *
+ * @throws {Error} When organization access is denied
+ *
+ * @throws {Error} When applet version cannot be determined
+ *
+ * @since 0.9.0
+ */
 exports.setContent = (0, commandDefinition_1.createCommandDefinition)({
     name: 'set-content',
-    description: 'Set content for device',
+    description: 'Deploy applet to device',
     optionList: OPTION_LIST,
     commands: [],
     run(options) {

package/dist/Device/PowerAction/powerActionCommand.d.ts

@@ -2,7 +2,7 @@ import { CommandLineOptions } from '../../Command/commandDefinition';
 declare const OPTION_LIST: readonly [{
     readonly name: "no-default-organization";
     readonly type: BooleanConstructor;
-    readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+    readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
 }, {
     readonly name: "organization-uid";
     readonly type: StringConstructor;
@@ -16,13 +16,65 @@ declare const OPTION_LIST: readonly [{
     readonly type: StringConstructor;
     readonly description: "Type of device power action";
 }];
+/**
+ * Executes various power and control actions on remote signageOS devices, including
+ * applet reloads, display power management, system reboots, and applet state changes.
+ * This command provides remote device management capabilities for troubleshooting
+ * and maintenance operations.
+ *
+ * @group Management:2
+ *
+ * @example
+ * ```bash
+ * # Reload applet on device
+ * sos device power-action reload --device-uid device123
+ *
+ * # Turn display on
+ * sos device power-action displayOn --device-uid device123
+ *
+ * # Turn display off
+ * sos device power-action displayOff --device-uid device123
+ *
+ * # Restart application
+ * sos device power-action restart --device-uid device123
+ *
+ * # Disable applet
+ * sos device power-action disable --device-uid device123
+ *
+ * # Enable applet
+ * sos device power-action enable --device-uid device123
+ *
+ * # Reboot device
+ * sos device power-action reboot --device-uid device123
+ *
+ * # Refresh content
+ * sos device power-action refresh --device-uid device123
+ * ```
+ *
+ * # Reboot system
+ * sos device power-action reboot --device-uid device123
+ *
+ * # Refresh applet
+ * sos device power-action refresh --device-uid device123
+ * ```
+ *
+ * @throws {Error} When device cannot be found or accessed
+ *
+ * @throws {Error} When power action is not supported by device
+ *
+ * @throws {Error} When organization access is denied
+ *
+ * @throws {Error} When power action execution fails
+ *
+ * @since 0.9.0
+ */
 export declare const powerAction: {
     name: "power-action";
     description: string;
     optionList: readonly [{
         readonly name: "no-default-organization";
         readonly type: BooleanConstructor;
-        readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+        readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
     }, {
         readonly name: "organization-uid";
         readonly type: StringConstructor;

package/dist/Device/PowerAction/powerActionCommand.js

@@ -20,6 +20,58 @@ const chalk_1 = __importDefault(require("chalk"));
 const commandDefinition_1 = require("../../Command/commandDefinition");
 const log_1 = require("@signageos/sdk/dist/Console/log");
 const OPTION_LIST = [organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION, organizationFacade_1.ORGANIZATION_UID_OPTION, deviceFacade_1.DEVICE_UID_OPTION, deviceFacade_1.POWER_ACTION_TYPE_OPTION];
+/**
+ * Executes various power and control actions on remote signageOS devices, including
+ * applet reloads, display power management, system reboots, and applet state changes.
+ * This command provides remote device management capabilities for troubleshooting
+ * and maintenance operations.
+ *
+ * @group Management:2
+ *
+ * @example
+ * ```bash
+ * # Reload applet on device
+ * sos device power-action reload --device-uid device123
+ *
+ * # Turn display on
+ * sos device power-action displayOn --device-uid device123
+ *
+ * # Turn display off
+ * sos device power-action displayOff --device-uid device123
+ *
+ * # Restart application
+ * sos device power-action restart --device-uid device123
+ *
+ * # Disable applet
+ * sos device power-action disable --device-uid device123
+ *
+ * # Enable applet
+ * sos device power-action enable --device-uid device123
+ *
+ * # Reboot device
+ * sos device power-action reboot --device-uid device123
+ *
+ * # Refresh content
+ * sos device power-action refresh --device-uid device123
+ * ```
+ *
+ * # Reboot system
+ * sos device power-action reboot --device-uid device123
+ *
+ * # Refresh applet
+ * sos device power-action refresh --device-uid device123
+ * ```
+ *
+ * @throws {Error} When device cannot be found or accessed
+ *
+ * @throws {Error} When power action is not supported by device
+ *
+ * @throws {Error} When organization access is denied
+ *
+ * @throws {Error} When power action execution fails
+ *
+ * @since 0.9.0
+ */
 exports.powerAction = (0, commandDefinition_1.createCommandDefinition)({
     name: 'power-action',
     description: 'Perform power action on device',

package/dist/Device/deviceCommand.d.ts

@@ -1,3 +1,23 @@
+/**
+ * Provides commands for managing signageOS devices, including connecting to devices
+ * for development, controlling device power states, and managing applet deployment.
+ *
+ * @group Management:3
+ *
+ * @example
+ * ```bash
+ * # Connect to device for development
+ * sos device connect --device-uid device123
+ *
+ * # Control device power actions
+ * sos device power-action reload --device-uid device123
+ *
+ * # Deploy applet to device
+ * sos device set-content --device-uid device123
+ * ```
+ *
+ * @since 0.9.0
+ */
 export declare const device: {
     name: "device";
     description: string;
@@ -8,7 +28,7 @@ export declare const device: {
         optionList: readonly [{
             readonly name: "no-default-organization";
             readonly type: BooleanConstructor;
-            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
         }, {
             readonly name: "organization-uid";
             readonly type: StringConstructor;
@@ -26,7 +46,7 @@ export declare const device: {
         run(options: import("../Command/commandDefinition").CommandLineOptions<readonly [{
             readonly name: "no-default-organization";
             readonly type: BooleanConstructor;
-            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
         }, {
             readonly name: "organization-uid";
             readonly type: StringConstructor;
@@ -46,7 +66,7 @@ export declare const device: {
         optionList: readonly [{
             readonly name: "no-default-organization";
             readonly type: BooleanConstructor;
-            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
         }, {
             readonly name: "organization-uid";
             readonly type: StringConstructor;
@@ -64,7 +84,7 @@ export declare const device: {
         run(options: import("../Command/commandDefinition").CommandLineOptions<readonly [{
             readonly name: "no-default-organization";
             readonly type: BooleanConstructor;
-            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
         }, {
             readonly name: "organization-uid";
             readonly type: StringConstructor;
@@ -84,7 +104,7 @@ export declare const device: {
         optionList: readonly [{
             readonly name: "no-default-organization";
             readonly type: BooleanConstructor;
-            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
         }, {
             readonly name: "organization-uid";
             readonly type: StringConstructor;
@@ -137,7 +157,7 @@ export declare const device: {
         run: (options: import("../Command/commandDefinition").CommandLineOptions<readonly [{
             readonly name: "no-default-organization";
             readonly type: BooleanConstructor;
-            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc which were set using command sos organization set-default";
+            readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc";
         }, {
             readonly name: "organization-uid";
             readonly type: StringConstructor;

package/dist/Device/deviceCommand.js

@@ -14,9 +14,29 @@ const setContentCommand_1 = require("./Content/setContentCommand");
 const powerActionCommand_1 = require("./PowerAction/powerActionCommand");
 const connectCommand_1 = require("./Connect/connectCommand");
 const commandDefinition_1 = require("../Command/commandDefinition");
+/**
+ * Provides commands for managing signageOS devices, including connecting to devices
+ * for development, controlling device power states, and managing applet deployment.
+ *
+ * @group Management:3
+ *
+ * @example
+ * ```bash
+ * # Connect to device for development
+ * sos device connect --device-uid device123
+ *
+ * # Control device power actions
+ * sos device power-action reload --device-uid device123
+ *
+ * # Deploy applet to device
+ * sos device set-content --device-uid device123
+ * ```
+ *
+ * @since 0.9.0
+ */
 exports.device = (0, commandDefinition_1.createCommandDefinition)({
     name: 'device',
-    description: 'device management',
+    description: 'Device management',
     optionList: [],
     commands: [setContentCommand_1.setContent, powerActionCommand_1.powerAction, connectCommand_1.connect],
     run() {

package/dist/Device/deviceFacade.d.ts

@@ -19,4 +19,4 @@ export declare const POWER_ACTION_TYPE_OPTION: {
 };
 export declare function getDeviceUid(restApi: RestApi, options: CommandLineOptions<[typeof DEVICE_UID_OPTION]>): Promise<string>;
 export declare function getActionType(options: CommandLineOptions<[typeof POWER_ACTION_TYPE_OPTION]>): Promise<string>;
-export declare function disconnectDevice(organization: IOrganization, deviceUid: String): Promise<any>;
+export declare function disconnectDevice(organization: IOrganization, deviceUid: string): Promise<any>;

package/dist/Firmware/Upload/firmwareUploadCommand.d.ts

@@ -3,22 +3,60 @@ declare const OPTION_LIST: readonly [{
     readonly name: "application-type";
     readonly alias: "a";
     readonly type: StringConstructor;
+    readonly description: "Application type for the firmware (e.g., linux, android, webos)";
 }, {
     readonly name: "firmware-version";
     readonly alias: "f";
     readonly type: StringConstructor;
+    readonly description: "Version identifier for the firmware package";
 }, {
     readonly name: "firmware-type";
     readonly type: StringConstructor;
+    readonly description: "Device model prefixed with brand (e.g., \"benq_sl550\", \"rpi4\", \"rpi\")";
 }, {
     readonly name: "src";
     readonly type: StringConstructor;
     readonly multiple: true;
+    readonly description: "Path(s) to firmware file(s) to upload";
 }, {
     readonly name: "force";
     readonly type: BooleanConstructor;
     readonly description: "When firmware cannot be uploaded due to invalid firmware \"type\", do it anyways.";
 }];
+/**
+ * Uploads firmware files for specific device types and application platforms.
+ * Supports various device architectures including Linux, Android, WebOS, and others.
+ * The command validates firmware files and creates versioned firmware packages
+ * that can be deployed to compatible devices.
+ *
+ * @group Private
+ *
+ * @example
+ * ```bash
+ * # Upload firmware interactively
+ * sos firmware upload
+ *
+ * # Upload firmware with command line options
+ * sos firmware upload --application-type linux --firmware-version 1.2.3 --src /path/to/firmware.tar.gz
+ *
+ * # Upload Android firmware with type specification
+ * sos firmware upload --application-type android --firmware-type rpi4 --firmware-version 1.0.0 --src /path/to/firmware.apk
+ *
+ * # Force upload when type validation fails
+ * sos firmware upload --application-type linux --firmware-type custom_device --firmware-version 1.0.0 --src /path/to/firmware.tar.gz --force
+ * ```
+ *
+ * @throws {Error} When required parameters are missing
+ * @throws {Error} When firmware files cannot be found or validated
+ * @throws {RequestError} When firmware type is invalid for the platform
+ * @throws {Error} When upload confirmation is denied
+ *
+ * @see {@link ../ Firmware upload command}
+ *
+ * @see {@link ../../ Firmware management commands}
+ *
+ * @since 0.6.0
+ */
 export declare const firmwareUpload: {
     name: "upload";
     description: string;
@@ -26,17 +64,21 @@ export declare const firmwareUpload: {
         readonly name: "application-type";
         readonly alias: "a";
         readonly type: StringConstructor;
+        readonly description: "Application type for the firmware (e.g., linux, android, webos)";
     }, {
         readonly name: "firmware-version";
         readonly alias: "f";
         readonly type: StringConstructor;
+        readonly description: "Version identifier for the firmware package";
     }, {
         readonly name: "firmware-type";
         readonly type: StringConstructor;
+        readonly description: "Device model prefixed with brand (e.g., \"benq_sl550\", \"rpi4\", \"rpi\")";
     }, {
         readonly name: "src";
         readonly type: StringConstructor;
         readonly multiple: true;
+        readonly description: "Path(s) to firmware file(s) to upload";
     }, {
         readonly name: "force";
         readonly type: BooleanConstructor;

package/dist/Firmware/Upload/firmwareUploadCommand.js

@@ -43,22 +43,56 @@ const fwTypeQuestion = [
 ];
 const applicationTypesRequiringType = ['linux', 'android'];
 const OPTION_LIST = [
-    { name: 'application-type', alias: 'a', type: String },
-    { name: 'firmware-version', alias: 'f', type: String },
-    { name: 'firmware-type', type: String },
-    { name: 'src', type: String, multiple: true },
+    { name: 'application-type', alias: 'a', type: String, description: 'Application type for the firmware (e.g., linux, android, webos)' },
+    { name: 'firmware-version', alias: 'f', type: String, description: 'Version identifier for the firmware package' },
+    { name: 'firmware-type', type: String, description: 'Device model prefixed with brand (e.g., "benq_sl550", "rpi4", "rpi")' },
+    { name: 'src', type: String, multiple: true, description: 'Path(s) to firmware file(s) to upload' },
     { name: 'force', type: Boolean, description: 'When firmware cannot be uploaded due to invalid firmware "type", do it anyways.' },
 ];
+/**
+ * Uploads firmware files for specific device types and application platforms.
+ * Supports various device architectures including Linux, Android, WebOS, and others.
+ * The command validates firmware files and creates versioned firmware packages
+ * that can be deployed to compatible devices.
+ *
+ * @group Private
+ *
+ * @example
+ * ```bash
+ * # Upload firmware interactively
+ * sos firmware upload
+ *
+ * # Upload firmware with command line options
+ * sos firmware upload --application-type linux --firmware-version 1.2.3 --src /path/to/firmware.tar.gz
+ *
+ * # Upload Android firmware with type specification
+ * sos firmware upload --application-type android --firmware-type rpi4 --firmware-version 1.0.0 --src /path/to/firmware.apk
+ *
+ * # Force upload when type validation fails
+ * sos firmware upload --application-type linux --firmware-type custom_device --firmware-version 1.0.0 --src /path/to/firmware.tar.gz --force
+ * ```
+ *
+ * @throws {Error} When required parameters are missing
+ * @throws {Error} When firmware files cannot be found or validated
+ * @throws {RequestError} When firmware type is invalid for the platform
+ * @throws {Error} When upload confirmation is denied
+ *
+ * @see {@link ../ Firmware upload command}
+ *
+ * @see {@link ../../ Firmware management commands}
+ *
+ * @since 0.6.0
+ */
 exports.firmwareUpload = (0, commandDefinition_1.createCommandDefinition)({
     name: 'upload',
-    description: 'Uploads selected firmware version',
+    description: 'Upload firmware version to the signageOS platform',
     optionList: OPTION_LIST,
     commands: [],
     run(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const optionsProvided = !!(options['application-type'] && options['firmware-version'] && options.src && options.src.length > 0);
             const restApi = yield (0, helper_1.createFirmwareVersionRestApi)();
-            let data = {
+            const data = {
                 applicationType: '',
                 version: '',
                 files: [],

package/dist/Firmware/Upload/firmwareUploadFacade.js

@@ -57,7 +57,7 @@ function uploadFirmwareVersion(parameters) {
         if (progressBar) {
             progressBar.init({ size: totalSize, name: pathArr.join(',') });
         }
-        for (let index in pathArr) {
+        for (const index in pathArr) {
             const filePath = pathArr[index];
             if (!filePath) {
                 continue;

package/dist/Firmware/firmwareCommand.d.ts

@@ -1,3 +1,20 @@
+/**
+ * Provides commands for managing device firmware on the signageOS platform.
+ * Firmware management includes uploading new firmware versions for different
+ * device types and application platforms.
+ *
+ * @group Private
+ *
+ * @example
+ * ```bash
+ * # Upload firmware version
+ * sos firmware upload
+ * ```
+ *
+ * @see {@link ./upload/ Upload firmware version command}
+ *
+ * @since 0.6.0
+ */
 export declare const firmware: {
     name: "firmware";
     description: string;
@@ -9,17 +26,21 @@ export declare const firmware: {
             readonly name: "application-type";
             readonly alias: "a";
             readonly type: StringConstructor;
+            readonly description: "Application type for the firmware (e.g., linux, android, webos)";
         }, {
             readonly name: "firmware-version";
             readonly alias: "f";
             readonly type: StringConstructor;
+            readonly description: "Version identifier for the firmware package";
         }, {
             readonly name: "firmware-type";
             readonly type: StringConstructor;
+            readonly description: "Device model prefixed with brand (e.g., \"benq_sl550\", \"rpi4\", \"rpi\")";
         }, {
             readonly name: "src";
             readonly type: StringConstructor;
             readonly multiple: true;
+            readonly description: "Path(s) to firmware file(s) to upload";
         }, {
             readonly name: "force";
             readonly type: BooleanConstructor;
@@ -30,17 +51,21 @@ export declare const firmware: {
             readonly name: "application-type";
             readonly alias: "a";
             readonly type: StringConstructor;
+            readonly description: "Application type for the firmware (e.g., linux, android, webos)";
         }, {
             readonly name: "firmware-version";
             readonly alias: "f";
             readonly type: StringConstructor;
+            readonly description: "Version identifier for the firmware package";
         }, {
             readonly name: "firmware-type";
             readonly type: StringConstructor;
+            readonly description: "Device model prefixed with brand (e.g., \"benq_sl550\", \"rpi4\", \"rpi\")";
         }, {
             readonly name: "src";
             readonly type: StringConstructor;
             readonly multiple: true;
+            readonly description: "Path(s) to firmware file(s) to upload";
         }, {
             readonly name: "force";
             readonly type: BooleanConstructor;

package/dist/Firmware/firmwareCommand.js

@@ -12,9 +12,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.firmware = void 0;
 const commandDefinition_1 = require("../Command/commandDefinition");
 const firmwareUploadCommand_1 = require("./Upload/firmwareUploadCommand");
+/**
+ * Provides commands for managing device firmware on the signageOS platform.
+ * Firmware management includes uploading new firmware versions for different
+ * device types and application platforms.
+ *
+ * @group Private
+ *
+ * @example
+ * ```bash
+ * # Upload firmware version
+ * sos firmware upload
+ * ```
+ *
+ * @see {@link ./upload/ Upload firmware version command}
+ *
+ * @since 0.6.0
+ */
 exports.firmware = (0, commandDefinition_1.createCommandDefinition)({
     name: 'firmware',
-    description: 'firmware management',
+    description: 'Firmware management',
     optionList: [],
     commands: [firmwareUploadCommand_1.firmwareUpload],
     run() {

package/dist/Lib/childProcess.js

@@ -49,8 +49,8 @@ const executeChildProcess = (command, verbose) => {
             }
             else {
                 if (verbose) {
-                    console.log(stdout);
-                    console.log(stderr);
+                    console.info(stdout);
+                    console.error(stderr);
                 }
                 resolve(stdout);
             }