Index

A

Address — Class in namespace Dagger

A standardized address to load containers, directories, secrets, and other object types. Address format depends on the type, and is validated at type selection.

AddressId — Class in namespace Dagger

The AddressID scalar type represents an identifier for an object of type Address.

Binding::asAddress() — Method in class Binding

Retrieve the binding value, as type Address

Binding::asCacheVolume() — Method in class Binding

Retrieve the binding value, as type CacheVolume

Binding::asChangeset() — Method in class Binding

Retrieve the binding value, as type Changeset

Binding::asCheck() — Method in class Binding

Retrieve the binding value, as type Check

Binding::asCheckGroup() — Method in class Binding

Retrieve the binding value, as type CheckGroup

Binding::asCloud() — Method in class Binding

Retrieve the binding value, as type Cloud

Binding::asContainer() — Method in class Binding

Retrieve the binding value, as type Container

Binding::asDiffStat() — Method in class Binding

Retrieve the binding value, as type DiffStat

Binding::asDirectory() — Method in class Binding

Retrieve the binding value, as type Directory

Binding::asEnv() — Method in class Binding

Retrieve the binding value, as type Env

Binding::asEnvFile() — Method in class Binding

Retrieve the binding value, as type EnvFile

Binding::asFile() — Method in class Binding

Retrieve the binding value, as type File

Binding::asGenerator() — Method in class Binding

Retrieve the binding value, as type Generator

Binding::asGeneratorGroup() — Method in class Binding

Retrieve the binding value, as type GeneratorGroup

Binding::asGitRef() — Method in class Binding

Retrieve the binding value, as type GitRef

Binding::asGitRepository() — Method in class Binding

Retrieve the binding value, as type GitRepository

Binding::asJSONValue() — Method in class Binding

Retrieve the binding value, as type JSONValue

Binding::asModule() — Method in class Binding

Retrieve the binding value, as type Module

Binding::asModuleConfigClient() — Method in class Binding

Retrieve the binding value, as type ModuleConfigClient

Binding::asModuleSource() — Method in class Binding

Retrieve the binding value, as type ModuleSource

Binding::asPhpSdk() — Method in class Binding

Retrieve the binding value, as type PhpSdk

Binding::asSearchResult() — Method in class Binding

Retrieve the binding value, as type SearchResult

Binding::asSearchSubmatch() — Method in class Binding

Retrieve the binding value, as type SearchSubmatch

Binding::asSecret() — Method in class Binding

Retrieve the binding value, as type Secret

Binding::asService() — Method in class Binding

Retrieve the binding value, as type Service

Binding::asSocket() — Method in class Binding

Retrieve the binding value, as type Socket

Binding::asStat() — Method in class Binding

Retrieve the binding value, as type Stat

Binding::asString() — Method in class Binding

Returns the binding's string value

Binding::asUp() — Method in class Binding

Retrieve the binding value, as type Up

Binding::asUpGroup() — Method in class Binding

Retrieve the binding value, as type UpGroup

Binding::asWorkspace() — Method in class Binding

Retrieve the binding value, as type Workspace

Changeset::addedPaths() — Method in class Changeset

Files and directories that were added in the newer directory.

Changeset::after() — Method in class Changeset

The newer/upper snapshot.

Changeset::asPatch() — Method in class Changeset

Return a Git-compatible patch of the changes

ChangesetDiffStatEntry::addedLines() — Method in class ChangesetDiffStatEntry

Number of added lines for this path.

Client::address() — Method in class Client

initialize an address to load directories, containers, secrets or other object types.

AbstractClient — Class in namespace Dagger\ClientAbstractId — Class in namespace Dagger\ClientAbstractInputObject — Class in namespace Dagger\ClientAbstractObject — Class in namespace Dagger\ClientAbstractScalar — Class in namespace Dagger\ClientContainer::asService() — Method in class Container

Turn the container into a Service.

Container::asTarball() — Method in class Container

Package the container state as an OCI image, and return it as a tar archive

DiffStat::addedLines() — Method in class DiffStat

Number of added lines for this path.

Directory::asGit() — Method in class Directory

Converts this directory to a local git repository

Directory::asModule() — Method in class Directory

Load the directory as a Dagger module source

Directory::asModuleSource() — Method in class Directory

Load the directory as a Dagger module source

EngineCacheEntry::activelyUsed() — Method in class EngineCacheEntry

Whether the cache entry is actively being used.

EnvFile::asFile() — Method in class EnvFile

Return as a file

File::asEnvFile() — Method in class File

Parse as an env file

File::asJSON() — Method in class File

Parse the file contents as JSON.

Function_::args() — Method in class Function_

Arguments accepted by the function, if any.

HealthcheckConfig::args() — Method in class HealthcheckConfig

Healthcheck command arguments.

JsonValue::asArray() — Method in class JsonValue

Decode an array from json

JsonValue::asBoolean() — Method in class JsonValue

Decode a boolean from json

JsonValue::asInteger() — Method in class JsonValue

Decode an integer from json

JsonValue::asString() — Method in class JsonValue

Decode a string from json

LLM::attempt() — Method in class LLM

create a branch in the LLM's history

ModuleSource::asModule() — Method in class ModuleSource

Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation

ModuleSource::asString() — Method in class ModuleSource

A human readable ref string representation of this module source.

SearchResult::absoluteOffset() — Method in class SearchResult

The byte offset of this line within the file.

TypeDef::asEnum() — Method in class TypeDef

If kind is ENUM, the enum-specific type definition. If kind is not ENUM, this will be null.

TypeDef::asInput() — Method in class TypeDef

If kind is INPUT, the input-specific type definition. If kind is not INPUT, this will be null.

TypeDef::asInterface() — Method in class TypeDef

If kind is INTERFACE, the interface-specific type definition. If kind is not INTERFACE, this will be null.

TypeDef::asList() — Method in class TypeDef

If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.

TypeDef::asObject() — Method in class TypeDef

If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.

TypeDef::asScalar() — Method in class TypeDef

If kind is SCALAR, the scalar-specific type definition. If kind is not SCALAR, this will be null.

Workspace::address() — Method in class Workspace

Canonical Dagger address of the workspace directory.

B

Binding — Class in namespace DaggerBindingId — Class in namespace Dagger

The BindingID scalar type represents an identifier for an object of type Binding.

BuildArg — Class in namespace Dagger

Key value object that represents a build argument.

Changeset::before() — Method in class Changeset

The older/lower snapshot to compare against.

GitRepository::branch() — Method in class GitRepository

Returns details of a branch.

GitRepository::branches() — Method in class GitRepository

branches that match any of the given glob patterns.

LLM::bindResult() — Method in class LLM

returns the type of the current state

ModuleSource::blueprint() — Method in class ModuleSource

The blueprint referenced by the module source.

C

Address::container() — Method in class Address

Load a container from the address.

CacheVolume — Class in namespace Dagger

A directory whose contents persist across runs.

CacheVolumeId — Class in namespace Dagger

The CacheVolumeID scalar type represents an identifier for an object of type CacheVolume.

Changeset — Class in namespace Dagger

A comparison between two directories representing changes that can be applied.

ChangesetDiffStatEntry — Class in namespace DaggerChangesetDiffStatEntryId — Class in namespace Dagger

The ChangesetDiffStatEntryID scalar type represents an identifier for an object of type ChangesetDiffStatEntry.

ChangesetId — Class in namespace Dagger

The ChangesetID scalar type represents an identifier for an object of type Changeset.

Check — Class in namespace DaggerCheck::completed() — Method in class Check

Whether the check completed

CheckGroup — Class in namespace DaggerCheckGroupId — Class in namespace Dagger

The CheckGroupID scalar type represents an identifier for an object of type CheckGroup.

CheckId — Class in namespace Dagger

The CheckID scalar type represents an identifier for an object of type Check.

Client — Class in namespace Dagger

The root of the DAG.

Client::cacheVolume() — Method in class Client

Constructs a cache volume for a given cache key.

Client::changeset() — Method in class Client

Creates an empty changeset

Client::cloud() — Method in class Client

Dagger Cloud configuration and state

Client::codegen() — Method in class ClientClient::codegenBase() — Method in class ClientClient::container() — Method in class Client

Creates a scratch container, with no image or metadata.

Client::currentEnv() — Method in class Client

Returns the current environment

Client::currentFunctionCall() — Method in class Client

The FunctionCall context that the SDK caller is currently executing in.

Client::currentModule() — Method in class Client

The module currently being served in the session, if any.

Client::currentTypeDefs() — Method in class Client

The TypeDef representations of the objects currently being served in the session.

Client::currentWorkspace() — Method in class Client

Detect and return the current workspace.

$AbstractClient#client — Property in class AbstractClientCloud — Class in namespace Dagger

Dagger Cloud configuration and state

CloudId — Class in namespace Dagger

The CloudID scalar type represents an identifier for an object of type Cloud.

Connection — Class in namespace Dagger$Connection#client — Property in class ConnectionConnection::createGraphQlClient() — Method in class ConnectionConnection::connect() — Method in class ConnectionConnection::close() — Method in class ConnectionContainer — Class in namespace Dagger

An OCI-compatible container, also known as a Docker container.

Container::combinedOutput() — Method in class Container

The combined buffered standard output and standard error stream of the last executed command

ContainerId — Class in namespace Dagger

The ContainerID scalar type represents an identifier for an object of type Container.

CurrentModule — Class in namespace Dagger

Reflective module API provided to functions at runtime.

CurrentModuleId — Class in namespace Dagger

The CurrentModuleID scalar type represents an identifier for an object of type CurrentModule.

Dagger::connect() — Method in class DaggerDirectory::changes() — Method in class Directory

Return the difference between this directory and another directory, typically an older snapshot.

Directory::chown() — Method in class Directory

Change the owner of the directory contents recursively.

Engine::clients() — Method in class Engine

The list of connected client IDs

EngineCacheEntry::createdTimeUnixNano() — Method in class EngineCacheEntry

The time the cache entry was created, in Unix nanoseconds.

Env::check() — Method in class Env

Return the check with the given name from the installed modules. Must match exactly one check.

Env::checks() — Method in class Env

Return all checks defined by the installed modules

File::chown() — Method in class File

Change the owner of the file recursively.

File::contents() — Method in class File

Retrieves the contents of the file.

GeneratedCode::code() — Method in class GeneratedCode

The directory containing the generated code.

Generator::changes() — Method in class Generator

The generated changeset from the last run

Generator::completed() — Method in class Generator

Whether the generator complete

GeneratorGroup::changes() — Method in class GeneratorGroup

The combined changes from the last run of the generators

GitRef::commit() — Method in class GitRef

