@signageos/cli 2.4.1 → 2.5.1

package/dist/Applet/Test/appletTestCommand.d.ts

@@ -1,3 +1,20 @@
+/**
+ * Provides commands for testing applets on the signageOS platform, including
+ * uploading test configurations and running remote tests on actual devices.
+ *
+ * @group Development:4
+ *
+ * @example
+ * ```bash
+ * # Upload test configuration
+ * sos applet test upload
+ *
+ * # Run tests remotely
+ * sos applet test run
+ * ```
+ *
+ * @since 0.10.0
+ */
 export declare const appletTest: {
     name: "test";
     description: string;
@@ -8,7 +25,7 @@ export declare const appletTest: {
         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;
@@ -35,7 +52,7 @@ export declare const appletTest: {
         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: "device-uid";
             readonly type: StringConstructor;
@@ -64,7 +81,7 @@ export declare const appletTest: {
         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;
@@ -80,13 +97,13 @@ export declare const appletTest: {
         }, {
             readonly name: "verbose";
             readonly type: BooleanConstructor;
-            readonly description: "outputs all files to upload";
+            readonly description: "Outputs all files to upload";
         }];
         commands: never[];
         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;
@@ -102,7 +119,7 @@ export declare const appletTest: {
         }, {
             readonly name: "verbose";
             readonly type: BooleanConstructor;
-            readonly description: "outputs all files to upload";
+            readonly description: "Outputs all files to upload";
         }]>): Promise<void>;
     })[];
     run(): Promise<never>;

package/dist/Applet/Test/appletTestCommand.js

@@ -13,6 +13,23 @@ exports.appletTest = void 0;
 const commandDefinition_1 = require("../../Command/commandDefinition");
 const appletTestRunCommand_1 = require("./Upload/appletTestRunCommand");
 const appletTestUploadCommand_1 = require("./Upload/appletTestUploadCommand");
