@signageos/cli 2.4.1 → 2.5.0

package/README.md

@@ -275,7 +275,7 @@ sos device power-action
 | reboot       | System reboot                                   |
 | refresh      | Applet Refresh                                  |
 
-#### Device Set-Content
+#### Device Deploy Applet
 ```bash
 sos device set-content
 ```
@@ -307,6 +307,32 @@ sos device connect
 | --forward-server-url *(optional)* | Custom forward server URL. | https://forward.signageos.io |
 | --hot-reload *(optional)* | Enable hot reload and build of applet | false |
 
+### Custom Script
+```bash
+sos custom-script --help
+```
+
+#### Custom Script Generate
+```bash
+sos custom-script generate
+```
+Generate a new custom script project with boilerplate code.
+
+| Argument                    | Description                     | Default value  |
+|-----------------------------|---------------------------------|----------------|
+| --name *(required)*         | Name for the custom script      | STDIN          |
+| --target-dir *(optional)*   | Generate script to directory    | ${PWD}/${name} |
+
+#### Custom Script Upload
+```bash
+sos custom-script upload
+```
+Upload custom script to the signageOS platform.
+
+| Argument                        | Description                  | Default value  |
+|---------------------------------|------------------------------|----------------|
+| --organization-uid *(required)* | Organization UID             | STDIN          |
+| --script-path *(optional)*      | Path to script file          | ${PWD}         |
 
 ## Debugging
 

package/dist/Applet/Build/appletBuildCommand.d.ts

@@ -2,7 +2,7 @@ import { CommandLineOptions } from '../../Command/commandDefinition';
 export 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;
@@ -12,13 +12,39 @@ export declare const OPTION_LIST: readonly [{
     readonly type: StringConstructor;
     readonly description: "Applet UID";
 }];