The resolved commit id at this ref.

GitRef::commonAncestor() — Method in class GitRef

Find the best common ancestor between this ref and another ref.

GitRepository::commit() — Method in class GitRepository

Returns details of a commit.

Host::containerImage() — Method in class Host

Accesses a container image on the host.

JsonValue::contents() — Method in class JsonValue

Return the value encoded as json

LLMTokenUsage::cachedTokenReads() — Method in class LLMTokenUsageLLMTokenUsage::cachedTokenWrites() — Method in class LLMTokenUsageModule::check() — Method in class Module

Return the check defined by the module with the given name. Must match to exactly one check.

Module::checks() — Method in class Module

Return all checks defined by the module

ModuleSource::cloneRef() — Method in class ModuleSource

The ref to clone the root of the git repo from. Only valid for git sources.

ModuleSource::commit() — Method in class ModuleSource

The resolved commit of the git repo this source points to.

ModuleSource::configClients() — Method in class ModuleSource

The clients generated for the module.

ModuleSource::configExists() — Method in class ModuleSource

Whether an existing dagger.json for the module was found.

ModuleSource::contextDirectory() — Method in class ModuleSource

The full directory loaded for the module source, including the source code as a subdirectory.

ObjectTypeDef::constructor() — Method in class ObjectTypeDef

The function used to construct new instances of this object, if any

PhpSdk::codegen() — Method in class PhpSdkPhpSdk::codegenBase() — Method in class PhpSdkSourceMap::column() — Method in class SourceMap

The column number within the line.

Workspace::checks() — Method in class Workspace

Return all checks from modules loaded in the workspace.

Workspace::clientId() — Method in class Workspace

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

Workspace::configPath() — Method in class Workspace

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

D

Address::directory() — Method in class Address

Load a directory from the address.

DaggerFunction — Class in namespace Dagger\AttributeDaggerObject — Class in namespace Dagger\AttributeDefaultPath — Class in namespace Dagger\AttributeDoc — Class in namespace Dagger\AttributeBinding::digest() — Method in class Binding

Returns the digest of the binding value

Changeset::diffStats() — Method in class Changeset

Structured per-path diff statistics (kind and line counts) for this changeset.

Check::description() — Method in class Check

The description of the check

Client::defaultPlatform() — Method in class Client

The default platform of the engine.

Client::directory() — Method in class Client

Creates an empty directory.

Container::defaultArgs() — Method in class Container

Return the container's default arguments.

Container::directory() — Method in class Container

Retrieve a directory from the container's root filesystem

Container::dockerHealthcheck() — Method in class Container

Retrieves this container's configured docker healthcheck.

CurrentModule::dependencies() — Method in class CurrentModule

The dependencies of the module.

Dagger — Class in namespace DaggerDiffStat — Class in namespace DaggerDiffStatId — Class in namespace Dagger

The DiffStatID scalar type represents an identifier for an object of type DiffStat.

Directory — Class in namespace Dagger

A directory.

Directory::diff() — Method in class Directory

Return the difference between this directory and an another directory. The difference is encoded as a directory.

Directory::digest() — Method in class Directory

Return the directory's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.

Directory::directory() — Method in class Directory

Retrieves a directory at the given path.

Directory::dockerBuild() — Method in class Directory

Use Dockerfile compatibility to build a container from this directory. Only use this function for Dockerfile compatibility. Otherwise use the native Container type directly, it is feature-complete and supports all Dockerfile features.

DirectoryId — Class in namespace Dagger

The DirectoryID scalar type represents an identifier for an object of type Directory.

EngineCacheEntry::description() — Method in class EngineCacheEntry

The description of the cache entry.

EngineCacheEntry::diskSpaceBytes() — Method in class EngineCacheEntry

The disk space used by the cache entry.

EngineCacheEntrySet::diskSpaceBytes() — Method in class EngineCacheEntrySet

The total disk space used by the cache entries in this set.

EnumTypeDef::description() — Method in class EnumTypeDef

A doc string for the enum, if any.

EnumValueTypeDef::deprecated() — Method in class EnumValueTypeDef

The reason this enum member is deprecated, if any.

EnumValueTypeDef::description() — Method in class EnumValueTypeDef

A doc string for the enum member, if any.

FieldTypeDef::deprecated() — Method in class FieldTypeDef

The reason this enum member is deprecated, if any.

FieldTypeDef::description() — Method in class FieldTypeDef

A doc string for the field, if any.

File::digest() — Method in class File

Return the file's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.

FunctionArg::defaultAddress() — Method in class FunctionArg

Only applies to arguments of type Container. If the argument is not set, load it from the given address (e.g. alpine:latest)

FunctionArg::defaultPath() — Method in class FunctionArg

Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory

FunctionArg::defaultValue() — Method in class FunctionArg

A default value to use for this argument when not explicitly set by the caller, if any.

FunctionArg::deprecated() — Method in class FunctionArg

The reason this function is deprecated, if any.

FunctionArg::description() — Method in class FunctionArg

A doc string for the argument, if any.

Function_::deprecated() — Method in class Function_

The reason this function is deprecated, if any.

Function_::description() — Method in class Function_

A doc string for the function, if any.

Generator::description() — Method in class Generator

Return the description of the generator

Host::directory() — Method in class Host

Accesses a directory on the host.

InterfaceTypeDef::description() — Method in class InterfaceTypeDef

The doc string for the interface, if any.

Module::dependencies() — Method in class Module

The dependencies of the module.

Module::description() — Method in class Module

The doc string of the module, if any

ModuleConfigClient::directory() — Method in class ModuleConfigClient

The directory the client is generated in.

ModuleSource::dependencies() — Method in class ModuleSource

The dependencies of the module source.

ModuleSource::digest() — Method in class ModuleSource

A content-hash of the module source. Module sources with the same digest will output the same generated context and convert into the same module instance.

ModuleSource::directory() — Method in class ModuleSource

The directory containing the module configuration and source code (source code may be in a subdir).

ObjectTypeDef::deprecated() — Method in class ObjectTypeDef

The reason this enum member is deprecated, if any.

ObjectTypeDef::description() — Method in class ObjectTypeDef

The doc string for the object, if any.

Port::description() — Method in class Port

The port description.

SDKConfig::debug() — Method in class SDKConfig

Whether to start the SDK runtime in debug mode with an interactive terminal.

ScalarTypeDef::description() — Method in class ScalarTypeDef

A doc string for the scalar, if any.

Up::description() — Method in class Up

The description of the service

Workspace::directory() — Method in class Workspace

Returns a Directory from the workspace.

E

Changeset::export() — Method in class Changeset

Applies the diff represented by this changeset to a path on the host.

Check::error() — Method in class Check

If the check failed, this is the error

Client::engine() — Method in class Client

The Dagger engine container configuration and state

Client::env() — Method in class Client

Initializes a new environment

Client::envFile() — Method in class Client

Initialize an environment file

Client::error() — Method in class Client

Create a new error.

Container::entrypoint() — Method in class Container

Return the container's OCI entrypoint.

Container::envVariable() — Method in class Container

Retrieves the value of the specified environment variable.

Container::envVariables() — Method in class Container

Retrieves the list of environment variables passed to commands.

Container::exists() — Method in class Container

check if a file or directory exists

Container::exitCode() — Method in class Container

The exit code of the last executed command

Container::experimentalWithAllGPUs() — Method in class Container

EXPERIMENTAL API! Subject to change/removal at any time.

Container::experimentalWithGPU() — Method in class Container

EXPERIMENTAL API! Subject to change/removal at any time.

Container::export() — Method in class Container

Writes the container as an OCI tarball to the destination file path on the host.

Container::exportImage() — Method in class Container

Exports the container as an image to the host's container image store.

Container::exposedPorts() — Method in class Container

Retrieves the list of exposed ports.

Directory::entries() — Method in class Directory

Returns a list of files and directories at the given path.

Directory::exists() — Method in class Directory

check if a file or directory exists

Directory::export() — Method in class Directory

Writes the contents of the directory to a path on the host.

Engine — Class in namespace Dagger

The Dagger engine configuration and state

EngineCache — Class in namespace Dagger

A cache storage for the Dagger engine

EngineCache::entrySet() — Method in class EngineCache

The current set of entries in the cache

EngineCacheEntry — Class in namespace Dagger

An individual cache entry in a cache entry set

EngineCacheEntryId — Class in namespace Dagger

The EngineCacheEntryID scalar type represents an identifier for an object of type EngineCacheEntry.

EngineCacheEntrySet — Class in namespace Dagger

A set of cache entries returned by a query to a cache

EngineCacheEntrySet::entries() — Method in class EngineCacheEntrySet

The list of individual cache entries in the set

EngineCacheEntrySet::entryCount() — Method in class EngineCacheEntrySet

The number of cache entries in this set.

EngineCacheEntrySetId — Class in namespace Dagger

The EngineCacheEntrySetID scalar type represents an identifier for an object of type EngineCacheEntrySet.

EngineCacheId — Class in namespace Dagger

The EngineCacheID scalar type represents an identifier for an object of type EngineCache.

EngineId — Class in namespace Dagger

The EngineID scalar type represents an identifier for an object of type Engine.

EnumTypeDef — Class in namespace Dagger

A definition of a custom enum defined in a Module.

EnumTypeDefId — Class in namespace Dagger

The EnumTypeDefID scalar type represents an identifier for an object of type EnumTypeDef.

EnumValueTypeDef — Class in namespace Dagger

A definition of a value in a custom enum defined in a Module.

EnumValueTypeDefId — Class in namespace Dagger

The EnumValueTypeDefID scalar type represents an identifier for an object of type EnumValueTypeDef.

Env — Class in namespace DaggerEnvFile — Class in namespace Dagger

A collection of environment variables.

EnvFile::exists() — Method in class EnvFile

Check if a variable exists

EnvFileId — Class in namespace Dagger

The EnvFileID scalar type represents an identifier for an object of type EnvFile.

EnvId — Class in namespace Dagger

The EnvID scalar type represents an identifier for an object of type Env.

EnvVariable — Class in namespace Dagger

An environment variable name and value.

EnvVariableId — Class in namespace Dagger

The EnvVariableID scalar type represents an identifier for an object of type EnvVariable.

Error — Class in namespace DaggerErrorId — Class in namespace Dagger

The ErrorID scalar type represents an identifier for an object of type Error.

ErrorValue — Class in namespace DaggerErrorValueId — Class in namespace Dagger

The ErrorValueID scalar type represents an identifier for an object of type ErrorValue.

File::export() — Method in class File

Writes the file to a file path on the host.

LLM::env() — Method in class LLM

return the LLM's current environment

