Workstation API - v0.6.2
    Preparing search index...

    Function createWorkstation

    • Create an embedded client. Methods load fresh definitions, throw errors, and never exit the host process.

      Parameters

      Returns {
          configuration: () => Promise<ResolvedConfig>;
          build(
              settings?: { frozen?: boolean; noRemove?: boolean },
          ): Promise<Action[]>;
          doctor(): Promise<string[]>;
          history(): Promise<string[]>;
          plan(settings?: { frozen?: boolean }): Promise<Action[]>;
          rollback(
              snapshot: string,
              settings?: { apply?: boolean },
          ): Promise<Action[]>;
          status(): Promise<ResourceStatus[]>;
          task(name: string, args?: readonly string[]): Promise<CommandResult>;
          updateLock(ids?: readonly string[]): Promise<LockedConfigResult>;
          upgrade(ids?: readonly string[]): Promise<Action[]>;
      }

      • configuration: () => Promise<ResolvedConfig>

        Resolve current declarations from memory or the selected entry point.

      • build: function
        • Install missing prerequisites, lock and apply configuration.

          Parameters

          • settings: { frozen?: boolean; noRemove?: boolean } = {}

          Returns Promise<Action[]>

      • doctor: function
        • Check command availability and report backend limitations.

          Returns Promise<string[]>

      • history: function
        • List recovery identifiers for this configuration.

          Returns Promise<string[]>

      • plan: function
        • Read-only plan; managers must already be available. Does not install prerequisites or write locks.

          Parameters

          • settings: { frozen?: boolean } = {}

          Returns Promise<Action[]>

      • rollback: function
        • Preview rollback, or execute with apply: true.

          Parameters

          • snapshot: string
          • settings: { apply?: boolean } = {}

          Returns Promise<Action[]>

      • status: function
      • task: function
        • Run a declared task without reconciling resources or bootstrapping tools.

          Parameters

          • name: string
          • args: readonly string[] = []

          Returns Promise<CommandResult>

      • updateLock: function
        • Refresh all pins or selected package resource IDs without installing packages.

          Parameters

          • Optionalids: readonly string[]

          Returns Promise<LockedConfigResult>

      • upgrade: function
        • Refresh selected packages and reconcile through the same state transaction.

          Parameters

          • Optionalids: readonly string[]

          Returns Promise<Action[]>