+/**
+ * Builds the applet into a distributable package using the signageOS SDK build system.
+ * The build process compiles and bundles the applet code, assets, and dependencies
+ * into a zip archive ready for upload to the signageOS platform.
+ *
+ * @group Development:2
+ *
+ * @example
+ * ```bash
+ * # Build applet in current directory
+ * sos applet build
+ *
+ * # Build with specific organization
+ * sos applet build --organization-uid abc123def456
+ *
+ * # Build with specific applet UID
+ * sos applet build --applet-uid my-applet-uid
+ * ```
+ *
+ * @throws {Error} When applet path is invalid or build process fails
+ *
+ * @throws {Error} When organization or applet cannot be found
+ * @throws {Error} When package.json is missing or invalid
+ *
+ * @since 1.2.0
+ */
 export declare const appletBuild: {
     name: "build";
     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/Applet/Build/appletBuildCommand.js

@@ -23,9 +23,35 @@ const log_1 = require("@signageos/sdk/dist/Console/log");
 const debug_1 = __importDefault(require("debug"));
 const Debug = (0, debug_1.default)('@signageos/cli:Applet:Build:appletBuildCommand');
 exports.OPTION_LIST = [organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION, organizationFacade_1.ORGANIZATION_UID_OPTION, appletFacade_1.APPLET_UID_OPTION];
+/**
+ * Builds the applet into a distributable package using the signageOS SDK build system.
+ * The build process compiles and bundles the applet code, assets, and dependencies
+ * into a zip archive ready for upload to the signageOS platform.
+ *
+ * @group Development:2
+ *
+ * @example
+ * ```bash
+ * # Build applet in current directory
+ * sos applet build
+ *
+ * # Build with specific organization
+ * sos applet build --organization-uid abc123def456
+ *
+ * # Build with specific applet UID
+ * sos applet build --applet-uid my-applet-uid
+ * ```
+ *
+ * @throws {Error} When applet path is invalid or build process fails
+ *
+ * @throws {Error} When organization or applet cannot be found
+ * @throws {Error} When package.json is missing or invalid
+ *
+ * @since 1.2.0
+ */
 exports.appletBuild = (0, commandDefinition_1.createCommandDefinition)({
     name: 'build',
-    description: 'Build applet locally. The result is a zip file in the /tmp/signageos directory.',
+    description: 'Build applet locally for production deployment.',
     optionList: exports.OPTION_LIST,
     commands: [],
     run(options) {

package/dist/Applet/Generate/Templates/index.js.template

@@ -1,7 +1,7 @@
 import './index.css';
 import sos from '@signageos/front-applet';
 
-// Wait on sos data are ready (https://docs.signageos.io/api/js/content/latest/js-applet-basics#onready)
+// Wait on sos data are ready (https://developers.signageos.io/sdk/sos/#onready)
 sos.onReady().then(async function () {
 	const contentElement = document.getElementById('root');
 	if (contentElement) {

package/dist/Applet/Generate/Templates/tsconfig.js.template

@@ -27,7 +27,7 @@
 		"emitDecoratorMetadata": true,
 		"jsx": "react",
 
-		/* Typecheck javascript */
+		/* Javascript type checking */
 		"allowJs": true,
 		"checkJs": true
 	},

package/dist/Applet/Generate/appletGenerateCommand.d.ts

@@ -11,30 +11,36 @@ declare const OPTION_LIST: ({
     defaultValue: string;
 })[];
 /**
- * Command definition for generating a new applet.
- * This command facilitates the creation of a basic applet sample with configurable options such as
- * language, bundler, git initialization, and npm registry. It generates the necessary files and
- * installs dependencies based on the selected options.
- * @param {Object} options - The options for generating the applet
- * @param {string} options.name - The name of the applet
- * @param {string} options.appletVersion - The version of the applet
- * @param {string} options.targetDir - The target directory for the applet
- * @param {string} options.npmRegistry - The npm registry URL
- * @param {string} options.language - The language of the applet (typescript or javascript)
- * @param {string} options.bundler - The bundler to use (webpack or rspack)
- * @param {string} options.git - Whether to initialize a git repository (yes or no)
- * @param {string} options.packager - Whether to manage packages with npm, pnpm, bun or yarn
- * @returns {Promise<void>} - A promise that resolves when the applet is generated
+ * Creates a new applet project with all necessary configuration files, dependencies,
+ * and boilerplate code. Supports both TypeScript and JavaScript, multiple bundlers
+ * (webpack/rspack), various package managers (npm/pnpm/yarn/bun), and includes
+ * git repository initialization.
+ *
+ * @group Development:1
+ *
  * @example
- * appletGenerate.run({
- *   name: 'my-applet',
- *   appletVersion: '1.0.0',
- *   targetDir: './output',
- *   npmRegistry: 'https://registry.npmjs.org/',
- *   language: 'typescript',
- *   bundler: 'webpack',
- *   git: 'yes',
- * });
+ * ```bash
+ * # Interactive generation with prompts
+ * sos applet generate
+ *
+ * # Generate TypeScript applet with webpack
+ * sos applet generate --name my-applet --language typescript --bundler webpack
+ *
+ * # Generate with custom settings
+ * sos applet generate --name my-app --target-dir ./projects --git yes --packager pnpm
+ *
+ * # Generate with npm registry
+ * sos applet generate --name my-applet --npm-registry https://registry.npmjs.org/ --packager npm
+ *
+ * # Generate applet with specific configuration
+ * sos applet generate --name my-applet --applet-version 1.0.0 --target-dir ./output --language typescript --bundler webpack --git yes
+ * ```
+ *
+ * @throws {Error} When required parameters are missing or invalid
+ *
+ * @throws {Error} When target directory conflicts exist
+ *
+ * @since 0.1.0
  */
 export declare const appletGenerate: {
     name: "generate";

package/dist/Applet/Generate/appletGenerateCommand.js

@@ -80,7 +80,7 @@ var Packager;
 const NAME_REGEXP = /^\w(\w|\d|-)*\w$/;
 let PACKAGER_EXECUTABLE = 'npm';
 const OPTION_LIST = [
-    { name: 'name', type: String, description: `Applet name. Match RegExp: ${NAME_REGEXP.toString()}` },
+    { name: 'name', type: String, description: `Applet name. Match RegExp: /^\\w(\\w|\\d|-)*\\w$/` },
     { name: 'applet-version', type: String, description: 'Applet initial version. Use semantic version', defaultValue: '0.0.0' },
     { name: 'target-dir', type: String, description: 'Directory where will be the applet generated to' },
     { name: 'git', type: String, description: 'Init applet as git repository "no" (default) or "yes"' },
@@ -122,7 +122,7 @@ const RUNSCRIPTS = {
     webpack: {
         start: 'webpack serve --mode development',
         build: 'webpack --mode production',
-        connect: 'echo "Deprecated command \"npm run connect\". Use \"npm run watch\" instead." && npm run watch',
+        connect: 'echo "Deprecated command \\"npm run connect\\". Use \\"npm run watch\\" instead." && npm run watch',
         watch: 'webpack --watch',
     },
     rspack: {
@@ -140,34 +140,40 @@ const importFileAsString = (relativePath) => {
     return fs.readFileSync(path.resolve(__dirname, relativePath), 'utf-8');
 };
 /**
- * Command definition for generating a new applet.
- * This command facilitates the creation of a basic applet sample with configurable options such as
- * language, bundler, git initialization, and npm registry. It generates the necessary files and
- * installs dependencies based on the selected options.
- * @param {Object} options - The options for generating the applet
- * @param {string} options.name - The name of the applet
- * @param {string} options.appletVersion - The version of the applet
- * @param {string} options.targetDir - The target directory for the applet
- * @param {string} options.npmRegistry - The npm registry URL
- * @param {string} options.language - The language of the applet (typescript or javascript)
- * @param {string} options.bundler - The bundler to use (webpack or rspack)
- * @param {string} options.git - Whether to initialize a git repository (yes or no)
- * @param {string} options.packager - Whether to manage packages with npm, pnpm, bun or yarn
- * @returns {Promise<void>} - A promise that resolves when the applet is generated
+ * Creates a new applet project with all necessary configuration files, dependencies,
+ * and boilerplate code. Supports both TypeScript and JavaScript, multiple bundlers
+ * (webpack/rspack), various package managers (npm/pnpm/yarn/bun), and includes
+ * git repository initialization.
+ *
+ * @group Development:1
+ *
  * @example
- * appletGenerate.run({
- *   name: 'my-applet',
- *   appletVersion: '1.0.0',
- *   targetDir: './output',
- *   npmRegistry: 'https://registry.npmjs.org/',
- *   language: 'typescript',
- *   bundler: 'webpack',
- *   git: 'yes',
- * });
+ * ```bash
+ * # Interactive generation with prompts
+ * sos applet generate
+ *
+ * # Generate TypeScript applet with webpack
+ * sos applet generate --name my-applet --language typescript --bundler webpack
+ *
+ * # Generate with custom settings
+ * sos applet generate --name my-app --target-dir ./projects --git yes --packager pnpm
+ *
+ * # Generate with npm registry
+ * sos applet generate --name my-applet --npm-registry https://registry.npmjs.org/ --packager npm
+ *
+ * # Generate applet with specific configuration
+ * sos applet generate --name my-applet --applet-version 1.0.0 --target-dir ./output --language typescript --bundler webpack --git yes
+ * ```
+ *
+ * @throws {Error} When required parameters are missing or invalid
+ *
+ * @throws {Error} When target directory conflicts exist
+ *
+ * @since 0.1.0
  */
 exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
     name: 'generate',
-    description: 'Generate basic applet sample',
+    description: 'Generate new signageOS applet projects with boilerplate code',
     optionList: OPTION_LIST,
     commands: [],
     run(options) {
@@ -176,7 +182,7 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
             // Detect if the command has been called with optional parameters
             const excludedKeys = ['command', 'applet-version'];
             const argumentsFound = Object.entries(options)
-                .filter(([key, _value]) => !excludedKeys.includes(key))
+                .filter(([key]) => !excludedKeys.includes(key))
                 .map(([key, value]) => ({ [key]: value })).length > 0;
             console.info('sOS CLI started with params:', options);
             // Create file index
@@ -455,7 +461,7 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
                 });
                 // Capture and log stdout
                 child.stdout.on('data', (data) => {
-                    console.log(`${data.toString()}`);
+                    console.info(`${data.toString()}`);
                 });
                 // Capture and log stderr
                 child.stderr.on('data', (data) => {
@@ -499,10 +505,10 @@ const createPackageConfig = (name, version, bundler, language) => __awaiter(void
     }
     // Add typescript checking before builds
     if (language === Language.TypeScript) {
-        scriptDef.typecheck = 'tsc --noEmit';
+        scriptDef['check-types'] = 'tsc --noEmit';
         // Make sure build exists before modifying it
         if (scriptDef.build) {
-            scriptDef.build = `npm run typecheck && ${scriptDef.build}`;
+            scriptDef.build = `npm run check-types && ${scriptDef.build}`;
         }
     }
     return {
@@ -536,7 +542,7 @@ always-auth=true
  * Check if the value is present and is one of the supported options
  * @param propName - The name of the property to check
  * @param value - The value to check
- * @param options - The supported options
+ * @param {Object} options - The supported options
  * @throws Will throw an error if the value is not present or not one of the supported options
  */
 function checkSupport(propName, value, options) {

package/dist/Applet/Start/appletStartCommand.d.ts

@@ -2,7 +2,7 @@ import { CommandLineOptions } from '../../Command/commandDefinition';
 export 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;
@@ -48,13 +48,55 @@ export declare const OPTION_LIST: readonly [{
     readonly description: "Url of forward server to connect to the device instead of the local network (LAN).";
     readonly defaultValue: string | undefined;
 }];
+/**
+ * Starts a local development server with hot reload functionality, allowing developers
+ * to preview their applets in a browser-based emulator. Supports both local development
+ * and device connection for testing on actual signageOS devices.
+ *
+ * @group Development:3
+ *
+ * @example
+ * ```bash
+ * # Start development server with default settings
+ * sos applet start
+ *
+ * # Start with custom port and hot reload
+ * sos applet start --port 8080 --hot-reload
+ *
+ * # Start with specific organization
+ * sos applet start --organization-uid abc123
+ *
+ * # Start with custom applet path
+ * sos applet start --applet-path ./my-applet
+ *
+ * # Start with specific entry file
+ * sos applet start --entry-file-path index.html
+ *
+ * # Force restart if server is already running
+ * sos applet start --force
+ *
+ * # Run in detached mode
+ * sos applet start --detach
+ * ```
+ *
+ * @remarks
+ * The development server provides a browser-based emulator accessible at http://localhost:8090
+ * by default. Hot reload automatically refreshes the emulator when source code changes.
+ *
+ * @throws {Error} When applet files are not found or invalid
+ * @throws {Error} When organization is not accessible
+ *
+ * @see {@link https://developers.signageos.io/docs/applets/connect-to-device-cli/ Applet Development Documentation}
+ *
+ * @since 0.1.0
+ */
 export declare const appletStart: {
     name: "start";
     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/Applet/Start/appletStartCommand.js

@@ -29,7 +29,7 @@ const PORT_OPTION = {
     name: 'port',
     type: Number,
     description: `Port where will the applet run`,
-    defaultValue: DEFAULT_PORT,
+    defaultValue: 8090,
 };
 exports.OPTION_LIST = [
     organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION,
@@ -44,9 +44,51 @@ exports.OPTION_LIST = [
     appletServerHelper_1.DETACH_PROCESS_OPTION,
     appletServerHelper_1.FORWARD_SERVER_URL_OPTION,
 ];
+/**
+ * Starts a local development server with hot reload functionality, allowing developers
+ * to preview their applets in a browser-based emulator. Supports both local development
+ * and device connection for testing on actual signageOS devices.
+ *
+ * @group Development:3
+ *
+ * @example
+ * ```bash
+ * # Start development server with default settings
+ * sos applet start
+ *
+ * # Start with custom port and hot reload
+ * sos applet start --port 8080 --hot-reload
+ *
+ * # Start with specific organization
+ * sos applet start --organization-uid abc123
+ *
+ * # Start with custom applet path
+ * sos applet start --applet-path ./my-applet
+ *
+ * # Start with specific entry file
+ * sos applet start --entry-file-path index.html
+ *
+ * # Force restart if server is already running
+ * sos applet start --force
+ *
+ * # Run in detached mode
+ * sos applet start --detach
+ * ```
+ *
+ * @remarks
+ * The development server provides a browser-based emulator accessible at http://localhost:8090
+ * by default. Hot reload automatically refreshes the emulator when source code changes.
+ *
+ * @throws {Error} When applet files are not found or invalid
+ * @throws {Error} When organization is not accessible
+ *
+ * @see {@link https://developers.signageos.io/docs/applets/connect-to-device-cli/ Applet Development Documentation}
+ *
+ * @since 0.1.0
+ */
 exports.appletStart = (0, commandDefinition_1.createCommandDefinition)({
     name: 'start',
-    description: 'Start applet locally',
+    description: 'Start local applet development server with live preview',
     optionList: exports.OPTION_LIST,
     commands: [],
     run(options) {

package/dist/Applet/Test/Upload/appletTestRunCommand.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: "device-uid";
     readonly type: StringConstructor;
@@ -25,13 +25,36 @@ declare const OPTION_LIST: readonly [{
     readonly type: BooleanConstructor;
     readonly description: "Allow to run applet test without confirmation step";
 }];
+/**
+ * Executes previously uploaded applet tests on remote signageOS devices. This command
+ * triggers test execution and provides real-time feedback on test progress and results.
+ * Tests can be run on specific devices or across multiple devices for comprehensive testing.
+ *
+ * @group Development:2
+ *
+ * @example
+ * ```bash
+ * # Run all applet tests
+ * sos applet test run --applet-uid my-applet --device-uid device123
+ *
+ * # Run specific tests
+ * sos applet test run --applet-uid my-applet --device-uid device123 --test "test1,test2"
+ *
+ * # Run without confirmation
+ * sos applet test run --applet-uid my-applet --device-uid device123 --yes
+ * ```
+ *
+ * @see {@link ../upload/ Upload test configuration command}
+ *
+ * @since 0.10.0
+ */
 export declare const appletTestRun: {
     name: "run";
     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: "device-uid";
         readonly type: StringConstructor;

package/dist/Applet/Test/Upload/appletTestRunCommand.js

@@ -41,9 +41,32 @@ const OPTION_LIST = [
         description: `Allow to run applet test without confirmation step`,
     },
 ];
+/**
+ * Executes previously uploaded applet tests on remote signageOS devices. This command
+ * triggers test execution and provides real-time feedback on test progress and results.
+ * Tests can be run on specific devices or across multiple devices for comprehensive testing.
+ *
+ * @group Development:2
+ *
+ * @example
+ * ```bash
+ * # Run all applet tests
+ * sos applet test run --applet-uid my-applet --device-uid device123
+ *
+ * # Run specific tests
+ * sos applet test run --applet-uid my-applet --device-uid device123 --test "test1,test2"
+ *
+ * # Run without confirmation
+ * sos applet test run --applet-uid my-applet --device-uid device123 --yes
+ * ```
+ *
+ * @see {@link ../upload/ Upload test configuration command}
+ *
+ * @since 0.10.0
+ */
 exports.appletTestRun = (0, commandDefinition_1.createCommandDefinition)({
     name: 'run',
-    description: 'Runs applet tests',
+    description: 'Run applet tests on signageOS devices',
     optionList: OPTION_LIST,
     commands: [],
     run(options) {

package/dist/Applet/Test/Upload/appletTestUploadCommand.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;
@@ -18,15 +18,45 @@ declare const OPTION_LIST: readonly [{
 }, {
     readonly name: "verbose";
     readonly type: BooleanConstructor;
-    readonly description: "outputs all files to upload";
+    readonly description: "Outputs all files to upload";
 }];
+/**
+ * Uploads test files for remote execution on signageOS devices. Test files are
+ * identified based on the test configuration in package.json and uploaded to
+ * the platform for automated testing. Supports incremental uploads with
+ * change detection and confirmation prompts.
+ *
+ * @group Development:1
+ *
+ * @example
+ * ```bash
+ * # Upload applet tests
+ * sos applet test upload
+ *
+ * # Upload tests with confirmation skip
+ * sos applet test upload --yes
+ *
+ * # Upload tests with verbose output
+ * sos applet test upload --verbose
+ *
+ * # Upload tests for specific applet
+ * sos applet test upload --applet-uid my-applet-uid
+ * ```
+ *
+ * @throws {Error} When package.json is missing or test configuration is invalid
+ * @throws {Error} When test files cannot be found or read
+ * @throws {Error} When applet or organization access is denied
+ * @throws {Error} When test upload confirmation is denied
+ *
+ * @since 0.10.0
+ */
 export declare const appletTestUpload: {
     name: "upload";
     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;
@@ -42,7 +72,7 @@ export declare const appletTestUpload: {
     }, {
         readonly name: "verbose";
         readonly type: BooleanConstructor;
-        readonly description: "outputs all files to upload";
+        readonly description: "Outputs all files to upload";
     }];
     commands: never[];
     run(options: CommandLineOptions<typeof OPTION_LIST>): Promise<void>;

package/dist/Applet/Test/Upload/appletTestUploadCommand.js

@@ -35,12 +35,42 @@ const OPTION_LIST = [
     {
         name: 'verbose',
         type: Boolean,
-        description: `outputs all files to upload`,
+        description: `Outputs all files to upload`,
     },
 ];
+/**
+ * Uploads test files for remote execution on signageOS devices. Test files are
+ * identified based on the test configuration in package.json and uploaded to
+ * the platform for automated testing. Supports incremental uploads with
+ * change detection and confirmation prompts.
+ *
+ * @group Development:1
+ *
+ * @example
+ * ```bash
+ * # Upload applet tests
+ * sos applet test upload
+ *
+ * # Upload tests with confirmation skip
+ * sos applet test upload --yes
+ *
+ * # Upload tests with verbose output
+ * sos applet test upload --verbose
+ *
+ * # Upload tests for specific applet
+ * sos applet test upload --applet-uid my-applet-uid
+ * ```
+ *
+ * @throws {Error} When package.json is missing or test configuration is invalid
+ * @throws {Error} When test files cannot be found or read
+ * @throws {Error} When applet or organization access is denied
+ * @throws {Error} When test upload confirmation is denied
+ *
+ * @since 0.10.0
+ */
 exports.appletTestUpload = (0, commandDefinition_1.createCommandDefinition)({
     name: 'upload',
-    description: 'Uploads applet test',
+    description: 'Upload applet tests to the signageOS platform',
     optionList: OPTION_LIST,
     commands: [],
     run(options) {