ListTypeDef::elementTypeDef() — Method in class ListTypeDef

The type of the elements in the list.

Module::enums() — Method in class Module

Enumerations served by this module.

ModuleSource::engineVersion() — Method in class ModuleSource

The engine version of the module.

Port::experimentalSkipHealthcheck() — Method in class Port

Skip the health check when run as a service.

SearchSubmatch::end() — Method in class SearchSubmatch

The match's end offset within the matched lines.

Service::endpoint() — Method in class Service

Retrieves an endpoint that clients can use to reach this container.

F

Address::file() — Method in class Address

Load a file from the address.

Client::file() — Method in class Client

Creates a file with the specified contents.

Client::function() — Method in class Client

Creates a function.

AbstractScalar::from() — Method in class AbstractScalarContainer::file() — Method in class Container

Retrieves a file at the given path.

Container::from() — Method in class Container

Download a container image, and apply it to the container state. All previous state will be lost.

Directory::file() — Method in class Directory

Retrieve a file at the given path.

Directory::filter() — Method in class Directory

Return a snapshot with some paths included or excluded

Directory::findUp() — Method in class Directory

Search up the directory tree for a file or directory, and return its path. If no match, return null

FieldTypeDef — Class in namespace Dagger

A definition of a field on a custom object defined in a Module.

FieldTypeDefId — Class in namespace Dagger

The FieldTypeDefID scalar type represents an identifier for an object of type FieldTypeDef.

File — Class in namespace Dagger

A file.

FileId — Class in namespace Dagger

The FileID scalar type represents an identifier for an object of type File.

FunctionArg — Class in namespace Dagger

An argument accepted by a function.

FunctionArgId — Class in namespace Dagger

The FunctionArgID scalar type represents an identifier for an object of type FunctionArg.

FunctionCall — Class in namespace Dagger

An active function call.

FunctionCallArgValue — Class in namespace Dagger

A value passed as a named argument to a function call.

FunctionCallArgValueId — Class in namespace Dagger

The FunctionCallArgValueID scalar type represents an identifier for an object of type FunctionCallArgValue.

FunctionCallId — Class in namespace Dagger

The FunctionCallID scalar type represents an identifier for an object of type FunctionCall.

FunctionId — Class in namespace Dagger

The FunctionID scalar type represents an identifier for an object of type Function.

Function_ — Class in namespace Dagger

Function represents a resolver provided by a Module.

Host::file() — Method in class Host

Accesses a file on the host.

Host::findUp() — Method in class Host

Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null

InputTypeDef::fields() — Method in class InputTypeDef

Static fields defined on this input object, if any.

InterfaceTypeDef::functions() — Method in class InterfaceTypeDef

Functions defined on this interface, if any.

JsonValue::field() — Method in class JsonValue

Lookup the field at the given path, and return its value.

JsonValue::fields() — Method in class JsonValue

List fields of the encoded object

ObjectTypeDef::fields() — Method in class ObjectTypeDef

Static fields defined on this object, if any.

ObjectTypeDef::functions() — Method in class ObjectTypeDef

Functions defined on this object, if any.

SearchResult::filePath() — Method in class SearchResult

The path to the file that matched.

SourceMap::filename() — Method in class SourceMap

The filename from the module source.

Stat::fileType() — Method in class Stat

file type

Workspace::file() — Method in class Workspace

Returns a File from the workspace.

Workspace::findUp() — Method in class Workspace

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

G

Address::gitRef() — Method in class Address

Load a git ref (branch, tag or commit) from the address.

Address::gitRepository() — Method in class Address

Load a git repository from the address.

Client::generatedCode() — Method in class Client

Create a code generation result, given a directory containing the generated code.

Client::git() — Method in class Client

Queries a Git repository.

$AbstractClient#graphQlClient — Property in class AbstractClientAbstractScalar::getValue() — Method in class AbstractScalarConnection::get() — Method in class ConnectionCurrentModule::generatedContextDirectory() — Method in class CurrentModule

The generated files and directories made on top of the module source's context directory.

CurrentModule::generators() — Method in class CurrentModule

Return all generators defined by the module

Dagger::getClientInstance() — Method in class DaggerDirectory::glob() — Method in class Directory

Returns a list of files and directories that matche the given pattern.

EnvFile::get() — Method in class EnvFile

Lookup a variable (last occurrence wins) and return its value, or an empty string

GeneratedCode — Class in namespace Dagger

The result of running an SDK's codegen.

GeneratedCodeId — Class in namespace Dagger

The GeneratedCodeID scalar type represents an identifier for an object of type GeneratedCode.

Generator — Class in namespace DaggerGeneratorGroup — Class in namespace DaggerGeneratorGroupId — Class in namespace Dagger

The GeneratorGroupID scalar type represents an identifier for an object of type GeneratorGroup.

GeneratorId — Class in namespace Dagger

The GeneratorID scalar type represents an identifier for an object of type Generator.

GitRef — Class in namespace Dagger

A git ref (tag, branch, or commit).

GitRefId — Class in namespace Dagger

The GitRefID scalar type represents an identifier for an object of type GitRef.

GitRepository — Class in namespace Dagger

A git repository.

GitRepositoryId — Class in namespace Dagger

The GitRepositoryID scalar type represents an identifier for an object of type GitRepository.

Module::generatedContextDirectory() — Method in class Module

The generated files and directories made on top of the module source's context directory.

Module::generator() — Method in class Module

Return the generator defined by the module with the given name. Must match to exactly one generator.

Module::generators() — Method in class Module

Return all generators defined by the module

ModuleConfigClient::generator() — Method in class ModuleConfigClient

The generator to use

ModuleSource::generatedContextChangeset() — Method in class ModuleSource

The generated files and directories made on top of the module source's context directory, returned as a Changeset.

ModuleSource::generatedContextDirectory() — Method in class ModuleSource

The generated files and directories made on top of the module source's context directory.

Workspace::generators() — Method in class Workspace

Return all generators from modules loaded in the workspace.

H

Client::host() — Method in class Client

Queries the host environment.

Client::http() — Method in class Client

Returns a file containing an http remote url content.

GitRepository::head() — Method in class GitRepository

Returns details for HEAD.

HealthcheckConfig — Class in namespace Dagger

Image healthcheck configuration.

HealthcheckConfigId — Class in namespace Dagger

The HealthcheckConfigID scalar type represents an identifier for an object of type HealthcheckConfig.

Host — Class in namespace Dagger

Information about the host environment.

HostId — Class in namespace Dagger

The HostID scalar type represents an identifier for an object of type Host.

LLM::hasPrompt() — Method in class LLM

Indicates whether there are any queued prompts or tool results to send to the model

LLM::history() — Method in class LLM

return the llm message history

LLM::historyJSON() — Method in class LLM

return the raw llm message history as json

ModuleSource::htmlRepoURL() — Method in class ModuleSource

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket).

ModuleSource::htmlURL() — Method in class ModuleSource

The URL to the source's git repo in a web browser. Only valid for git sources.

Service::hostname() — Method in class Service

Retrieves a hostname which can be used by clients to reach this container.

Workspace::hasConfig() — Method in class Workspace

Whether a config.toml file exists in the workspace.

I

Address::id() — Method in class Address

A unique identifier for this Address.

Ignore — Class in namespace Dagger\Attribute$Ignore#ignore — Property in class IgnoreBinding::id() — Method in class Binding

A unique identifier for this Binding.

Binding::isNull() — Method in class Binding

Returns true if the binding is null

CacheVolume::id() — Method in class CacheVolume

A unique identifier for this CacheVolume.

Changeset::id() — Method in class Changeset

A unique identifier for this Changeset.

Changeset::isEmpty() — Method in class Changeset

Returns true if the changeset is empty (i.e. there are no changes).

ChangesetDiffStatEntry::id() — Method in class ChangesetDiffStatEntry

A unique identifier for this ChangesetDiffStatEntry.

Check::id() — Method in class Check

A unique identifier for this Check.

CheckGroup::id() — Method in class CheckGroup

A unique identifier for this CheckGroup.

Client::id() — Method in class Client

A unique identifier for this Query.

IdAble — Class in namespace Dagger\ClientIdAble::id() — Method in class IdAbleCloud::id() — Method in class Cloud

A unique identifier for this Cloud.

Container::id() — Method in class Container

A unique identifier for this Container.

Container::imageRef() — Method in class Container

The unique image reference which can only be retrieved immediately after the 'Container.From' call.

Container::import() — Method in class Container

Reads the container from an OCI tarball.

CurrentModule::id() — Method in class CurrentModule

A unique identifier for this CurrentModule.

DiffStat::id() — Method in class DiffStat

A unique identifier for this DiffStat.

Directory::id() — Method in class Directory

A unique identifier for this Directory.

Engine::id() — Method in class Engine

A unique identifier for this Engine.

EngineCache::id() — Method in class EngineCache

A unique identifier for this EngineCache.

EngineCacheEntry::id() — Method in class EngineCacheEntry

A unique identifier for this EngineCacheEntry.

EngineCacheEntrySet::id() — Method in class EngineCacheEntrySet

A unique identifier for this EngineCacheEntrySet.

EnumTypeDef::id() — Method in class EnumTypeDef

A unique identifier for this EnumTypeDef.

EnumValueTypeDef::id() — Method in class EnumValueTypeDef

A unique identifier for this EnumValueTypeDef.

Env::id() — Method in class Env

A unique identifier for this Env.

Env::input() — Method in class Env

Retrieves an input binding by name

Env::inputs() — Method in class Env

Returns all input bindings provided to the environment

EnvFile::id() — Method in class EnvFile

A unique identifier for this EnvFile.

EnvVariable::id() — Method in class EnvVariable

A unique identifier for this EnvVariable.

Error::id() — Method in class Error

A unique identifier for this Error.

ErrorValue::id() — Method in class ErrorValue

A unique identifier for this ErrorValue.

FieldTypeDef::id() — Method in class FieldTypeDef

A unique identifier for this FieldTypeDef.

File::id() — Method in class File

A unique identifier for this File.

FunctionArg::id() — Method in class FunctionArg

A unique identifier for this FunctionArg.

FunctionArg::ignore() — Method in class FunctionArg

Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.

FunctionCall::id() — Method in class FunctionCall

A unique identifier for this FunctionCall.

FunctionCall::inputArgs() — Method in class FunctionCall

The argument values the function is being invoked with.

FunctionCallArgValue::id() — Method in class FunctionCallArgValue

A unique identifier for this FunctionCallArgValue.

Function_::id() — Method in class Function_

A unique identifier for this Function.

GeneratedCode::id() — Method in class GeneratedCode