+/**
+ * Provides commands for testing applets on the signageOS platform, including
+ * uploading test configurations and running remote tests on actual devices.
+ *
+ * @group Development:4
+ *
+ * @example
+ * ```bash
+ * # Upload test configuration
+ * sos applet test upload
+ *
+ * # Run tests remotely
+ * sos applet test run
+ * ```
+ *
+ * @since 0.10.0
+ */
 exports.appletTest = (0, commandDefinition_1.createCommandDefinition)({
     name: 'test',
     description: 'Applet test management',

package/dist/Applet/Upload/appletUploadCommand.d.ts

@@ -10,7 +10,7 @@ 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;
@@ -30,8 +30,50 @@ export 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 the current applet version to the signageOS platform, making it available
+ * for deployment to devices. The command supports both single-file and multi-file applets,
+ * with automatic version management and conflict detection.
+ *
+ * The upload process validates package.json requirements, creates or updates applet versions,
+ * and handles file packaging according to .sosignore, .npmignore, and .gitignore rules.
+ *
+ * @group Development:5
+ *
+ * @example
+ * ```bash
+ * # Upload applet from current directory
+ * sos applet upload
+ *
+ * # Upload with specific applet path
+ * sos applet upload --applet-path ./dist
+ *
+ * # Upload with custom entry file
+ * sos applet upload --entry-file-path src/main.js
+ *
+ * # Upload with organization override
+ * sos applet upload --organization-uid abc123def456
+ *
+ * # Skip confirmation prompts
+ * sos applet upload --yes
+ *
+ * # Verbose output with detailed file information
+ * sos applet upload --verbose
+ *
+ * # Update package.json with new applet UID
+ * sos applet upload --update-package-config
+ * ```
+ *
+ * @throws {Error} When package.json is missing or invalid
+ * @throws {Error} When applet path or entry file cannot be found
+ * @throws {Error} When organization or applet access is denied
+ * @throws {GatewayError} When upload fails due to server issues
+ * @throws {NotFoundError} When specified applet or organization doesn't exist
+ *
+ * @since 0.4.0
+ */
 export declare const appletUpload: {
     name: "upload";
     description: string;
@@ -46,7 +88,7 @@ export declare const appletUpload: {
     }, {
         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;
@@ -66,7 +108,7 @@ export declare const appletUpload: {
     }, {
         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/Upload/appletUploadCommand.js

@@ -50,9 +50,51 @@ exports.OPTION_LIST = [
     {
         name: 'verbose',
         type: Boolean,
-        description: `outputs all files to upload`,
+        description: `Outputs all files to upload`,
     },
 ];
+/**
+ * Uploads the current applet version to the signageOS platform, making it available
+ * for deployment to devices. The command supports both single-file and multi-file applets,
+ * with automatic version management and conflict detection.
+ *
+ * The upload process validates package.json requirements, creates or updates applet versions,
+ * and handles file packaging according to .sosignore, .npmignore, and .gitignore rules.
+ *
+ * @group Development:5
+ *
+ * @example
+ * ```bash
+ * # Upload applet from current directory
+ * sos applet upload
+ *
+ * # Upload with specific applet path
+ * sos applet upload --applet-path ./dist
+ *
+ * # Upload with custom entry file
+ * sos applet upload --entry-file-path src/main.js
+ *
+ * # Upload with organization override
+ * sos applet upload --organization-uid abc123def456
+ *
+ * # Skip confirmation prompts
+ * sos applet upload --yes
+ *
+ * # Verbose output with detailed file information
+ * sos applet upload --verbose
+ *
+ * # Update package.json with new applet UID
+ * sos applet upload --update-package-config
+ * ```
+ *
+ * @throws {Error} When package.json is missing or invalid
+ * @throws {Error} When applet path or entry file cannot be found
+ * @throws {Error} When organization or applet access is denied
+ * @throws {GatewayError} When upload fails due to server issues
+ * @throws {NotFoundError} When specified applet or organization doesn't exist
+ *
+ * @since 0.4.0
+ */
 exports.appletUpload = (0, commandDefinition_1.createCommandDefinition)({
     name: 'upload',
     description: 'Uploads current applet version',
@@ -90,9 +132,9 @@ exports.appletUpload = (0, commandDefinition_1.createCommandDefinition)({
                 if (!(error instanceof appletErrors_1.AppletDoesNotExistError)) {
                     throw error;
                 }
-                (0, log_1.log)('info', chalk_1.default.yellow(`applet uid is not present in package file, adding one.`));
                 const createdApplet = yield restApi.applet.create({ name: appletName });
                 appletUid = createdApplet.uid;
+                (0, log_1.log)('info', chalk_1.default.yellow(`Applet uid is not present in package file.`, chalk_1.default.blue(`\nCreated new uid:`), chalk_1.default.green(appletUid)), `\n`);
             }
             finally {
                 if (updatePackageConfig) {

package/dist/Applet/Upload/appletUploadFacade.js

@@ -71,8 +71,8 @@ const updateMultiFileApplet = (parameters) => __awaiter(void 0, void 0, void 0,
     const { restApi, applet, progressBar } = parameters;
     const currentAppletFiles = yield (0, appletUploadFacadeHelper_1.getAppletFilesDictionary)(restApi, applet.uid, applet.version);
     let changedFilesCounter = 0;
-    for (let index = 0; index < applet.files.length; index++) {
-        const fileAbsolutePath = applet.files[index];
+    for (const element of applet.files) {
+        const fileAbsolutePath = element;
         if (!fileAbsolutePath) {
             continue;
         }
@@ -120,7 +120,7 @@ const updateMultiFileApplet = (parameters) => __awaiter(void 0, void 0, void 0,
         }
     }
     for (const fileRelativePath in currentAppletFiles) {
-        if (currentAppletFiles.hasOwnProperty(fileRelativePath)) {
+        if (Object.prototype.hasOwnProperty.call(currentAppletFiles, fileRelativePath)) {
             try {
                 yield restApi.applet.version.file.remove(applet.uid, applet.version, fileRelativePath, { build: false });
             }

package/dist/Applet/appletCommand.d.ts

@@ -1,3 +1,35 @@
+/**
+ * Provides comprehensive commands for the complete applet development lifecycle including
+ * project generation, development, building, testing, uploading, and deployment to signageOS devices.
+ *
+ * @group Development:2
+ *
+ * @subcommands
+ * - `generate` - Create a new applet project with boilerplate code
+ * - `start` - Start local development server with hot reload
+ * - `build` - Build applet for production deployment
+ * - `upload` - Upload applet to signageOS platform
+ * - `test` - Run and upload applet tests
+ *
+ * @example
+ * ```bash
+ * # Create new applet project
+ * sos applet generate --name my-applet
+ *
+ * # Start development server
+ * sos applet start
+ *
+ * # Build for production
+ * sos applet build
+ *
+ * # Upload to platform
+ * sos applet upload
+ * ```
+ *
+ * @see {@link https://developers.signageos.io/docs/applets/ Applet Documentation}
+ *
+ * @since 0.1.0
+ */
 export declare const applet: {
     name: "applet";
     description: string;
@@ -42,7 +74,7 @@ export declare const applet: {
         }, {
             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;
@@ -62,7 +94,7 @@ export declare const applet: {
         }, {
             readonly name: "verbose";
             readonly type: BooleanConstructor;
-            readonly description: "outputs all files to upload";
+            readonly description: "Outputs all files to upload";
         }];
         commands: never[];
         run(options: import("../Command/commandDefinition").CommandLineOptions<typeof import("./Upload/appletUploadCommand").OPTION_LIST>): Promise<void>;
@@ -72,7 +104,7 @@ export declare const applet: {
         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;
@@ -130,7 +162,7 @@ export declare const applet: {
             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;
@@ -157,7 +189,7 @@ export declare const applet: {
             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: "device-uid";
                 readonly type: StringConstructor;
@@ -186,7 +218,7 @@ export declare const applet: {
             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;
@@ -202,13 +234,13 @@ export declare const applet: {
             }, {
                 readonly name: "verbose";
                 readonly type: BooleanConstructor;
-                readonly description: "outputs all files to upload";
+                readonly description: "Outputs all files to upload";
             }];
             commands: never[];
             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;
@@ -224,7 +256,7 @@ export declare const applet: {
             }, {
                 readonly name: "verbose";
                 readonly type: BooleanConstructor;
-                readonly description: "outputs all files to upload";
+                readonly description: "Outputs all files to upload";
             }]>): Promise<void>;
         })[];
         run(): Promise<never>;
@@ -234,7 +266,7 @@ export declare const applet: {
         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/appletCommand.js

@@ -16,9 +16,41 @@ const appletStartCommand_1 = require("./Start/appletStartCommand");
 const appletTestCommand_1 = require("./Test/appletTestCommand");
 const commandDefinition_1 = require("../Command/commandDefinition");
 const appletBuildCommand_1 = require("./Build/appletBuildCommand");
+/**
+ * Provides comprehensive commands for the complete applet development lifecycle including
+ * project generation, development, building, testing, uploading, and deployment to signageOS devices.
+ *
+ * @group Development:2
+ *
+ * @subcommands
+ * - `generate` - Create a new applet project with boilerplate code
+ * - `start` - Start local development server with hot reload
+ * - `build` - Build applet for production deployment
+ * - `upload` - Upload applet to signageOS platform
+ * - `test` - Run and upload applet tests
+ *
+ * @example
+ * ```bash
+ * # Create new applet project
+ * sos applet generate --name my-applet
+ *
+ * # Start development server
+ * sos applet start
+ *
+ * # Build for production
+ * sos applet build
+ *
+ * # Upload to platform
+ * sos applet upload
+ * ```
+ *
+ * @see {@link https://developers.signageos.io/docs/applets/ Applet Documentation}
+ *
+ * @since 0.1.0
+ */
 exports.applet = (0, commandDefinition_1.createCommandDefinition)({
     name: 'applet',
-    description: 'Applet management',
+    description: 'Applet development and management operations',
     optionList: [],
     commands: [appletGenerateCommand_1.appletGenerate, appletUploadCommand_1.appletUpload, appletStartCommand_1.appletStart, appletTestCommand_1.appletTest, appletBuildCommand_1.appletBuild],
     run() {

package/dist/Auth/loginCommand.d.ts

@@ -2,7 +2,7 @@ import { CommandLineOptions } from '../Command/commandDefinition';
 declare const OPTION_LIST: readonly [{
     readonly name: "username";
     readonly type: StringConstructor;
-    readonly description: `Username or e-mail used for ${string}`;
+    readonly description: "Username or e-mail used for authentication";
 }];
 /**
  * To explicitly enable auth0 authentication add flag --auth0-enabled to command line options
@@ -17,13 +17,34 @@ export declare const getIsAuth0OrLegacyEnabled: (options: any) => {
     isAuth0Enabled?: boolean;
     isLegacyEnabled?: boolean;
 };
+/**
+ * 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.
+ *
+ * @group Authentication:1
+ *
+ * @example
+ * ```bash
+ * # Interactive login (prompts for username and password)
+ * sos login
+ *
+ * # Login with username specified
+ * sos login --username user@example.com
+ * ```
+ *
+ * @throws {Error} When username is missing and not provided interactively
+ * @throws {Error} When both Auth0 and legacy authentication flags are specified
+ *
+ * @since 0.3.0
+ */
 export declare const login: {
     name: "login";
     description: string;
     optionList: readonly [{
         readonly name: "username";
         readonly type: StringConstructor;
-        readonly description: `Username or e-mail used for ${string}`;
+        readonly description: "Username or e-mail used for authentication";
     }];
     commands: never[];
     run(options: CommandLineOptions<typeof OPTION_LIST>): Promise<void>;

package/dist/Auth/loginCommand.js

@@ -58,7 +58,7 @@ const runControlHelper_1 = require("../RunControl/runControlHelper");
 const parameters_1 = require("../parameters");
 const commandDefinition_1 = require("../Command/commandDefinition");
 const Debug = (0, debug_1.default)('@signageos/cli:Auth:login');
-const OPTION_LIST = [{ name: 'username', type: String, description: `Username or e-mail used for ${parameters_1.parameters.boxHost}` }];
+const OPTION_LIST = [{ name: 'username', type: String, description: `Username or e-mail used for authentication` }];
 /**
  * To explicitly enable auth0 authentication add flag --auth0-enabled to command line options
  * { _unknown: [ '--auth0-enabled' ], command: [ 'login' ] }
@@ -83,19 +83,45 @@ const getIsAuth0OrLegacyEnabled = (options) => {
     return queryParams;
 };
 exports.getIsAuth0OrLegacyEnabled = getIsAuth0OrLegacyEnabled;
+/**
+ * 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.
+ *
+ * @group Authentication:1
+ *
+ * @example
+ * ```bash
+ * # Interactive login (prompts for username and password)
+ * sos login
+ *
+ * # Login with username specified
+ * sos login --username user@example.com
+ * ```
+ *
+ * @throws {Error} When username is missing and not provided interactively
+ * @throws {Error} When both Auth0 and legacy authentication flags are specified
+ *
+ * @since 0.3.0
+ */
 exports.login = (0, commandDefinition_1.createCommandDefinition)({
     name: 'login',
-    description: 'Login account using username & password',
+    description: 'Authenticate user with signageOS',
     optionList: OPTION_LIST,
     commands: [],
     run(options) {
         return __awaiter(this, void 0, void 0, function* () {
             let identification = options.username;
+            const config = yield (0, runControlHelper_1.loadConfig)();
+            const apiUrl = (0, helper_1.getApiUrl)(config);
+            // Extract domain from API URL to show in prompts
+            const apiUrlObj = new URL(apiUrl);
+            const hostToDisplay = apiUrlObj.hostname;
             if (!identification) {
                 const response = yield (0, prompts_1.default)({
                     type: 'text',
                     name: 'username',
-                    message: `Type your username or e-mail used for ${parameters_1.parameters.boxHost}`,
+                    message: `Type your username or e-mail used for ${hostToDisplay}`,
                 });
                 identification = response.username;
             }
@@ -105,10 +131,8 @@ exports.login = (0, commandDefinition_1.createCommandDefinition)({
             const { password } = yield (0, prompts_1.default)({
                 type: 'password',
                 name: 'password',
-                message: `Type your password used for ${parameters_1.parameters.boxHost}`,
+                message: `Type your password used for ${hostToDisplay}`,
             });
-            const config = yield (0, runControlHelper_1.loadConfig)();
-            const apiUrl = (0, helper_1.getApiUrl)(config);
             const authQueryParams = (0, exports.getIsAuth0OrLegacyEnabled)(options);
             const { id: tokenId, securityToken: apiSecurityToken, name, } = yield getOrCreateApiSecurityToken(Object.assign({ identification,
                 password,
@@ -124,6 +148,7 @@ exports.login = (0, commandDefinition_1.createCommandDefinition)({
 });
 function getOrCreateApiSecurityToken(_a) {
     return __awaiter(this, arguments, void 0, function* ({ identification, password, apiUrl, isAuth0Enabled, isLegacyEnabled, }) {
+        var _b;
         const ACCOUNT_SECURITY_TOKEN_RESOURCE = 'account/security-token';
         const options = {
             url: apiUrl,
@@ -131,19 +156,22 @@ function getOrCreateApiSecurityToken(_a) {
             version: apiVersions_1.ApiVersions.V1,
         };
         const tokenName = generateTokenName();
-        const query = Object.assign(Object.assign({ identification,
+        const requestBody = Object.assign(Object.assign({ identification,
             password, name: tokenName }, (isAuth0Enabled !== undefined ? { isAuth0AuthenticationEnabled: isAuth0Enabled } : {})), (isLegacyEnabled !== undefined ? { isLegacyAuthenticationEnabled: isLegacyEnabled } : {}));
-        const responseOfPost = yield (0, helper_1.postResource)(options, ACCOUNT_SECURITY_TOKEN_RESOURCE, query);
-        const bodyOfPost = JSON.parse(yield responseOfPost.text(), helper_1.deserializeJSON);
-        Debug('POST security-token response', bodyOfPost);
-        if (responseOfPost.status === 201) {
-            return bodyOfPost;
+        const response = yield (0, helper_1.postResource)(options, ACCOUNT_SECURITY_TOKEN_RESOURCE, null, requestBody);
+        const responseBody = JSON.parse(yield response.text(), helper_1.deserializeJSON);
+        // Don't log sensitive response data
+        Debug('POST security-token response status', response.status);
+        if (response.status === 201) {
+            return responseBody;
         }
-        else if (responseOfPost.status === 403) {
+        else if (response.status === 403) {
             throw new Error(`Incorrect username or password`);
         }
         else {
-            throw new Error('Unknown error: ' + (bodyOfPost && bodyOfPost.message ? bodyOfPost.message : responseOfPost.status));
+            // Ensure password is not logged in error messages
+            const errorMessage = (_b = responseBody === null || responseBody === void 0 ? void 0 : responseBody.message) !== null && _b !== void 0 ? _b : `HTTP status ${response.status}`;
+            throw new Error('Unknown error: ' + errorMessage);
         }
     });
 }

package/dist/Command/Autocomplete/Install/installAutocompleteCommand.d.ts

@@ -1,6 +1,23 @@
 import { ICommand, OptionList } from '../../commandDefinition';
 export declare const OPTION_LIST: readonly [];
 export declare const setRootCommand: (rootCommand: ICommand<string, OptionList>) => void;
+/**
+ * Enables auto-completion functionality for the signageOS CLI in supported shells.
+ * This command adds auto-completion scripts and configuration to the user's shell
+ * profile, allowing tab completion for commands and sub-commands.
+ *
+ * @group Tools:1
+ *
+ * @example
+ * ```bash
+ * # Install auto-completion
+ * sos autocomplete install
+ * ```
+ *
+ * @see {@link ../uninstall/ Uninstall auto-completion command}
+ *
+ * @since 2.4.0
+ */
 export declare const installAutocomplete: {
     name: "install";
     description: string;

package/dist/Command/Autocomplete/Install/installAutocompleteCommand.js

@@ -20,6 +20,23 @@ const setRootCommand = (rootCommand) => {
     rootCommandRef = rootCommand;
 };
 exports.setRootCommand = setRootCommand;
+/**
+ * Enables auto-completion functionality for the signageOS CLI in supported shells.
+ * This command adds auto-completion scripts and configuration to the user's shell
+ * profile, allowing tab completion for commands and sub-commands.
+ *
+ * @group Tools:1
+ *
+ * @example
+ * ```bash
+ * # Install auto-completion
+ * sos autocomplete install
+ * ```
+ *
+ * @see {@link ../uninstall/ Uninstall auto-completion command}
+ *
+ * @since 2.4.0
+ */
 exports.installAutocomplete = (0, commandDefinition_1.createCommandDefinition)({
     name: 'install',
     description: 'Install command auto-completion for bash/zsh shells',

package/dist/Command/Autocomplete/Install/installAutocompleteCommand.ts

@@ -11,6 +11,23 @@ export const setRootCommand = (rootCommand: ICommand<string, OptionList>): void
 	rootCommandRef = rootCommand;
 };
 
+/**
+ * Enables auto-completion functionality for the signageOS CLI in supported shells.
+ * This command adds auto-completion scripts and configuration to the user's shell
+ * profile, allowing tab completion for commands and sub-commands.
+ *
+ * @group Tools:1
+ *
+ * @example
+ * ```bash
+ * # Install auto-completion
+ * sos autocomplete install
+ * ```
+ *
+ * @see {@link ../uninstall/ Uninstall auto-completion command}
+ *
+ * @since 2.4.0
+ */
 export const installAutocomplete = createCommandDefinition({
 	name: 'install',
 	description: 'Install command auto-completion for bash/zsh shells',