@spec address(t()) :: {:ok, String.t()} | {:error, term()}

Canonical Dagger address of the workspace directory.

@spec checks(t(), [{:include, [String.t()]}]) :: Dagger.CheckGroup.t()

Return all checks from modules loaded in the workspace.

@spec client_id(t()) :: {:ok, String.t()} | {:error, term()}

The client ID that owns this workspace's host filesystem.

@spec config_path(t()) :: {:ok, String.t()} | {:error, term()}

Path to config.toml relative to the workspace boundary (empty if not initialized).

@spec directory(t(), String.t(),
  exclude: [String.t()],
  include: [String.t()],
  gitignore: boolean() | nil
) :: Dagger.Directory.t()

Returns a Directory from the workspace.

Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.

@spec file(t(), String.t()) :: Dagger.File.t()

Returns a File from the workspace.

Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.

@spec find_up(t(), String.t(), [{:from, String.t() | nil}]) ::
  {:ok, String.t() | nil} | {:error, term()}

Search for a file or directory by walking up from the start path within the workspace.

Returns the absolute workspace path if found, or null if not found.

Relative start paths resolve from the workspace directory.

The search stops at the workspace boundary and will not traverse above it.

@spec generators(t(), [{:include, [String.t()]}]) :: Dagger.GeneratorGroup.t()

Return all generators from modules loaded in the workspace.

@spec has_config(t()) :: {:ok, boolean()} | {:error, term()}

Whether a config.toml file exists in the workspace.

@spec id(t()) :: {:ok, Dagger.WorkspaceID.t()} | {:error, term()}

A unique identifier for this Workspace.

@spec initialized(t()) :: {:ok, boolean()} | {:error, term()}

Whether .dagger/config.toml exists.

@spec path(t()) :: {:ok, String.t()} | {:error, term()}

Workspace directory path relative to the workspace boundary.

@spec services(t(), [{:include, [String.t()]}]) :: Dagger.UpGroup.t()

Return all services from modules loaded in the workspace.