A unique identifier for this GeneratedCode.

Generator::id() — Method in class Generator

A unique identifier for this Generator.

Generator::isEmpty() — Method in class Generator

Whether changeset from the last generator run is empty or not

GeneratorGroup::id() — Method in class GeneratorGroup

A unique identifier for this GeneratorGroup.

GeneratorGroup::isEmpty() — Method in class GeneratorGroup

Whether the generated changeset from the last run is empty or not

GitRef::id() — Method in class GitRef

A unique identifier for this GitRef.

GitRepository::id() — Method in class GitRepository

A unique identifier for this GitRepository.

HealthcheckConfig::id() — Method in class HealthcheckConfig

A unique identifier for this HealthcheckConfig.

HealthcheckConfig::interval() — Method in class HealthcheckConfig

Interval between running healthcheck. Example:30s

Host::id() — Method in class Host

A unique identifier for this Host.

InputTypeDef — Class in namespace Dagger

A graphql input type, which is essentially just a group of named args.

InputTypeDef::id() — Method in class InputTypeDef

A unique identifier for this InputTypeDef.

InputTypeDefId — Class in namespace Dagger

The InputTypeDefID scalar type represents an identifier for an object of type InputTypeDef.

InterfaceTypeDef — Class in namespace Dagger

A definition of a custom interface defined in a Module.

InterfaceTypeDef::id() — Method in class InterfaceTypeDef

A unique identifier for this InterfaceTypeDef.

InterfaceTypeDefId — Class in namespace Dagger

The InterfaceTypeDefID scalar type represents an identifier for an object of type InterfaceTypeDef.

JsonValue::id() — Method in class JsonValue

A unique identifier for this JSONValue.

LLM::id() — Method in class LLM

A unique identifier for this LLM.

LLMTokenUsage::id() — Method in class LLMTokenUsage

A unique identifier for this LLMTokenUsage.

LLMTokenUsage::inputTokens() — Method in class LLMTokenUsageLabel::id() — Method in class Label

A unique identifier for this Label.

ListTypeDef::id() — Method in class ListTypeDef

A unique identifier for this ListTypeDef.

Module::id() — Method in class Module

A unique identifier for this Module.

Module::interfaces() — Method in class Module

Interfaces served by this module.

Module::introspectionSchemaJSON() — Method in class Module

The introspection schema JSON file for this module.

ModuleConfigClient::id() — Method in class ModuleConfigClient

A unique identifier for this ModuleConfigClient.

ModuleSource::id() — Method in class ModuleSource

A unique identifier for this ModuleSource.

ModuleSource::introspectionSchemaJSON() — Method in class ModuleSource

The introspection schema JSON file for this module source.

ObjectTypeDef::id() — Method in class ObjectTypeDef

A unique identifier for this ObjectTypeDef.

PhpSdk::id() — Method in class PhpSdk

A unique identifier for this PhpSdk.

Port::id() — Method in class Port

A unique identifier for this Port.

SDKConfig::id() — Method in class SDKConfig

A unique identifier for this SDKConfig.

ScalarTypeDef::id() — Method in class ScalarTypeDef

A unique identifier for this ScalarTypeDef.

SearchResult::id() — Method in class SearchResult

A unique identifier for this SearchResult.

SearchSubmatch::id() — Method in class SearchSubmatch

A unique identifier for this SearchSubmatch.

Secret::id() — Method in class Secret

A unique identifier for this Secret.

Service::id() — Method in class Service

A unique identifier for this Service.

Socket::id() — Method in class Socket

A unique identifier for this Socket.

SourceMap::id() — Method in class SourceMap

A unique identifier for this SourceMap.

Stat::id() — Method in class Stat

A unique identifier for this Stat.

Terminal::id() — Method in class Terminal

A unique identifier for this Terminal.

TypeDef::id() — Method in class TypeDef

A unique identifier for this TypeDef.

Up::id() — Method in class Up

A unique identifier for this Up.

UpGroup::id() — Method in class UpGroup

A unique identifier for this UpGroup.

Workspace::id() — Method in class Workspace

A unique identifier for this Workspace.

Workspace::initialized() — Method in class Workspace

Whether .dagger/config.toml exists.

J

Client::json() — Method in class Client

Initialize a JSON value

Json — Class in namespace Dagger

An arbitrary JSON-encoded value.

JsonValue — Class in namespace DaggerJsonValueId — Class in namespace Dagger

The JSONValueID scalar type represents an identifier for an object of type JSONValue.

K

ChangesetDiffStatEntry::kind() — Method in class ChangesetDiffStatEntry

Type of change.

DiffStat::kind() — Method in class DiffStat

Type of change.

ModuleSource::kind() — Method in class ModuleSource

The kind of module source (currently local, git or dir).

TypeDef::kind() — Method in class TypeDef

The kind of type this is (e.g. primitive, list, object).

L

ListOfType — Class in namespace Dagger\AttributeChangeset::layer() — Method in class Changeset

Return a snapshot containing only the created and modified files

CheckGroup::list() — Method in class CheckGroup

Return a list of individual checks and their details

Client::llm() — Method in class Client

Initialize a Large Language Model (LLM)

Client::loadAddressFromID() — Method in class Client

Load a Address from its ID.

Client::loadBindingFromID() — Method in class Client

Load a Binding from its ID.

Client::loadCacheVolumeFromID() — Method in class Client

Load a CacheVolume from its ID.

Client::loadChangesetFromID() — Method in class Client

Load a Changeset from its ID.

Client::loadCheckFromID() — Method in class Client

Load a Check from its ID.

Client::loadCheckGroupFromID() — Method in class Client

Load a CheckGroup from its ID.

Client::loadCloudFromID() — Method in class Client

Load a Cloud from its ID.

Client::loadContainerFromID() — Method in class Client

Load a Container from its ID.

Client::loadCurrentModuleFromID() — Method in class Client

Load a CurrentModule from its ID.

Client::loadDiffStatFromID() — Method in class Client

Load a DiffStat from its ID.

Client::loadDirectoryFromID() — Method in class Client

Load a Directory from its ID.

Client::loadEngineCacheEntryFromID() — Method in class Client

Load a EngineCacheEntry from its ID.

Client::loadEngineCacheEntrySetFromID() — Method in class Client

Load a EngineCacheEntrySet from its ID.

Client::loadEngineCacheFromID() — Method in class Client

Load a EngineCache from its ID.

Client::loadEngineFromID() — Method in class Client

Load a Engine from its ID.

Client::loadEnumTypeDefFromID() — Method in class Client

Load a EnumTypeDef from its ID.

Client::loadEnumValueTypeDefFromID() — Method in class Client

Load a EnumValueTypeDef from its ID.

Client::loadEnvFileFromID() — Method in class Client

Load a EnvFile from its ID.

Client::loadEnvFromID() — Method in class Client

Load a Env from its ID.

Client::loadEnvVariableFromID() — Method in class Client

Load a EnvVariable from its ID.

Client::loadErrorFromID() — Method in class Client

Load a Error from its ID.

Client::loadErrorValueFromID() — Method in class Client

Load a ErrorValue from its ID.

Client::loadFieldTypeDefFromID() — Method in class Client

Load a FieldTypeDef from its ID.

Client::loadFileFromID() — Method in class Client

Load a File from its ID.

Client::loadFunctionArgFromID() — Method in class Client

Load a FunctionArg from its ID.

Client::loadFunctionCallArgValueFromID() — Method in class Client

Load a FunctionCallArgValue from its ID.

Client::loadFunctionCallFromID() — Method in class Client

Load a FunctionCall from its ID.

Client::loadFunctionFromID() — Method in class Client

Load a Function from its ID.

Client::loadGeneratedCodeFromID() — Method in class Client

Load a GeneratedCode from its ID.

Client::loadGeneratorFromID() — Method in class Client

Load a Generator from its ID.

Client::loadGeneratorGroupFromID() — Method in class Client

Load a GeneratorGroup from its ID.

Client::loadGitRefFromID() — Method in class Client

Load a GitRef from its ID.

Client::loadGitRepositoryFromID() — Method in class Client

Load a GitRepository from its ID.

Client::loadHealthcheckConfigFromID() — Method in class Client

Load a HealthcheckConfig from its ID.

Client::loadHostFromID() — Method in class Client

Load a Host from its ID.

Client::loadInputTypeDefFromID() — Method in class Client

Load a InputTypeDef from its ID.

Client::loadInterfaceTypeDefFromID() — Method in class Client

Load a InterfaceTypeDef from its ID.

Client::loadJSONValueFromID() — Method in class Client

Load a JSONValue from its ID.

Client::loadLLMFromID() — Method in class Client

Load a LLM from its ID.

Client::loadLLMTokenUsageFromID() — Method in class Client

Load a LLMTokenUsage from its ID.

Client::loadLabelFromID() — Method in class Client

Load a Label from its ID.

Client::loadListTypeDefFromID() — Method in class Client

Load a ListTypeDef from its ID.

Client::loadModuleConfigClientFromID() — Method in class Client

Load a ModuleConfigClient from its ID.

Client::loadModuleFromID() — Method in class Client

Load a Module from its ID.

Client::loadModuleSourceFromID() — Method in class Client

Load a ModuleSource from its ID.

Client::loadObjectTypeDefFromID() — Method in class Client

Load a ObjectTypeDef from its ID.

Client::loadPhpSdkFromID() — Method in class Client

Load a PhpSdk from its ID.

Client::loadPortFromID() — Method in class Client

Load a Port from its ID.

Client::loadQueryFromID() — Method in class Client

Load a Query from its ID.

Client::loadSDKConfigFromID() — Method in class Client

Load a SDKConfig from its ID.

Client::loadScalarTypeDefFromID() — Method in class Client

Load a ScalarTypeDef from its ID.

Client::loadSearchResultFromID() — Method in class Client

Load a SearchResult from its ID.

Client::loadSearchSubmatchFromID() — Method in class Client

Load a SearchSubmatch from its ID.

Client::loadSecretFromID() — Method in class Client

Load a Secret from its ID.

Client::loadServiceFromID() — Method in class Client

Load a Service from its ID.

Client::loadSocketFromID() — Method in class Client

Load a Socket from its ID.

Client::loadSourceMapFromID() — Method in class Client

Load a SourceMap from its ID.

Client::loadStatFromID() — Method in class Client

Load a Stat from its ID.

Client::loadTerminalFromID() — Method in class Client

Load a Terminal from its ID.

Client::loadTypeDefFromID() — Method in class Client

Load a TypeDef from its ID.

Client::loadUpFromID() — Method in class Client

Load a Up from its ID.

Client::loadUpGroupFromID() — Method in class Client

