import { CommandLineOptions } from '../../Command/commandDefinition'; export declare const USE_FORWARD_SERVER_OPTION: { readonly name: "use-forward-server"; readonly type: BooleanConstructor; readonly description: string; }; declare const OPTION_LIST: readonly [{ readonly name: "no-default-organization"; readonly type: BooleanConstructor; readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc"; }, { readonly name: "organization-uid"; readonly type: StringConstructor; readonly description: "Organization UID"; }, { readonly name: "device-uid"; readonly type: StringConstructor; readonly description: "Device UID"; }, { readonly name: "applet-uid"; readonly type: StringConstructor; readonly description: "Applet UID"; }, { readonly name: "server-public-url"; readonly type: StringConstructor; readonly description: "Public url of local machine server. Is useful when the local machine is behind a reverse proxy."; }, { readonly name: "server-port"; readonly type: NumberConstructor; readonly description: "The custom server port for local machine server. Default is detected from currently running applet server."; }, { readonly name: "force"; readonly type: BooleanConstructor; readonly description: "Force start applet server even if it is already running on a different port. Kill the running server first."; }, { readonly name: "use-forward-server"; readonly type: BooleanConstructor; readonly description: string; }, { readonly name: "detach"; readonly type: BooleanConstructor; readonly description: "Detach the applet HTTP server process from the terminal. Useful when want to run more commands reusing the same http server for current applet."; readonly defaultValue: false; }, { readonly name: "forward-server-url"; readonly type: StringConstructor; readonly description: "Url of forward server to connect to the device instead of the local network (LAN)."; readonly defaultValue: string | undefined; }, { readonly name: "hot-reload"; readonly type: BooleanConstructor; readonly description: "Enable hot reload and build of applet"; readonly defaultValue: false; }, { readonly name: "applet-path"; readonly type: StringConstructor; readonly description: "Path to the applet file or the project folder depending on the entry file. Relative to the command or absolute."; }]; /** * 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:11 * * @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 */ export declare const connect: { name: "connect"; description: string; optionList: readonly [{ readonly name: "no-default-organization"; readonly type: BooleanConstructor; readonly description: "Prevent using the defaultOrganizationUid from ~/.sosrc"; }, { readonly name: "organization-uid"; readonly type: StringConstructor; readonly description: "Organization UID"; }, { readonly name: "device-uid"; readonly type: StringConstructor; readonly description: "Device UID"; }, { readonly name: "applet-uid"; readonly type: StringConstructor; readonly description: "Applet UID"; }, { readonly name: "server-public-url"; readonly type: StringConstructor; readonly description: "Public url of local machine server. Is useful when the local machine is behind a reverse proxy."; }, { readonly name: "server-port"; readonly type: NumberConstructor; readonly description: "The custom server port for local machine server. Default is detected from currently running applet server."; }, { readonly name: "force"; readonly type: BooleanConstructor; readonly description: "Force start applet server even if it is already running on a different port. Kill the running server first."; }, { readonly name: "use-forward-server"; readonly type: BooleanConstructor; readonly description: string; }, { readonly name: "detach"; readonly type: BooleanConstructor; readonly description: "Detach the applet HTTP server process from the terminal. Useful when want to run more commands reusing the same http server for current applet."; readonly defaultValue: false; }, { readonly name: "forward-server-url"; readonly type: StringConstructor; readonly description: "Url of forward server to connect to the device instead of the local network (LAN)."; readonly defaultValue: string | undefined; }, { readonly name: "hot-reload"; readonly type: BooleanConstructor; readonly description: "Enable hot reload and build of applet"; readonly defaultValue: false; }, { readonly name: "applet-path"; readonly type: StringConstructor; readonly description: "Path to the applet file or the project folder depending on the entry file. Relative to the command or absolute."; }]; commands: never[]; run: (options: CommandLineOptions) => Promise; }; export {};