Variable sbxConst

Type Declaration

• create: function

  • create(
        name: string,
        agent: string,
        workspace: string,
        options?: EnvironmentTaskOptions,
    ): TaskDefinition

    Create a named agent sandbox for an explicit host workspace without attaching.

    Parameters

    • name: string
    • agent: string
    • workspace: string
    • Optionaloptions: EnvironmentTaskOptions

    Returns TaskDefinition

• exec: function

  • exec(
        name: string,
        command: readonly [string, string],
        options?: EnvironmentTaskOptions,
    ): TaskDefinition

    Execute commands inside an existing sandbox; arguments are not interpreted by a host shell.

    Parameters

    • name: string
    • command: readonly [string, string]
    • Optionaloptions: EnvironmentTaskOptions

    Returns TaskDefinition

• remove: function

  • remove(name: string, options?: EnvironmentTaskOptions): TaskDefinition

    Remove the named sandbox without forcing active-session deletion.

    Parameters

    • name: string
    • Optionaloptions: EnvironmentTaskOptions

    Returns TaskDefinition

• stop: function

  • stop(name: string, options?: EnvironmentTaskOptions): TaskDefinition

    Stop the named sandbox.

    Parameters

    • name: string
    • Optionaloptions: EnvironmentTaskOptions

    Returns TaskDefinition

• workstation: function

  • workstation(
        name: string,
        guest: NestedWorkstationOptions,
        host?: EnvironmentTaskOptions,
    ): TaskDefinition

    Reconcile or plan a configuration inside an existing Docker Sandbox.

    Parameters

    • name: string
    • guest: NestedWorkstationOptions
    • Optionalhost: EnvironmentTaskOptions

    Returns TaskDefinition