Load a UpGroup from its ID.

Client::loadWorkspaceFromID() — Method in class Client

Load a Workspace from its ID.

$AbstractObject#lastQuery — Property in class AbstractObjectContainer::label() — Method in class Container

Retrieves the value of the specified label.

Container::labels() — Method in class Container

Retrieves the list of labels passed to container.

Engine::localCache() — Method in class Engine

The local (on-disk) cache for the Dagger engine

GeneratorGroup::list() — Method in class GeneratorGroup

Return a list of individual generators and their details

GitRepository::latestVersion() — Method in class GitRepository

Returns details for the latest semver tag.

LLM — Class in namespace DaggerLLM::lastReply() — Method in class LLM

return the last llm reply from the history

LLM::loop() — Method in class LLM

Submit the queued prompt, evaluate any tool calls, queue their results, and keep going until the model ends its turn

LLMId — Class in namespace Dagger

The LLMID scalar type represents an identifier for an object of type LLM.

LLMTokenUsage — Class in namespace DaggerLLMTokenUsageId — Class in namespace Dagger

The LLMTokenUsageID scalar type represents an identifier for an object of type LLMTokenUsage.

Label — Class in namespace Dagger

A simple key value object that represents a label.

LabelId — Class in namespace Dagger

The LabelID scalar type represents an identifier for an object of type Label.

ListTypeDef — Class in namespace Dagger

A definition of a list type in a Module.

ListTypeDefId — Class in namespace Dagger

The ListTypeDefID scalar type represents an identifier for an object of type ListTypeDef.

ModuleSource::localContextDirectoryPath() — Method in class ModuleSource

The full absolute path to the context directory on the caller's host filesystem that this module source is loaded from. Only valid for local module sources.

SearchResult::lineNumber() — Method in class SearchResult

The first line that matched.

SourceMap::line() — Method in class SourceMap

The line number within the filename.

UpGroup::list() — Method in class UpGroup

Return a list of individual services and their details

M

Changeset::modifiedPaths() — Method in class Changeset

Files and directories that existed before and were updated in the newer directory.

Client::module() — Method in class Client

Create a new module.

Client::moduleRuntime() — Method in class ClientClient::moduleSource() — Method in class Client

Create a new module source instance from a source ref string

Container::mounts() — Method in class Container

Retrieves the list of paths where a directory is mounted.

EngineCache::maxUsedSpace() — Method in class EngineCache

The maximum bytes to keep in the cache without pruning.

EngineCache::minFreeSpace() — Method in class EngineCache

The target amount of free disk space the garbage collector will attempt to leave.

EngineCacheEntry::mostRecentUseTimeUnixNano() — Method in class EngineCacheEntry

The most recent time the cache entry was used, in Unix nanoseconds.

EnumTypeDef::members() — Method in class EnumTypeDef

The members of the enum.

Error::message() — Method in class Error

A description of the error.

LLM::model() — Method in class LLM

return the model used by the llm

Module — Class in namespace Dagger

A Dagger module.

ModuleConfigClient — Class in namespace Dagger

The client generated for the module.

ModuleConfigClientId — Class in namespace Dagger

The ModuleConfigClientID scalar type represents an identifier for an object of type ModuleConfigClient.

ModuleId — Class in namespace Dagger

The ModuleID scalar type represents an identifier for an object of type Module.

ModuleSource — Class in namespace Dagger

The source needed to load and run a module, along with any metadata about the source such as versions/urls/etc.

ModuleSource::moduleName() — Method in class ModuleSource

The name of the module, including any setting via the withName API.

ModuleSource::moduleOriginalName() — Method in class ModuleSource

The original name of the module as read from the module's dagger.json (or set for the first time with the withName API).

ModuleSourceId — Class in namespace Dagger

The ModuleSourceID scalar type represents an identifier for an object of type ModuleSource.

PhpSdk::moduleRuntime() — Method in class PhpSdkSearchResult::matchedLines() — Method in class SearchResult

The line content that matched.

SourceMap::module() — Method in class SourceMap

The module dependency this was declared in.

N

Binding::name() — Method in class Binding

Returns the binding name

Check::name() — Method in class Check

Return the fully qualified name of the check

Connection::newEnvSession() — Method in class ConnectionConnection::newProcessSession() — Method in class ConnectionCurrentModule::name() — Method in class CurrentModule

The name of the module being executed in

Directory::name() — Method in class Directory

Returns the name of the directory.

Engine::name() — Method in class Engine

The name of the engine instance.

EnumTypeDef::name() — Method in class EnumTypeDef

The name of the enum.

EnumValueTypeDef::name() — Method in class EnumValueTypeDef

The name of the enum member.

EnvFile::namespace() — Method in class EnvFile

Filters variables by prefix and removes the pref from keys. Variables without the prefix are excluded. For example, with the prefix "MY_APP_" and variables: MY_APP_TOKEN=topsecret MY_APP_NAME=hello FOO=bar the resulting environment will contain: TOKEN=topsecret NAME=hello

EnvVariable::name() — Method in class EnvVariable

The environment variable name.

ErrorValue::name() — Method in class ErrorValue

The name of the value.

FieldTypeDef::name() — Method in class FieldTypeDef

The name of the field in lowerCamelCase format.

File::name() — Method in class File

Retrieves the name of the file.

FunctionArg::name() — Method in class FunctionArg

The name of the argument in lowerCamelCase format.

FunctionCall::name() — Method in class FunctionCall

The name of the function being called.

FunctionCallArgValue::name() — Method in class FunctionCallArgValue

The name of the argument.

Function_::name() — Method in class Function_

The name of the function.

Generator::name() — Method in class Generator

Return the fully qualified name of the generator

InputTypeDef::name() — Method in class InputTypeDef

The name of the input object.

InterfaceTypeDef::name() — Method in class InterfaceTypeDef

The name of the interface.

JsonValue::newBoolean() — Method in class JsonValue

Encode a boolean to json

JsonValue::newInteger() — Method in class JsonValue

Encode an integer to json

JsonValue::newString() — Method in class JsonValue

Encode a string to json

Label::name() — Method in class Label

The label name.

Module::name() — Method in class Module

The name of the module

ObjectTypeDef::name() — Method in class ObjectTypeDef

The name of the object.

ScalarTypeDef::name() — Method in class ScalarTypeDef

The name of the scalar.

Secret::name() — Method in class Secret

The name of this secret.

Stat::name() — Method in class Stat

file name

Up::name() — Method in class Up

Return the fully qualified name of the service

O

Check::originalModule() — Method in class Check

The original module in which the check has been defined

DiffStat::oldPath() — Method in class DiffStat

Previous path of the file, set only for renames.

Env::output() — Method in class Env

Retrieves an output binding by name

Env::outputs() — Method in class Env

Returns all declared output bindings for the environment

Generator::originalModule() — Method in class Generator

The original module in which the generator has been defined

LLMTokenUsage::outputTokens() — Method in class LLMTokenUsageModule::objects() — Method in class Module

Objects served by this module.

ModuleSource::originalSubpath() — Method in class ModuleSource

The original subpath used when instantiating this module source, relative to the context directory.

ObjectTypeDef — Class in namespace Dagger

A definition of a custom object defined in a Module.

ObjectTypeDefId — Class in namespace Dagger

The ObjectTypeDefID scalar type represents an identifier for an object of type ObjectTypeDef.

TypeDef::optional() — Method in class TypeDef

Whether this type can be set to null. Defaults to false.

Up::originalModule() — Method in class Up

The original module in which the service has been defined

P

ChangesetDiffStatEntry::path() — Method in class ChangesetDiffStatEntry

Path of the changed file or directory.

Check::passed() — Method in class Check

Whether the check passed

Check::path() — Method in class Check

The path of the check within its module

Container::platform() — Method in class Container

The platform this container executes and publishes as.

Container::publish() — Method in class Container

Package the container state as an OCI image, and publish it to a registry

DiffStat::path() — Method in class DiffStat

Path of the changed file or directory.

EngineCache::prune() — Method in class EngineCache

Prune the cache of releaseable entries

FunctionCall::parent() — Method in class FunctionCall

The value of the parent object of the function being called. If the function is top-level to the module, this is always an empty object.

FunctionCall::parentName() — Method in class FunctionCall

The name of the parent object of the function being called. If the function is top-level to the module, this is the name of the module.

Generator::path() — Method in class Generator

The path of the generator within its module

LLM::provider() — Method in class LLM

return the provider used by the llm

ModuleSource::pin() — Method in class ModuleSource

The pinned version of this module source.

PhpSdk — Class in namespace DaggerPhpSdkId — Class in namespace Dagger

The PhpSdkID scalar type represents an identifier for an object of type PhpSdk.

PipelineLabel — Class in namespace Dagger

Key value object that represents a pipeline label.

Platform — Class in namespace Dagger

The platform config OS and architecture in a Container.

Port — Class in namespace Dagger

A port exposed by a container.

Port::port() — Method in class Port

The port number.

Port::protocol() — Method in class Port

The transport layer protocol.

PortForward — Class in namespace Dagger

Port forwarding rules for tunneling network traffic.

PortId — Class in namespace Dagger

The PortID scalar type represents an identifier for an object of type Port.

Secret::plaintext() — Method in class Secret

The value of this secret.

Service::ports() — Method in class Service

Retrieves the list of ports provided by the service.

Stat::permissions() — Method in class Stat

permission bits

Up::path() — Method in class Up

The path of the service within its module

Workspace::path() — Method in class Workspace

Workspace directory path relative to the workspace boundary.

Q

AbstractClient::queryLeaf() — Method in class AbstractClientAbstractObject::queryLeaf() — Method in class AbstractObjectQueryBuilder — Class in namespace Dagger\ClientQueryId — Class in namespace Dagger

The QueryID scalar type represents an identifier for an object of type Query.

R

ReturnsListOfType — Class in namespace Dagger\AttributeChangeset::removedPaths() — Method in class Changeset

Files and directories that were removed. Directories are indicated by a trailing slash, and their child paths are not included.

ChangesetDiffStatEntry::removedLines() — Method in class ChangesetDiffStatEntry

Number of removed lines for this path.

Check::resultEmoji() — Method in class Check

An emoji representing the result of the check

Check::run() — Method in class Check

Execute the check

CheckGroup::report() — Method in class CheckGroup

Generate a markdown report

CheckGroup::run() — Method in class CheckGroup

Execute all selected checks

AbstractClient::runQuery() — Method in class AbstractClientContainer::rootfs() — Method in class Container

Return a snapshot of the container's root filesystem. The snapshot can be modified then written back using withRootfs. Use that method for filesystem modifications.

