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"; }, { readonly name: "organization-uid"; readonly type: StringConstructor; readonly description: "Organization UID"; }, { readonly name: "port"; readonly type: NumberConstructor; readonly description: "Port where will the applet run"; readonly defaultValue: 8090; }, { 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."; }, { readonly name: "entry-file-path"; readonly type: StringConstructor; readonly description: "Path to the applet entry file. Relative to the command or absolute."; }, { readonly name: "hot-reload"; readonly type: BooleanConstructor; readonly description: "Enable hot reload and build of applet"; readonly defaultValue: false; }, { 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: "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: "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: "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; }]; /** * 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:13 * * @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"; }, { readonly name: "organization-uid"; readonly type: StringConstructor; readonly description: "Organization UID"; }, { readonly name: "port"; readonly type: NumberConstructor; readonly description: "Port where will the applet run"; readonly defaultValue: 8090; }, { 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."; }, { readonly name: "entry-file-path"; readonly type: StringConstructor; readonly description: "Path to the applet entry file. Relative to the command or absolute."; }, { readonly name: "hot-reload"; readonly type: BooleanConstructor; readonly description: "Enable hot reload and build of applet"; readonly defaultValue: false; }, { 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: "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: "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: "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; }]; commands: never[]; run(options: CommandLineOptions): Promise; };