@builder.io/dev-tools/types/cli/launch.d.ts

Builder.io Visual CMS Devtools

import type { DevToolsSys } from "@builder.io/dev-tools/core";
import type { CLIArgs } from "./index";
/**
 * Large random-ish port number that is unlikely to be used
 */
export declare const PROXY_PORT = 48752;
export interface LaunchArgs extends CLIArgs {
    /** Project ID for the dev server. Only needed when running in a remote container. */
    projectId?: string;
    /** Branch name for the dev server. Only needed when running in a remote container. */
    branchName?: string;
    /** Silent mode for launch command */
    silent?: boolean;
    /** Port number for the dev server */
    port?: number;
    /** Port number for the dev server (shorthand) */
    p?: number;
    /** Dev server command to execute */
    command?: string;
    /** Install command to execute */
    installCommand?: string;
    /** Dev server command to execute (shorthand) */
    c?: string;
    /** Dev server URL to proxy to (alternative to command + port) */
    serverUrl?: string;
    /** Use development server instead of production for launch command */
    dev?: boolean;
    /** Skip browser auto-open (flag form) */
    open?: boolean;
    /**
     * If true, CLI will run the init command instead of the launch command.
     *
     * @default false
     */
    fusionInit?: boolean;
    /**
     * If true, CLI will be interactive and prompt the user for input.
     *
     * @default true
     */
    interactive?: boolean;
    /**
     * Decides whether to skip authentication for the user's proxy server.
     * Our own _builder.io/ endpoitns are always authenticated.
     *
     * @default false
     */
    authenticateProxy?: boolean;
    /**
     * Indicates the type of docker image the CLI is running on.
     *
     * @default "node"
     */
    dockerImageType?: "fusion-starter" | "node";
    /**
     * Output structured JSON data.
     * Useful for programmatic consumption (e.g., VSCode extensions).
     *
     * @default false
     */
    jsonOutput?: boolean;
    /**
     * Enable local development mode with port availability checking.
     * When enabled, automatically finds an available port if the default is in use.
     *
     * @default false
     */
    local?: boolean;
}
export declare function runFusionCommand({ sys, args, }: {
    sys: DevToolsSys;
    args: LaunchArgs;
}): Promise<void>;