DiffStat::removedLines() — Method in class DiffStat

Number of removed lines for this path.

EngineCache::reservedSpace() — Method in class EngineCache

The minimum amount of disk space this policy is guaranteed to retain.

EngineCacheEntry::recordType() — Method in class EngineCacheEntry

The type of the cache record (e.g. regular, internal, frontend, source.local, source.git.checkout, exec.cachemount).

FunctionCall::returnError() — Method in class FunctionCall

Return an error from the function.

FunctionCall::returnValue() — Method in class FunctionCall

Set the return value of the function call to the provided value.

Function_::returnType() — Method in class Function_

The type returned by the function.

Generator::run() — Method in class Generator

Execute the generator

GeneratorGroup::run() — Method in class GeneratorGroup

Execute all selected generators

GitRef::ref() — Method in class GitRef

The resolved ref name at this ref.

GitRepository::ref() — Method in class GitRepository

Returns details of a ref.

HealthcheckConfig::retries() — Method in class HealthcheckConfig

The maximum number of consecutive failures before the container is marked as unhealthy. Example:3

Module::runtime() — Method in class Module

The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.

ModuleSource::repoRootPath() — Method in class ModuleSource

The import path corresponding to the root of the git repo this source points to. Only valid for git sources.

Up::run() — Method in class Up

Execute the service function

UpGroup::run() — Method in class UpGroup

Execute all selected service functions

S

Address::secret() — Method in class Address

Load a secret from the address.

Address::service() — Method in class Address

Load a service from the address.

Address::socket() — Method in class Address

Load a local socket from the address.

Changeset::sync() — Method in class Changeset

Force evaluation in the engine.

Client::secret() — Method in class Client

Creates a new secret.

Client::setSecret() — Method in class Client

Sets a secret given a user defined name to its plaintext and returns the secret.

Client::sourceDir() — Method in class ClientClient::sourceMap() — Method in class Client

Creates source map metadata.

QueryBuilder::setArgument() — Method in class QueryBuilderContainer::stat() — Method in class Container

Return file status

Container::stderr() — Method in class Container

The buffered standard error stream of the last executed command

Container::stdout() — Method in class Container

The buffered standard output stream of the last executed command

Container::sync() — Method in class Container

Forces evaluation of the pipeline in the engine.

CurrentModule::source() — Method in class CurrentModule

The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).

Directory::search() — Method in class Directory

Searches for content matching the given regular expression or literal string.

Directory::stat() — Method in class Directory

Return file status

Directory::sync() — Method in class Directory

Force evaluation in the engine.

EnumTypeDef::sourceMap() — Method in class EnumTypeDef

The location of this enum declaration.

EnumTypeDef::sourceModuleName() — Method in class EnumTypeDef

If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.

EnumValueTypeDef::sourceMap() — Method in class EnumValueTypeDef

The location of this enum member declaration.

Env::services() — Method in class Env

Return all services defined by the installed modules

FieldTypeDef::sourceMap() — Method in class FieldTypeDef

The location of this field declaration.

File::search() — Method in class File

Searches for content matching the given regular expression or literal string.

File::size() — Method in class File

Retrieves the size of the file, in bytes.

File::stat() — Method in class File

Return file status

File::sync() — Method in class File

Force evaluation in the engine.

FunctionArg::sourceMap() — Method in class FunctionArg

The location of this arg declaration.

Function_::sourceMap() — Method in class Function_

The location of this function declaration.

Function_::sourceModuleName() — Method in class Function_

If this function is provided by a module, the name of the module. Unset otherwise.

HealthcheckConfig::shell() — Method in class HealthcheckConfig

Healthcheck command is a shell command.

HealthcheckConfig::startInterval() — Method in class HealthcheckConfig

StartInterval configures the duration between checks during the startup phase. Example:5s

HealthcheckConfig::startPeriod() — Method in class HealthcheckConfig

StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example:0s

Host::service() — Method in class Host

Creates a service that forwards traffic to a specified address via the host.

InterfaceTypeDef::sourceMap() — Method in class InterfaceTypeDef

The location of this interface declaration.

InterfaceTypeDef::sourceModuleName() — Method in class InterfaceTypeDef

If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.

LLM::step() — Method in class LLM

Submit the queued prompt or tool call results, evaluate any tool calls, and queue their results

LLM::sync() — Method in class LLM

synchronize LLM state

Module::sdk() — Method in class Module

The SDK config used by this module.

Module::serve() — Method in class Module

Serve a module's API in the current session.

Module::services() — Method in class Module

Return all services defined by the module

Module::source() — Method in class Module

The source for the module.

Module::sync() — Method in class Module

Forces evaluation of the module, including any loading into the engine and associated validation.

ModuleSource::sdk() — Method in class ModuleSource

The SDK configuration of the module.

ModuleSource::sourceRootSubpath() — Method in class ModuleSource

The path, relative to the context directory, that contains the module's dagger.json.

ModuleSource::sourceSubpath() — Method in class ModuleSource

The path to the directory containing the module's source code, relative to the context directory.

ModuleSource::sync() — Method in class ModuleSource

Forces evaluation of the module source, including any loading into the engine and associated validation.

ObjectTypeDef::sourceMap() — Method in class ObjectTypeDef

The location of this object declaration.

ObjectTypeDef::sourceModuleName() — Method in class ObjectTypeDef

If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.

PhpSdk::sourceDir() — Method in class PhpSdkSDKConfig — Class in namespace Dagger

The SDK config of the module.

SDKConfig::source() — Method in class SDKConfig

Source of the SDK. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation.

SDKConfigId — Class in namespace Dagger

The SDKConfigID scalar type represents an identifier for an object of type SDKConfig.

ScalarTypeDef — Class in namespace Dagger

A definition of a custom scalar defined in a Module.

ScalarTypeDef::sourceModuleName() — Method in class ScalarTypeDef

If this ScalarTypeDef is associated with a Module, the name of the module. Unset otherwise.

ScalarTypeDefId — Class in namespace Dagger

The ScalarTypeDefID scalar type represents an identifier for an object of type ScalarTypeDef.

SearchResult — Class in namespace DaggerSearchResult::submatches() — Method in class SearchResult

Sub-match positions and content within the matched lines.

SearchResultId — Class in namespace Dagger

The SearchResultID scalar type represents an identifier for an object of type SearchResult.

SearchSubmatch — Class in namespace DaggerSearchSubmatch::start() — Method in class SearchSubmatch

The match's start offset within the matched lines.

SearchSubmatchId — Class in namespace Dagger

The SearchSubmatchID scalar type represents an identifier for an object of type SearchSubmatch.

Secret — Class in namespace Dagger

A reference to a secret value, which can be handled more safely than the value itself.

SecretId — Class in namespace Dagger

The SecretID scalar type represents an identifier for an object of type Secret.

Service — Class in namespace Dagger

A content-addressed service providing TCP connectivity.

Service::start() — Method in class Service

Start the service and wait for its health checks to succeed.

Service::stop() — Method in class Service

Stop the service.

Service::sync() — Method in class Service

Forces evaluation of the pipeline in the engine.

ServiceId — Class in namespace Dagger

The ServiceID scalar type represents an identifier for an object of type Service.

Socket — Class in namespace Dagger

A Unix or TCP/IP socket that can be mounted into a container.

SocketId — Class in namespace Dagger

The SocketID scalar type represents an identifier for an object of type Socket.

SourceMap — Class in namespace Dagger

Source location information.

SourceMapId — Class in namespace Dagger

The SourceMapID scalar type represents an identifier for an object of type SourceMap.

Stat — Class in namespace Dagger

A file or directory status object.

Stat::size() — Method in class Stat

file size

StatId — Class in namespace Dagger

The StatID scalar type represents an identifier for an object of type Stat.

Terminal::sync() — Method in class Terminal

Forces evaluation of the pipeline in the engine.

Workspace::services() — Method in class Workspace

Return all services from modules loaded in the workspace.

T

Binding::typeName() — Method in class Binding

Returns the binding type

Client::typeDef() — Method in class Client

Create a new TypeDef.

Cloud::traceURL() — Method in class Cloud

The trace URL for the current session

Container::terminal() — Method in class Container

Opens an interactive terminal for this container using its configured default terminal command if not overridden by args (or sh as a fallback default).

Directory::terminal() — Method in class Directory

Opens an interactive terminal in new container with this directory mounted inside.

EngineCache::targetSpace() — Method in class EngineCache

The target number of bytes to keep when pruning.

FieldTypeDef::typeDef() — Method in class FieldTypeDef

The type of the field.

FunctionArg::typeDef() — Method in class FunctionArg

The type of the argument.

GitRef::tree() — Method in class GitRef

The filesystem tree at this ref.

GitRepository::tag() — Method in class GitRepository

Returns details of a tag.

GitRepository::tags() — Method in class GitRepository

tags that match any of the given glob patterns.

HealthcheckConfig::timeout() — Method in class HealthcheckConfig

Healthcheck timeout. Example:3s

Host::tunnel() — Method in class Host

Creates a tunnel that forwards traffic from the host to a service.

LLM::tokenUsage() — Method in class LLM

returns the token usage of the current state

LLM::tools() — Method in class LLM

print documentation for available tools

LLMTokenUsage::totalTokens() — Method in class LLMTokenUsageModuleSource::toolchains() — Method in class ModuleSource

The toolchains referenced by the module source.

SearchSubmatch::text() — Method in class SearchSubmatch

The matched text.

Service::terminal() — Method in class ServiceTerminal — Class in namespace Dagger

An interactive terminal that clients can connect to.

TerminalId — Class in namespace Dagger

The TerminalID scalar type represents an identifier for an object of type Terminal.

TypeDef — Class in namespace Dagger

A definition of a parameter or return type in a Module.

TypeDefId — Class in namespace Dagger

The TypeDefID scalar type represents an identifier for an object of type TypeDef.

U

Container::up() — Method in class Container

Starts a Service and creates a tunnel that forwards traffic from the caller's network to that service.

Container::user() — Method in class Container

Retrieves the user to be set for all commands.

GitRepository::uncommitted() — Method in class GitRepository

Returns the changeset of uncommitted changes in the git repository.

GitRepository::url() — Method in class GitRepository

The URL of the git repository.

Host::unixSocket() — Method in class Host

Accesses a Unix socket on the host.

Module::userDefaults() — Method in class Module

User-defined default values, loaded from local .env files.

ModuleSource::userDefaults() — Method in class ModuleSource

User-defined defaults read from local .env files

Secret::uri() — Method in class Secret

The URI of this secret.

Service::up() — Method in class Service

Creates a tunnel that forwards traffic from the caller's network to this service.

