Interface CommandExecutor

Runs Edgible CLI invocations somewhere — on the host or inside a VM guest.

interface CommandExecutor {
    execute(options: ExecuteOptions): Promise<CommandResult>;
    getGuestPaths?(): SshExecutorGuestPaths | undefined;
    getVm?(): VmExecHost | undefined;
}

Implemented by

Index

Methods

execute getGuestPaths? getVm?

Methods

execute

execute(options: ExecuteOptions): Promise<CommandResult>
Run one CLI invocation to completion. Resolves (never rejects) on non-zero exit; check success.
Parameters
- options: ExecuteOptions
Returns Promise<CommandResult>
- Defined in src/node/vm/executor.ts:46

`Optional`getGuestPaths

getGuestPaths?(): SshExecutorGuestPaths | undefined
When running in a VM, returns the paths of binaries inside the guest.

Returns SshExecutorGuestPaths | undefined
- Defined in src/node/vm/executor.ts:50

`Optional`getVm

getVm?(): VmExecHost | undefined
When running in a VM, returns the VM for raw exec (e.g. background agent start/stop).

Returns VmExecHost | undefined
- Defined in src/node/vm/executor.ts:48