Variable dockerConst

Type Declaration

• compose: function

  • compose(
        project: string,
        file: string,
        operation: "up" | "down" | "ps" | "logs" | "pull",
        options?: EnvironmentTaskOptions,
    ): TaskDefinition

    Run a Compose project operation with an explicit project identity and file. Down retains named volumes.

    Parameters

    • project: string
    • file: string
    • operation: "up" | "down" | "ps" | "logs" | "pull"
    • Optionaloptions: EnvironmentTaskOptions

    Returns TaskDefinition

• exec: function

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

    Execute a literal argument vector in an existing container.

    Parameters

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

    Returns TaskDefinition

• remove: function

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

    Remove only the named stopped container; no force or volume deletion is enabled.

    Parameters

    • name: string
    • Optionaloptions: EnvironmentTaskOptions

    Returns TaskDefinition

• run: function

  • run(
        name: string,
        image: string,
        command?: readonly string[],
        options?: EnvironmentTaskOptions & {
            detach?: boolean;
            envFiles?: readonly string[];
            removeOnExit?: boolean;
        },
    ): TaskDefinition

    Run a named container with an optional literal guest command. No privileged mounts are added.

    Parameters

    • name: string
    • image: string
    • command: readonly string[] = []
    • options: EnvironmentTaskOptions & {
          detach?: boolean;
          envFiles?: readonly string[];
          removeOnExit?: boolean;
      } = {}

    Returns TaskDefinition

• stop: function

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

    Stop only the named container.

    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 container using its own Workstation.

    Parameters

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

    Returns TaskDefinition