SourceMap::url() — Method in class SourceMap

The URL to the file, if any. This can be used to link to the source map in the browser.

Up — Class in namespace DaggerUpGroup — Class in namespace DaggerUpGroupId — Class in namespace Dagger

The UpGroupID scalar type represents an identifier for an object of type UpGroup.

UpId — Class in namespace Dagger

The UpID scalar type represents an identifier for an object of type Up.

V

Address::value() — Method in class Address

The address value

Client::version() — Method in class Client

Get the current Dagger Engine version.

EnumTypeDef::values() — Method in class EnumTypeDefEnumValueTypeDef::value() — Method in class EnumValueTypeDef

The value of the enum member

EnvFile::variables() — Method in class EnvFile

Return all variables

EnvVariable::value() — Method in class EnvVariable

The environment variable value.

Error::values() — Method in class Error

The extensions of the error.

ErrorValue::value() — Method in class ErrorValue

The value.

FunctionCallArgValue::value() — Method in class FunctionCallArgValue

The value of the argument represented as a JSON serialized string.

GeneratedCode::vcsGeneratedPaths() — Method in class GeneratedCode

List of paths to mark generated in version control (i.e. .gitattributes).

GeneratedCode::vcsIgnoredPaths() — Method in class GeneratedCode

List of paths to ignore in version control (i.e. .gitignore).

Label::value() — Method in class Label

The label value.

ModuleSource::version() — Method in class ModuleSource

The specified version of the git repo this source points to.

W

Changeset::withChangeset() — Method in class Changeset

Add changes to an existing changeset

Changeset::withChangesets() — Method in class Changeset

Add changes from multiple changesets using git octopus merge strategy

Client::with() — Method in class Client

Configure the php-sdk constructor arguments.

Container::withAnnotation() — Method in class Container

Retrieves this container plus the given OCI annotation.

Container::withDefaultArgs() — Method in class Container

Configures default arguments for future commands. Like CMD in Dockerfile.

Container::withDefaultTerminalCmd() — Method in class Container

Set the default command to invoke for the container's terminal API.

Container::withDirectory() — Method in class Container

Return a new container snapshot, with a directory added to its filesystem

Container::withDockerHealthcheck() — Method in class Container

Retrieves this container with the specificed docker healtcheck command set.

Container::withEntrypoint() — Method in class Container

Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.

Container::withEnvFileVariables() — Method in class Container

Export environment variables from an env-file to the container.

Container::withEnvVariable() — Method in class Container

Set a new environment variable in the container.

Container::withError() — Method in class Container

Raise an error.

Container::withExec() — Method in class Container

Execute a command in the container, and return a new snapshot of the container state after execution.

Container::withExposedPort() — Method in class Container

Expose a network port. Like EXPOSE in Dockerfile (but with healthcheck support)

Container::withFile() — Method in class Container

Return a container snapshot with a file added

Container::withFiles() — Method in class Container

Retrieves this container plus the contents of the given files copied to the given path.

Container::withLabel() — Method in class Container

Retrieves this container plus the given label.

Container::withMountedCache() — Method in class Container

Retrieves this container plus a cache volume mounted at the given path.

Container::withMountedDirectory() — Method in class Container

Retrieves this container plus a directory mounted at the given path.

Container::withMountedFile() — Method in class Container

Retrieves this container plus a file mounted at the given path.

Container::withMountedSecret() — Method in class Container

Retrieves this container plus a secret mounted into a file at the given path.

Container::withMountedTemp() — Method in class Container

Retrieves this container plus a temporary directory mounted at the given path. Any writes will be ephemeral to a single withExec call; they will not be persisted to subsequent withExecs.

Container::withNewFile() — Method in class Container

Return a new container snapshot, with a file added to its filesystem with text content

Container::withRegistryAuth() — Method in class Container

Attach credentials for future publishing to a registry. Use in combination with publish

Container::withRootfs() — Method in class Container

Change the container's root filesystem. The previous root filesystem will be lost.

Container::withSecretVariable() — Method in class Container

Set a new environment variable, using a secret value

Container::withServiceBinding() — Method in class Container

Establish a runtime dependency from a container to a network service.

Container::withSymlink() — Method in class Container

Return a snapshot with a symlink

Container::withUnixSocket() — Method in class Container

Retrieves this container plus a socket forwarded to the given Unix socket path.

Container::withUser() — Method in class Container

Retrieves this container with a different command user.

Container::withWorkdir() — Method in class Container

Change the container's working directory. Like WORKDIR in Dockerfile.

Container::withoutAnnotation() — Method in class Container

Retrieves this container minus the given OCI annotation.

Container::withoutDefaultArgs() — Method in class Container

Remove the container's default arguments.

Container::withoutDirectory() — Method in class Container

Return a new container snapshot, with a directory removed from its filesystem

Container::withoutDockerHealthcheck() — Method in class Container

Retrieves this container without a configured docker healtcheck command.

Container::withoutEntrypoint() — Method in class Container

Reset the container's OCI entrypoint.

Container::withoutEnvVariable() — Method in class Container

Retrieves this container minus the given environment variable.

Container::withoutExposedPort() — Method in class Container

Unexpose a previously exposed port.

Container::withoutFile() — Method in class Container

Retrieves this container with the file at the given path removed.

Container::withoutFiles() — Method in class Container

Return a new container spanshot with specified files removed

Container::withoutLabel() — Method in class Container

Retrieves this container minus the given environment label.

Container::withoutMount() — Method in class Container

Retrieves this container after unmounting everything at the given path.

Container::withoutRegistryAuth() — Method in class Container

Retrieves this container without the registry authentication of a given address.

Container::withoutSecretVariable() — Method in class Container

Retrieves this container minus the given environment variable containing the secret.

Container::withoutUnixSocket() — Method in class Container

Retrieves this container with a previously added Unix socket removed.

Container::withoutUser() — Method in class Container

Retrieves this container with an unset command user.

Container::withoutWorkdir() — Method in class Container

Unset the container's working directory.

Container::workdir() — Method in class Container

Retrieves the working directory for all commands.

CurrentModule::workdir() — Method in class CurrentModule

Load a directory from the module's scratch working directory, including any changes that may have been made to it during module function execution.

CurrentModule::workdirFile() — Method in class CurrentModule

Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.

Directory::withChanges() — Method in class Directory

Return a directory with changes from another directory applied to it.

Directory::withDirectory() — Method in class Directory

Return a snapshot with a directory added

Directory::withError() — Method in class Directory

Raise an error.

Directory::withFile() — Method in class Directory

Retrieves this directory plus the contents of the given file copied to the given path.

Directory::withFiles() — Method in class Directory

Retrieves this directory plus the contents of the given files copied to the given path.

Directory::withNewDirectory() — Method in class Directory

Retrieves this directory plus a new directory created at the given path.

Directory::withNewFile() — Method in class Directory

Return a snapshot with a new file added

Directory::withPatch() — Method in class Directory

Retrieves this directory with the given Git-compatible patch applied.

Directory::withPatchFile() — Method in class Directory

Retrieves this directory with the given Git-compatible patch file applied.

Directory::withSymlink() — Method in class Directory

Return a snapshot with a symlink

Directory::withTimestamps() — Method in class Directory

Retrieves this directory with all file/dir timestamps set to the given time.

Directory::withoutDirectory() — Method in class Directory

Return a snapshot with a subdirectory removed

Directory::withoutFile() — Method in class Directory

Return a snapshot with a file removed

Directory::withoutFiles() — Method in class Directory

Return a snapshot with files removed

Env::withAddressInput() — Method in class Env

Create or update a binding of type Address in the environment

Env::withAddressOutput() — Method in class Env

Declare a desired Address output to be assigned in the environment

Env::withCacheVolumeInput() — Method in class Env

Create or update a binding of type CacheVolume in the environment

Env::withCacheVolumeOutput() — Method in class Env

Declare a desired CacheVolume output to be assigned in the environment

Env::withChangesetInput() — Method in class Env

Create or update a binding of type Changeset in the environment

Env::withChangesetOutput() — Method in class Env

Declare a desired Changeset output to be assigned in the environment

Env::withCheckGroupInput() — Method in class Env

Create or update a binding of type CheckGroup in the environment

Env::withCheckGroupOutput() — Method in class Env

Declare a desired CheckGroup output to be assigned in the environment

Env::withCheckInput() — Method in class Env

Create or update a binding of type Check in the environment

Env::withCheckOutput() — Method in class Env

Declare a desired Check output to be assigned in the environment

Env::withCloudInput() — Method in class Env

Create or update a binding of type Cloud in the environment

Env::withCloudOutput() — Method in class Env

Declare a desired Cloud output to be assigned in the environment

Env::withContainerInput() — Method in class Env

Create or update a binding of type Container in the environment

Env::withContainerOutput() — Method in class Env

Declare a desired Container output to be assigned in the environment

Env::withCurrentModule() — Method in class Env

Installs the current module into the environment, exposing its functions to the model

Env::withDiffStatInput() — Method in class Env

Create or update a binding of type DiffStat in the environment

Env::withDiffStatOutput() — Method in class Env

Declare a desired DiffStat output to be assigned in the environment

Env::withDirectoryInput() — Method in class Env

Create or update a binding of type Directory in the environment

Env::withDirectoryOutput() — Method in class Env

Declare a desired Directory output to be assigned in the environment

Env::withEnvFileInput() — Method in class Env

Create or update a binding of type EnvFile in the environment

Env::withEnvFileOutput() — Method in class Env

Declare a desired EnvFile output to be assigned in the environment

Env::withEnvInput() — Method in class Env

Create or update a binding of type Env in the environment

Env::withEnvOutput() — Method in class Env

Declare a desired Env output to be assigned in the environment

Env::withFileInput() — Method in class Env

Create or update a binding of type File in the environment

Env::withFileOutput() — Method in class Env

Declare a desired File output to be assigned in the environment

Env::withGeneratorGroupInput() — Method in class Env

Create or update a binding of type GeneratorGroup in the environment

Env::withGeneratorGroupOutput() — Method in class Env

Declare a desired GeneratorGroup output to be assigned in the environment

Env::withGeneratorInput() — Method in class Env

Create or update a binding of type Generator in the environment

Env::withGeneratorOutput() — Method in class Env

Declare a desired Generator output to be assigned in the environment

Env::withGitRefInput() — Method in class Env

Create or update a binding of type GitRef in the environment

Env::withGitRefOutput() — Method in class Env

Declare a desired GitRef output to be assigned in the environment

Env::withGitRepositoryInput() — Method in class Env

Create or update a binding of type GitRepository in the environment

Env::withGitRepositoryOutput() — Method in class Env

