@edgible-team/sdk
    Preparing search index...

    Interface ProvisionVmWithAgentOptions

    Options for provisionVmWithAgent.

    interface ProvisionVmWithAgentOptions {
        client: ProvisionClientSurface;
        cloudRegion?: string;
        credentials: { email: string; password: string };
        deviceName?: string;
        deviceType?: "cloud" | "gateway" | "serving";
        ensureNode?: boolean;
        guestEnv?: Record<string, string>;
        hooks?: ProvisionHooks;
        installType?: string;
        logger?: Logger;
        onProgress?: (event: ProvisionProgressEvent) => void;
        organizationId?: string;
        poll?: { intervalMs?: number; timeoutMs?: number };
        projectRoot?: string;
        stage?: "dev" | "test" | "uat" | "prod";
        startVm?: boolean;
        syncAndBuild?: boolean;
        timeouts?: {
            agentInstallMs?: number;
            loginMs?: number;
            nodeInstallMs?: number;
        };
        vm: ProvisionVm;
    }
    Index

    Properties

    client cloudRegion? credentials deviceName? deviceType? ensureNode? guestEnv? hooks? installType? logger? onProgress? organizationId? poll? projectRoot? stage? startVm? syncAndBuild? timeouts? vm

    Properties

    client: ProvisionClientSurface

    SDK client used for control-plane reads (device-active polling).

    cloudRegion?: string

    Region the agent reports via cloudCapabilities. Default 'us-east-dev'.

    credentials: { email: string; password: string }

    Credentials for the in-guest CLI login.

    deviceName?: string

    Device name to register under. Default: timestamped unique name.

    deviceType?: "cloud" | "gateway" | "serving"

    Passed to agent install --device-type. Default 'cloud'.

    ensureNode?: boolean

    Verify/install Node 20+ in the guest before building. Default true.

    guestEnv?: Record<string, string>

    Extra env vars exported for every in-guest CLI call.

    hooks?: ProvisionHooks
    installType?: string

    Passed to agent install --type. Default 'systemd'.

    logger?: Logger
    onProgress?: (event: ProvisionProgressEvent) => void

    Receives a ProvisionProgressEvent as each ProvisionPhase begins.

    organizationId?: string

    Skip the in-guest config read when the org is already known.

    poll?: { intervalMs?: number; timeoutMs?: number }

    Device-active polling overrides (defaults: 6s interval, 120s timeout).

    projectRoot?: string

    Repo root for syncCode. Required unless syncAndBuild is false.

    stage?: "dev" | "test" | "uat" | "prod"

    Stage the in-guest CLI targets (exported as STAGE). Without it the guest CLI defaults to prod. Use the same stage as the SDK client.

    startVm?: boolean

    Call vm.start() first. Default true (pass false for an already-running VM).

    syncAndBuild?: boolean

    rsync + build the source in the guest. Default true.

    timeouts?: { agentInstallMs?: number; loginMs?: number; nodeInstallMs?: number }

    In-guest step timeouts (defaults: node install 180s, agent install 180s, login 30s).

    vm: ProvisionVm

    The (cloud-host) VM to provision. The caller constructs it; stop() is returned.

    Settings

    Member Visibility

    On This Page

    Properties