Declare a desired GitRepository output to be assigned in the environment

Env::withJSONValueInput() — Method in class Env

Create or update a binding of type JSONValue in the environment

Env::withJSONValueOutput() — Method in class Env

Declare a desired JSONValue output to be assigned in the environment

Env::withMainModule() — Method in class Env

Sets the main module for this environment (the project being worked on)

Env::withModule() — Method in class Env

Installs a module into the environment, exposing its functions to the model

Env::withModuleConfigClientInput() — Method in class Env

Create or update a binding of type ModuleConfigClient in the environment

Env::withModuleConfigClientOutput() — Method in class Env

Declare a desired ModuleConfigClient output to be assigned in the environment

Env::withModuleInput() — Method in class Env

Create or update a binding of type Module in the environment

Env::withModuleOutput() — Method in class Env

Declare a desired Module output to be assigned in the environment

Env::withModuleSourceInput() — Method in class Env

Create or update a binding of type ModuleSource in the environment

Env::withModuleSourceOutput() — Method in class Env

Declare a desired ModuleSource output to be assigned in the environment

Env::withPhpSdkInput() — Method in class Env

Create or update a binding of type PhpSdk in the environment

Env::withPhpSdkOutput() — Method in class Env

Declare a desired PhpSdk output to be assigned in the environment

Env::withSearchResultInput() — Method in class Env

Create or update a binding of type SearchResult in the environment

Env::withSearchResultOutput() — Method in class Env

Declare a desired SearchResult output to be assigned in the environment

Env::withSearchSubmatchInput() — Method in class Env

Create or update a binding of type SearchSubmatch in the environment

Env::withSearchSubmatchOutput() — Method in class Env

Declare a desired SearchSubmatch output to be assigned in the environment

Env::withSecretInput() — Method in class Env

Create or update a binding of type Secret in the environment

Env::withSecretOutput() — Method in class Env

Declare a desired Secret output to be assigned in the environment

Env::withServiceInput() — Method in class Env

Create or update a binding of type Service in the environment

Env::withServiceOutput() — Method in class Env

Declare a desired Service output to be assigned in the environment

Env::withSocketInput() — Method in class Env

Create or update a binding of type Socket in the environment

Env::withSocketOutput() — Method in class Env

Declare a desired Socket output to be assigned in the environment

Env::withStatInput() — Method in class Env

Create or update a binding of type Stat in the environment

Env::withStatOutput() — Method in class Env

Declare a desired Stat output to be assigned in the environment

Env::withStringInput() — Method in class Env

Provides a string input binding to the environment

Env::withStringOutput() — Method in class Env

Declares a desired string output binding

Env::withUpGroupInput() — Method in class Env

Create or update a binding of type UpGroup in the environment

Env::withUpGroupOutput() — Method in class Env

Declare a desired UpGroup output to be assigned in the environment

Env::withUpInput() — Method in class Env

Create or update a binding of type Up in the environment

Env::withUpOutput() — Method in class Env

Declare a desired Up output to be assigned in the environment

Env::withWorkspace() — Method in class Env

Returns a new environment with the provided workspace

Env::withWorkspaceInput() — Method in class Env

Create or update a binding of type Workspace in the environment

Env::withWorkspaceOutput() — Method in class Env

Declare a desired Workspace output to be assigned in the environment

Env::withoutOutputs() — Method in class Env

Returns a new environment without any outputs

Env::workspace() — Method in class EnvEnvFile::withVariable() — Method in class EnvFile

Add a variable

EnvFile::withoutVariable() — Method in class EnvFile

Remove all occurrences of the named variable

Error::withValue() — Method in class Error

Add a value to the error.

File::withName() — Method in class File

Retrieves this file with its name set to the given name.

File::withReplaced() — Method in class File

Retrieves the file with content replaced with the given text.

File::withTimestamps() — Method in class File

Retrieves this file with its created/modified timestamps set to the given time.

Function_::withArg() — Method in class Function_

Returns the function with the provided argument

Function_::withCachePolicy() — Method in class Function_

Returns the function updated to use the provided cache policy.

Function_::withCheck() — Method in class Function_

Returns the function with a flag indicating it's a check.

Function_::withDeprecated() — Method in class Function_

Returns the function with the provided deprecation reason.

Function_::withDescription() — Method in class Function_

Returns the function with the given doc string.

Function_::withGenerator() — Method in class Function_

Returns the function with a flag indicating it's a generator.

Function_::withSourceMap() — Method in class Function_

Returns the function with the given source map.

Function_::withUp() — Method in class Function_

Returns the function with a flag indicating it returns a service for dagger up.

GeneratedCode::withVCSGeneratedPaths() — Method in class GeneratedCode

Set the list of paths to mark generated in version control.

GeneratedCode::withVCSIgnoredPaths() — Method in class GeneratedCode

Set the list of paths to ignore in version control.

JsonValue::withContents() — Method in class JsonValue

Return a new json value, decoded from the given content

JsonValue::withField() — Method in class JsonValue

Set a new field at the given path

LLM::withBlockedFunction() — Method in class LLM

Return a new LLM with the specified function no longer exposed as a tool

LLM::withEnv() — Method in class LLM

allow the LLM to interact with an environment via MCP

LLM::withMCPServer() — Method in class LLM

Add an external MCP server to the LLM

LLM::withModel() — Method in class LLM

swap out the llm model

LLM::withPrompt() — Method in class LLM

append a prompt to the llm context

LLM::withPromptFile() — Method in class LLM

append the contents of a file to the llm context

LLM::withStaticTools() — Method in class LLM

Use a static set of tools for method calls, e.g. for MCP clients that do not support dynamic tool registration

LLM::withSystemPrompt() — Method in class LLM

Add a system prompt to the LLM's environment

LLM::withoutDefaultSystemPrompt() — Method in class LLM

Disable the default system prompt

LLM::withoutMessageHistory() — Method in class LLM

Clear the message history, leaving only the system prompts

LLM::withoutSystemPrompts() — Method in class LLM

Clear the system prompts, leaving only the default system prompt

Module::withDescription() — Method in class Module

Retrieves the module with the given description

Module::withEnum() — Method in class Module

This module plus the given Enum type and associated values

Module::withInterface() — Method in class Module

This module plus the given Interface type and associated functions

Module::withObject() — Method in class Module

This module plus the given Object type and associated functions.

ModuleSource::withBlueprint() — Method in class ModuleSource

Set a blueprint for the module source.

ModuleSource::withClient() — Method in class ModuleSource

Update the module source with a new client to generate.

ModuleSource::withDependencies() — Method in class ModuleSource

Append the provided dependencies to the module source's dependency list.

ModuleSource::withEngineVersion() — Method in class ModuleSource

Upgrade the engine version of the module to the given value.

ModuleSource::withExperimentalFeatures() — Method in class ModuleSource

Enable the experimental features for the module source.

ModuleSource::withIncludes() — Method in class ModuleSource

Update the module source with additional include patterns for files+directories from its context that are required for building it

ModuleSource::withName() — Method in class ModuleSource

Update the module source with a new name.

ModuleSource::withSDK() — Method in class ModuleSource

Update the module source with a new SDK.

ModuleSource::withSourceSubpath() — Method in class ModuleSource

Update the module source with a new source subpath.

ModuleSource::withToolchains() — Method in class ModuleSource

Add toolchains to the module source.

ModuleSource::withUpdateBlueprint() — Method in class ModuleSource

Update the blueprint module to the latest version.

ModuleSource::withUpdateDependencies() — Method in class ModuleSource

Update one or more module dependencies.

ModuleSource::withUpdateToolchains() — Method in class ModuleSource

Update one or more toolchains.

ModuleSource::withUpdatedClients() — Method in class ModuleSource

Update one or more clients.

ModuleSource::withoutBlueprint() — Method in class ModuleSource

Remove the current blueprint from the module source.

ModuleSource::withoutClient() — Method in class ModuleSource

Remove a client from the module source.

ModuleSource::withoutDependencies() — Method in class ModuleSource

Remove the provided dependencies from the module source's dependency list.

ModuleSource::withoutExperimentalFeatures() — Method in class ModuleSource

Disable experimental features for the module source.

ModuleSource::withoutToolchains() — Method in class ModuleSource

Remove the provided toolchains from the module source.

Service::withHostname() — Method in class Service

Configures a hostname which can be used by clients within the session to reach this container.

TypeDef::withConstructor() — Method in class TypeDef

Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object.

TypeDef::withEnum() — Method in class TypeDef

Returns a TypeDef of kind Enum with the provided name.

TypeDef::withEnumMember() — Method in class TypeDef

Adds a static value for an Enum TypeDef, failing if the type is not an enum.

TypeDef::withEnumValue() — Method in class TypeDef

Adds a static value for an Enum TypeDef, failing if the type is not an enum.

TypeDef::withField() — Method in class TypeDef

Adds a static field for an Object TypeDef, failing if the type is not an object.

TypeDef::withFunction() — Method in class TypeDef

Adds a function for an Object or Interface TypeDef, failing if the type is not one of those kinds.

TypeDef::withInterface() — Method in class TypeDef

Returns a TypeDef of kind Interface with the provided name.

TypeDef::withKind() — Method in class TypeDef

Sets the kind of the type.

TypeDef::withListOf() — Method in class TypeDef

Returns a TypeDef of kind List with the provided type for its elements.

TypeDef::withObject() — Method in class TypeDef

Returns a TypeDef of kind Object with the provided name.

TypeDef::withOptional() — Method in class TypeDef

Sets whether this type can be set to null.

TypeDef::withScalar() — Method in class TypeDef

Returns a TypeDef of kind Scalar with the provided name.

Workspace — Class in namespace Dagger

A Dagger workspace detected from the current working directory.

WorkspaceId — Class in namespace Dagger

The WorkspaceID scalar type represents an identifier for an object of type Workspace.

_

DefaultPath::__construct() — Method in class DefaultPathDoc::__construct() — Method in class DocIgnore::__construct() — Method in class IgnoreListOfType::__construct() — Method in class ListOfTypeReturnsListOfType::__construct() — Method in class ReturnsListOfTypeBuildArg::__construct() — Method in class BuildArgAbstractClient::__construct() — Method in class AbstractClientAbstractInputObject::__toString() — Method in class AbstractInputObjectAbstractObject::__construct() — Method in class AbstractObjectAbstractScalar::__construct() — Method in class AbstractScalarAbstractScalar::__toString() — Method in class AbstractScalarPipelineLabel::__construct() — Method in class PipelineLabelPortForward::__construct() — Method in class PortForward

Generated by Doctum, a API Documentation generator and fork of Sami.