Dagger GraphQL API Reference

Queries

`cacheVolume`

Description

Constructs a cache volume for a given cache key.

Type

CacheVolume!

Arguments

Name	Description
`key` - `String!`	A string identifier to target this cache volume (e.g., "modules-cache").

Example

query {
  cacheVolume(key: "deps") {
    id
  }
}

Queries

`cloud`

Description

Dagger Cloud configuration and state

Type

Cloud!

Example

Queries

`container`

Description

Creates a scratch container, with no image or metadata.

To pull an image, follow up with the "from" function.

Type

Container!

Arguments

Name	Description
`platform` - `Platform`	Platform to initialize the container with. Defaults to the native platform of the current engine

Example

query {
  container {
    from(address: "alpine") {
      defaultArgs
      entrypoint
      platform
      rootfs {
        entries
      }
    }
  }
}

Queries

`currentFunctionCall`

Description

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

If the caller is not currently executing in a function, this will return an error.

Type

FunctionCall!

Example

Queries

`currentModule`

Description

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

Type

CurrentModule!

Example

Queries

`currentTypeDefs`

Description

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

Type

[TypeDef!]!

Example

Queries

`defaultPlatform`

Description

The default platform of the engine.

Type

Platform!

Example

query {
  defaultPlatform
}

Queries

`directory`

Description

Creates an empty directory.

Type

Directory!

Example

query {
  directory {
    withNewDirectory(path: "foo") {
      withNewDirectory(path: "foo/bar/baz") {
        withNewFile(path: "foo/bar/greeting", contents: "hello, world!\n") {
          foo: entries(path: "foo")
          bar: entries(path: "foo/bar")
          greeting: file(path: "foo/bar/greeting") {
            contents
          }
        }
      }
    }
  }
}

Queries

`engine`

Description

The Dagger engine container configuration and state

Type

Engine!

Example

Queries

`env`

Description

Initialize a new environment

Type

Env!

Arguments

Name	Description
`privileged` - `Boolean`	Give the environment the same privileges as the caller: core API including host access, current module, and dependencies. Default = `false`
`writable` - `Boolean`	Allow new outputs to be declared and saved in the environment. Default = `false`

Example

Queries

`error`

Description

Create a new error.

Type

Error!

Arguments

Name	Description
`message` - `String!`	A brief description of the error.

Example

Queries

`file`

Description

Creates a file with the specified contents.

Type

File!

Arguments

Name	Description
`name` - `String!`	Name of the new file. Example: "foo.txt"
`contents` - `String!`	Contents of the new file. Example: "Hello world!"
`permissions` - `Int`	Permissions of the new file. Example: 0600. Default = `420`

Example

query {
  file(id: "eyJsbGIiOnsiZGVmIjpbIklqWVNOQWovLy8vLy8vLy8vLzhCRVAvLy8vLy8vLy8vL3dFcUhBb0VMMlp2YnhDa0F4b0dTR1ZzYkc4aEtQLy8vLy8vLy8vLy93RlNBRm9BIiwiQ2trS1IzTm9ZVEkxTmpwak1EQTVPV1U1TURrNFpEVmlObUkyWVdWaFpXWXpObVpsTnpsaU9UUTVOVEF4TnpoalptRmpPRGxsWVdKbE5XRmtZbUprTkdZeFptWXdNV0l3TkdWbSJdLCJtZXRhZGF0YSI6eyJzaGEyNTY6NWNjOGQ1M2VkZTRjYzUyODQ0OTIyYWFhZDlhYjIzMzc3MzY3NWMwMDJjOTM5NGZhYTk0OTg1OTZmNGFjMWRiNiI6eyJjYXBzIjp7ImNvbnN0cmFpbnRzIjp0cnVlLCJwbGF0Zm9ybSI6dHJ1ZX19LCJzaGEyNTY6YzAwOTllOTA5OGQ1YjZiNmFlYWVmMzZmZTc5Yjk0OTUwMTc4Y2ZhYzg5ZWFiZTVhZGJiZDRmMWZmMDFiMDRlZiI6eyJjYXBzIjp7ImZpbGUuYmFzZSI6dHJ1ZX19fSwiU291cmNlIjp7ImxvY2F0aW9ucyI6eyJzaGEyNTY6YzAwOTllOTA5OGQ1YjZiNmFlYWVmMzZmZTc5Yjk0OTUwMTc4Y2ZhYzg5ZWFiZTVhZGJiZDRmMWZmMDFiMDRlZiI6e319fX0sImZpbGUiOiJmb28iLCJwbGF0Zm9ybSI6eyJhcmNoaXRlY3R1cmUiOiIiLCJvcyI6IiJ9fQ==") {
    contents
    export(path: "greeting")
  }
}

Queries

`function`

Description

Creates a function.

Type

Function!

Arguments

Name	Description
`name` - `String!`	Name of the function, in its original format from the implementation language.
`returnType` - `TypeDefID!`	Return type of the function.

Example

Queries

`generatedCode`

Description

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

Type

GeneratedCode!

Arguments

Name	Description
`code` - `DirectoryID!`

Example

Queries

`git`

Description

Queries a Git repository.

Type

GitRepository!

Arguments

Name	Description
`url` - `String!`	URL of the git repository. Can be formatted as `https://{host}/{owner}/{repo}`, `git@{host}:{owner}/{repo}`. Suffix ".git" is optional.
`keepGitDir` - `Boolean`	DEPRECATED: Set to true to keep .git directory. Default = `true`
`sshKnownHosts` - `String`	Set SSH known hosts. Default = `""`
`sshAuthSocket` - `SocketID`	Set SSH auth socket
`httpAuthUsername` - `String`	Username used to populate the password during basic HTTP Authorization. Default = `""`
`httpAuthToken` - `SecretID`	Secret used to populate the password during basic HTTP Authorization
`httpAuthHeader` - `SecretID`	Secret used to populate the Authorization HTTP header
`experimentalServiceHost` - `ServiceID`	A service which must be started before the repo is fetched.

Example

query {
  git(url: "https://github.com/dagger/dagger", keepGitDir: true) {
    branch(name: "main") {
      tree {
        file(path: ".git/refs/heads/main") {
          contents
        }
      }
    }
  }
}

Queries

`host`

Description

Queries the host environment.

Type

Host!

Example

query {
  host {
    read: directory(path: ".") {
      file(path: ".markdownlint.yaml") {
        contents
      }
    }
    home: envVariable(name: "HOME") {
      value
    }
    pwd: envVariable(name: "PWD") {
      value
    }
    write: directory(path: ".") {
      withNewFile(path: "greeting", contents: "Hello Dagger!") {
        export(path: ".")
      }
    }
  }
}

Queries

`http`

Description

Returns a file containing an http remote url content.

Type

File!

Arguments

Name	Description
`url` - `String!`	HTTP url to get the content from (e.g., "https://docs.dagger.io").
`name` - `String`	File name to use for the file. Defaults to the last part of the URL.
`permissions` - `Int`	Permissions to set on the file.
`authHeader` - `SecretID`	Secret used to populate the Authorization HTTP header
`experimentalServiceHost` - `ServiceID`	A service which must be started before the URL is fetched.

Example

query {
  http(url: "http://dagger.io") {
    size
    contents
  }
}

Queries

`llm`

Description

Initialize a Large Language Model (LLM)

Type

LLM!

Arguments

Name	Description
`model` - `String`	Model to use
`maxAPICalls` - `Int`	Cap the number of API calls for this LLM

Example

Queries

`loadBindingFromID`

Description

Load a Binding from its ID.

Type

Binding!

Arguments

Name	Description
`id` - `BindingID!`

Example

Queries

`loadCacheVolumeFromID`

Description

Load a CacheVolume from its ID.

Type

CacheVolume!

Arguments

Name	Description
`id` - `CacheVolumeID!`

Example

Queries

`loadCloudFromID`

Description

Load a Cloud from its ID.

Type

Cloud!

Arguments

Name	Description
`id` - `CloudID!`

Example

Queries

`loadContainerFromID`

Description

Load a Container from its ID.

Type

Container!

Arguments

Name	Description
`id` - `ContainerID!`

Example

Queries

`loadCurrentModuleFromID`

Description

Load a CurrentModule from its ID.

Type

CurrentModule!

Arguments

Name	Description
`id` - `CurrentModuleID!`

Example

Queries

`loadDirectoryFromID`

Description

Load a Directory from its ID.

Type

Directory!

Arguments

Name	Description
`id` - `DirectoryID!`

Example

Queries

`loadEngineCacheEntryFromID`

Description

Load a EngineCacheEntry from its ID.

Type

EngineCacheEntry!

Arguments

Name	Description
`id` - `EngineCacheEntryID!`

Example

Queries

`loadEngineCacheEntrySetFromID`

Description

Load a EngineCacheEntrySet from its ID.

Type

EngineCacheEntrySet!

Arguments

Name	Description
`id` - `EngineCacheEntrySetID!`

Example

Queries

`loadEngineCacheFromID`

Description

Load a EngineCache from its ID.

Type

EngineCache!

Arguments

Name	Description
`id` - `EngineCacheID!`

Example

Queries

`loadEngineFromID`

Description

Load a Engine from its ID.

Type

Engine!

Arguments

Name	Description
`id` - `EngineID!`

Example

Queries

`loadEnumTypeDefFromID`

Description

Load a EnumTypeDef from its ID.

Type

EnumTypeDef!

Arguments

Name	Description
`id` - `EnumTypeDefID!`

Example

Queries

`loadEnumValueTypeDefFromID`

Description

Load a EnumValueTypeDef from its ID.

Type

EnumValueTypeDef!

Arguments

Name	Description
`id` - `EnumValueTypeDefID!`

Example

Queries

`loadEnvFromID`

Description

Load a Env from its ID.

Type

Env!

Arguments

Name	Description
`id` - `EnvID!`

Example

Queries

`loadEnvVariableFromID`

Description

Load a EnvVariable from its ID.

Type

EnvVariable!

Arguments

Name	Description
`id` - `EnvVariableID!`

Example

Queries

`loadErrorFromID`

Description

Load a Error from its ID.

Type

Error!

Arguments

Name	Description
`id` - `ErrorID!`

Example

Queries

`loadErrorValueFromID`

Description

Load a ErrorValue from its ID.

Type

ErrorValue!

Arguments

Name	Description
`id` - `ErrorValueID!`

Example

Queries

`loadFieldTypeDefFromID`

Description

Load a FieldTypeDef from its ID.

Type

FieldTypeDef!

Arguments

Name	Description
`id` - `FieldTypeDefID!`

Example

Queries

`loadFileFromID`

Description

Load a File from its ID.

Type

File!

Arguments

Name	Description
`id` - `FileID!`

Example

Queries

`loadFunctionArgFromID`

Description

Load a FunctionArg from its ID.

Type

FunctionArg!

Arguments

Name	Description
`id` - `FunctionArgID!`

Example

Queries

`loadFunctionCallArgValueFromID`

Description

Load a FunctionCallArgValue from its ID.

Type

FunctionCallArgValue!

Arguments

Name	Description
`id` - `FunctionCallArgValueID!`

Example

Queries

`loadFunctionCallFromID`

Description

Load a FunctionCall from its ID.

Type

FunctionCall!

Arguments

Name	Description
`id` - `FunctionCallID!`

Example

Queries

`loadFunctionFromID`

Description

Load a Function from its ID.

Type

Function!

Arguments

Name	Description
`id` - `FunctionID!`

Example

Queries

`loadGeneratedCodeFromID`

Description

Load a GeneratedCode from its ID.

Type

GeneratedCode!

Arguments

Name	Description
`id` - `GeneratedCodeID!`

Example

Queries

`loadGitRefFromID`

Description

Load a GitRef from its ID.

Type

GitRef!

Arguments

Name	Description
`id` - `GitRefID!`

Example

Queries

`loadGitRepositoryFromID`

Description

Load a GitRepository from its ID.

Type

GitRepository!

Arguments

Name	Description
`id` - `GitRepositoryID!`

Example

Queries

`loadHostFromID`

Description

Load a Host from its ID.

Type

Host!

Arguments

Name	Description
`id` - `HostID!`

Example

Queries

`loadInputTypeDefFromID`

Description

Load a InputTypeDef from its ID.

Type

InputTypeDef!

Arguments

Name	Description
`id` - `InputTypeDefID!`

Example

Queries

`loadInterfaceTypeDefFromID`

Description

Load a InterfaceTypeDef from its ID.

Type

InterfaceTypeDef!

Arguments

Name	Description
`id` - `InterfaceTypeDefID!`

Example

Queries

`loadLLMFromID`

Description

Load a LLM from its ID.

Type

LLM!

Arguments

Name	Description
`id` - `LLMID!`

Example

Queries

`loadLLMTokenUsageFromID`

Description

Load a LLMTokenUsage from its ID.

Type

LLMTokenUsage!

Arguments

Name	Description
`id` - `LLMTokenUsageID!`

Example

Queries

`loadLabelFromID`

Description

Load a Label from its ID.

Type

Label!

Arguments

Name	Description
`id` - `LabelID!`

Example

Queries

`loadListTypeDefFromID`

Description

Load a ListTypeDef from its ID.

Type

ListTypeDef!

Arguments

Name	Description
`id` - `ListTypeDefID!`

Example

Queries

`loadModuleConfigClientFromID`

Description

Load a ModuleConfigClient from its ID.

Type

ModuleConfigClient!

Arguments

Name	Description
`id` - `ModuleConfigClientID!`

Example

Queries

`loadModuleFromID`

Description

Load a Module from its ID.

Type

Module!

Arguments

Name	Description
`id` - `ModuleID!`

Example

Queries

`loadModuleSourceFromID`

Description

Load a ModuleSource from its ID.

Type

ModuleSource!

Arguments

Name	Description
`id` - `ModuleSourceID!`

Example

Queries

`loadObjectTypeDefFromID`

Description

Load a ObjectTypeDef from its ID.

Type

ObjectTypeDef!

Arguments

Name	Description
`id` - `ObjectTypeDefID!`

Example

Queries

`loadPortFromID`

Description

Load a Port from its ID.

Type

Port!

Arguments

Name	Description
`id` - `PortID!`

Example

Queries

`loadSDKConfigFromID`

Description

Load a SDKConfig from its ID.

Type

SDKConfig

Arguments

Name	Description
`id` - `SDKConfigID!`

Example

Queries

`loadScalarTypeDefFromID`

Description

Load a ScalarTypeDef from its ID.

Type

ScalarTypeDef!

Arguments

Name	Description
`id` - `ScalarTypeDefID!`

Example

Queries

`loadSecretFromID`

Description

Load a Secret from its ID.

Type

Secret!

Arguments

Name	Description
`id` - `SecretID!`

Example

Queries

`loadServiceFromID`

Description

Load a Service from its ID.

Type

Service!

Arguments

Name	Description
`id` - `ServiceID!`

Example

Queries

`loadSocketFromID`

Description

Load a Socket from its ID.

Type

Socket!

Arguments

Name	Description
`id` - `SocketID!`

Example

Queries

`loadSourceMapFromID`

Description

Load a SourceMap from its ID.

Type

SourceMap!

Arguments

Name	Description
`id` - `SourceMapID!`

Example

Queries

`loadTerminalFromID`

Description

Load a Terminal from its ID.

Type

Terminal!

Arguments

Name	Description
`id` - `TerminalID!`

Example

Queries

`loadTypeDefFromID`

Description

Load a TypeDef from its ID.

Type

TypeDef!

Arguments

Name	Description
`id` - `TypeDefID!`

Example

Queries

`module`

Description

Create a new module.

Type

Module!

Example

Queries

`moduleSource`

Description

Create a new module source instance from a source ref string

Type

ModuleSource!

Arguments

Name	Description
`refString` - `String!`	The string ref representation of the module source
`refPin` - `String`	The pinned version of the module source. Default = `""`
`disableFindUp` - `Boolean`	If true, do not attempt to find dagger.json in a parent directory of the provided path. Only relevant for local module sources. Default = `false`
`allowNotExists` - `Boolean`	If true, do not error out if the provided ref string is a local path and does not exist yet. Useful when initializing new modules in directories that don't exist yet. Default = `false`
`requireKind` - `ModuleSourceKind`	If set, error out if the ref string is not of the provided requireKind.

Example

Queries

`secret`

Description

Creates a new secret.

Type

Secret!

Arguments

Name Description

uri - String! The URI of the secret store

cacheKey - String

If set, the given string will be used as the cache key for this secret. This means that any secrets with the same cache key will be considered equivalent in terms of cache lookups, even if they have different URIs or plaintext values.

For example, two secrets with the same cache key provided as secret env vars to other wise equivalent containers will result in the container withExecs hitting the cache for each other.

If not set, the cache key for the secret will be derived from its plaintext value as looked up when the secret is constructed.

Example

query {
  secret(id: "eyJob3N0X2VudiI6IkhPTUUifQ==") {
    plaintext
  }
}

Queries

`setSecret`

Description

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

The plaintext value is limited to a size of 128000 bytes.

Type

Secret!

Arguments

Name	Description
`name` - `String!`	The user defined name for this secret
`plaintext` - `String!`	The plaintext of the secret

Example

Queries

`sourceMap`

Description

Creates source map metadata.

Type

SourceMap!

Arguments

Name	Description
`filename` - `String!`	The filename from the module source.
`line` - `Int!`	The line number within the filename.
`column` - `Int!`	The column number within the line.

Example

Queries

`typeDef`

Description

Create a new TypeDef.

Type

TypeDef!

Example

Queries

`version`

Description

Get the current Dagger Engine version.

Type

String!

Example

Types

Binding

Fields

Field Name	Description
`asCacheVolume` - `CacheVolume!`	Retrieve the binding value, as type CacheVolume
`asCloud` - `Cloud!`	Retrieve the binding value, as type Cloud
`asContainer` - `Container!`	Retrieve the binding value, as type Container
`asDirectory` - `Directory!`	Retrieve the binding value, as type Directory
`asEnv` - `Env!`	Retrieve the binding value, as type Env
`asFile` - `File!`	Retrieve the binding value, as type File
`asGitRef` - `GitRef!`	Retrieve the binding value, as type GitRef
`asGitRepository` - `GitRepository!`	Retrieve the binding value, as type GitRepository
`asLLM` - `LLM!`	Retrieve the binding value, as type LLM
`asModule` - `Module!`	Retrieve the binding value, as type Module
`asModuleConfigClient` - `ModuleConfigClient!`	Retrieve the binding value, as type ModuleConfigClient
`asModuleSource` - `ModuleSource!`	Retrieve the binding value, as type ModuleSource
`asSecret` - `Secret!`	Retrieve the binding value, as type Secret
`asService` - `Service!`	Retrieve the binding value, as type Service
`asSocket` - `Socket!`	Retrieve the binding value, as type Socket
`asString` - `String`	The binding's string value
`digest` - `String!`	The digest of the binding value
`id` - `BindingID!`	A unique identifier for this Binding.
`isNull` - `Boolean!`	Returns true if the binding is null
`name` - `String!`	The binding name
`typeName` - `String!`	The binding type

Types

BindingID

Description

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

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BuildArg

Description

Key value object that represents a build argument.

Fields

Input Field	Description
`name` - `String!`	The build argument name.
`value` - `String!`	The build argument value.

Example

{
  "name": "abc123",
  "value": "abc123"
}

Types

CacheSharingMode

Description

Sharing mode of the cache volume.

Values

Enum Value	Description
`SHARED`	Shares the cache volume amongst many build pipelines
`PRIVATE`	Keeps a cache volume for a single build pipeline
`LOCKED`	Shares the cache volume amongst many build pipelines, but will serialize the writes

Example

"SHARED"

Types

CacheVolume

Description

A directory whose contents persist across runs.

Fields

Field Name	Description
`id` - `CacheVolumeID!`	A unique identifier for this CacheVolume.

Types

CacheVolumeID

Description

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

Types

Cloud

Description

Dagger Cloud configuration and state

Fields

Field Name	Description
`id` - `CloudID!`	A unique identifier for this Cloud.
`traceURL` - `String!`	The trace URL for the current session

Types

CloudID

Description

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

Types

Container

Description

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

Fields

Field Name	Description
`asService` - `Service!`	Turn the container into a Service. Be sure to set any exposed ports before this conversion.
Arguments `args` - `[String!]` Command to run instead of the container's default command (e.g., ["go", "run", "main.go"]). If empty, the container's default command is used. `useEntrypoint` - `Boolean` If the container has an entrypoint, prepend it to the args. `experimentalPrivilegedNesting` - `Boolean` Provides Dagger access to the executed command. `insecureRootCapabilities` - `Boolean` Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo"). `noInit` - `Boolean` If set, skip the automatic init process injected into containers by default. This should only be used if the user requires that their exec process be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
`asTarball` - `File!`	Package the container state as an OCI image, and return it as a tar archive
Arguments `platformVariants` - `[ContainerID!]` Identifiers for other platform specific containers. Used for multi-platform images. `forcedCompression` - `ImageLayerCompression` Force each layer of the image to use the specified compression algorithm. If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip. `mediaTypes` - `ImageMediaTypes` Use the specified media types for the image's layers. Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.
`build` - `Container!`	Initializes this container from a Dockerfile build.
Arguments `context` - `DirectoryID!` Directory context used by the Dockerfile. `dockerfile` - `String` Path to the Dockerfile to use. `target` - `String` Target build stage to build. `buildArgs` - `[BuildArg!]` Additional build arguments. `secrets` - `[SecretID!]` Secrets to pass to the build. They will be mounted at /run/secrets/[secret-name] in the build container They can be accessed in the Dockerfile using the "secret" mount type and mount path /run/secrets/[secret-name], e.g. RUN --mount=type=secret,id=my-secret curl [http://example.com?token=$(cat /run/secrets/my-secret)](http://example.com?token=$(cat /run/secrets/my-secret)) `noInit` - `Boolean` If set, skip the automatic init process injected into containers created by RUN statements. This should only be used if the user requires that their exec processes be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
`defaultArgs` - `[String!]!`	Return the container's default arguments.
`directory` - `Directory!`	Retrieve a directory from the container's root filesystem Mounts are included.
Arguments `path` - `String!` The path of the directory to retrieve (e.g., "./src"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`entrypoint` - `[String!]!`	Return the container's OCI entrypoint.
`envVariable` - `String`	Retrieves the value of the specified environment variable.
Arguments `name` - `String!` The name of the environment variable to retrieve (e.g., "PATH").
`envVariables` - `[EnvVariable!]!`	Retrieves the list of environment variables passed to commands.
`exitCode` - `Int!`	The exit code of the last executed command Returns an error if no command was executed
`experimentalWithAllGPUs` - `Container!`	EXPERIMENTAL API! Subject to change/removal at any time. Configures all available GPUs on the host to be accessible to this container. This currently works for Nvidia devices only.
`experimentalWithGPU` - `Container!`	EXPERIMENTAL API! Subject to change/removal at any time. Configures the provided list of devices to be accessible to this container. This currently works for Nvidia devices only.
Arguments `devices` - `[String!]!` List of devices to be accessible to this container.
`export` - `String!`	Writes the container as an OCI tarball to the destination file path on the host. It can also export platform variants.
Arguments `path` - `String!` Host's destination path (e.g., "./tarball"). Path can be relative to the engine's workdir or absolute. `platformVariants` - `[ContainerID!]` Identifiers for other platform specific containers. Used for multi-platform image. `forcedCompression` - `ImageLayerCompression` Force each layer of the exported image to use the specified compression algorithm. If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip. `mediaTypes` - `ImageMediaTypes` Use the specified media types for the exported image's layers. Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`exposedPorts` - `[Port!]!`	Retrieves the list of exposed ports. This includes ports already exposed by the image, even if not explicitly added with dagger.
`file` - `File!`	Retrieves a file at the given path. Mounts are included.
Arguments `path` - `String!` The path of the file to retrieve (e.g., "./README.md"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`from` - `Container!`	Download a container image, and apply it to the container state. All previous state will be lost.
Arguments `address` - `String!` Address of the container image to download, in standard OCI ref format. Example:"registry.dagger.io/engine:latest"
`id` - `ContainerID!`	A unique identifier for this Container.
`imageRef` - `String!`	The unique image reference which can only be retrieved immediately after the 'Container.From' call.
`import` - `Container!`	Reads the container from an OCI tarball.
Arguments `source` - `FileID!` File to read the container from. `tag` - `String` Identifies the tag to import from the archive, if the archive bundles multiple tags.
`label` - `String`	Retrieves the value of the specified label.
Arguments `name` - `String!` The name of the label (e.g., "org.opencontainers.artifact.created").
`labels` - `[Label!]!`	Retrieves the list of labels passed to container.
`mounts` - `[String!]!`	Retrieves the list of paths where a directory is mounted.
`platform` - `Platform!`	The platform this container executes and publishes as.
`publish` - `String!`	Package the container state as an OCI image, and publish it to a registry Returns the fully qualified address of the published image, with digest
Arguments `address` - `String!` The OCI address to publish to Same format as "docker push". Example: "registry.example.com/user/repo:tag" `platformVariants` - `[ContainerID!]` Identifiers for other platform specific containers. Used for multi-platform image. `forcedCompression` - `ImageLayerCompression` Force each layer of the published image to use the specified compression algorithm. If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip. `mediaTypes` - `ImageMediaTypes` Use the specified media types for the published image's layers. Defaults to "OCI", which is compatible with most recent registries, but "Docker" may be needed for older registries without OCI support.
`rootfs` - `Directory!`	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.
`stderr` - `String!`	The buffered standard error stream of the last executed command Returns an error if no command was executed
`stdout` - `String!`	The buffered standard output stream of the last executed command Returns an error if no command was executed
`sync` - `ContainerID!`	Forces evaluation of the pipeline in the engine. It doesn't run the default command if no exec has been set.
`terminal` - `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).
Arguments `cmd` - `[String!]` If set, override the container's default terminal command and invoke these command arguments instead. `experimentalPrivilegedNesting` - `Boolean` Provides Dagger access to the executed command. `insecureRootCapabilities` - `Boolean` Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
`up` - `Void`	Starts a Service and creates a tunnel that forwards traffic from the caller's network to that service. Be sure to set any exposed ports before calling this api.
Arguments `random` - `Boolean` Bind each tunnel port to a random port on the host. `ports` - `[PortForward!]` List of frontend/backend port mappings to forward. Frontend is the port accepting traffic on the host, backend is the service port. `args` - `[String!]` Command to run instead of the container's default command (e.g., ["go", "run", "main.go"]). If empty, the container's default command is used. `useEntrypoint` - `Boolean` If the container has an entrypoint, prepend it to the args. `experimentalPrivilegedNesting` - `Boolean` Provides Dagger access to the executed command. `insecureRootCapabilities` - `Boolean` Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo"). `noInit` - `Boolean` If set, skip the automatic init process injected into containers by default. This should only be used if the user requires that their exec process be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
`user` - `String!`	Retrieves the user to be set for all commands.
`withAnnotation` - `Container!`	Retrieves this container plus the given OCI anotation.
Arguments `name` - `String!` The name of the annotation. `value` - `String!` The value of the annotation.
`withDefaultArgs` - `Container!`	Configures default arguments for future commands. Like CMD in Dockerfile.
Arguments `args` - `[String!]!` Arguments to prepend to future executions (e.g., ["-v", "--no-cache"]).
`withDefaultTerminalCmd` - `Container!`	Set the default command to invoke for the container's terminal API.
Arguments `args` - `[String!]!` The args of the command. `experimentalPrivilegedNesting` - `Boolean` Provides Dagger access to the executed command. `insecureRootCapabilities` - `Boolean` Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
`withDirectory` - `Container!`	Return a new container snapshot, with a directory added to its filesystem
Arguments `path` - `String!` Location of the written directory (e.g., "/tmp/directory"). `directory` - `DirectoryID!` Identifier of the directory to write `exclude` - `[String!]` Patterns to exclude in the written directory (e.g. ["node_modules/*", ".gitignore", ".git/"]). `include` - `[String!]` Patterns to include in the written directory (e.g. [".go", "go.mod", "go.sum"]). `owner` - `String` A user:group to set for the directory and its contents. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withEntrypoint` - `Container!`	Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.
Arguments `args` - `[String!]!` Arguments of the entrypoint. Example: ["go", "run"]. `keepDefaultArgs` - `Boolean` Don't reset the default arguments when setting the entrypoint. By default it is reset, since entrypoint and default args are often tightly coupled.
`withEnvVariable` - `Container!`	Set a new environment variable in the container.
Arguments `name` - `String!` Name of the environment variable (e.g., "HOST"). `value` - `String!` Value of the environment variable. (e.g., "localhost"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value according to the current environment variables defined in the container (e.g. "/opt/bin:$PATH").
`withExec` - `Container!`	Execute a command in the container, and return a new snapshot of the container state after execution.
Arguments `args` - `[String!]!` Command to execute. Must be valid exec() arguments, not a shell command. Example: ["go", "run", "main.go"]. To run a shell command, execute the shell and pass the shell command as argument. Example: ["sh", "-c", "ls -l \| grep foo"] Defaults to the container's default arguments (see "defaultArgs" and "withDefaultArgs"). `useEntrypoint` - `Boolean` Apply the OCI entrypoint, if present, by prepending it to the args. Ignored by default. `stdin` - `String` Content to write to the command's standard input. Example: "Hello world") `redirectStdout` - `String` Redirect the command's standard output to a file in the container. Example: "./stdout.txt" `redirectStderr` - `String` Like redirectStdout, but for standard error `expect` - `ReturnType` Exit codes this command is allowed to exit with without error `experimentalPrivilegedNesting` - `Boolean` Provides Dagger access to the executed command. `insecureRootCapabilities` - `Boolean` Execute the command with all root capabilities. Like --privileged in Docker DANGER: this grants the command full access to the host system. Only use when 1) you trust the command being executed and 2) you specifically need this level of access. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo"). `noInit` - `Boolean` Skip the automatic init process injected into containers by default. Only use this if you specifically need the command to be pid 1 in the container. Otherwise it may result in unexpected behavior. If you're not sure, you don't need this.
`withExposedPort` - `Container!`	Expose a network port. Like EXPOSE in Dockerfile (but with healthcheck support) Exposed ports serve two purposes: For health checks and introspection, when running services For setting the EXPOSE OCI field when publishing the container
Arguments `port` - `Int!` Port number to expose. Example: 8080 `protocol` - `NetworkProtocol` Network protocol. Example: "tcp" `description` - `String` Port description. Example: "payment API endpoint" `experimentalSkipHealthcheck` - `Boolean` Skip the health check when run as a service.
`withFile` - `Container!`	Return a container snapshot with a file added
Arguments `path` - `String!` Path of the new file. Example: "/path/to/new-file.txt" `source` - `FileID!` File to add `permissions` - `Int` Permissions of the new file. Example: 0600 `owner` - `String` A user:group to set for the file. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`withFiles` - `Container!`	Retrieves this container plus the contents of the given files copied to the given path.
Arguments `path` - `String!` Location where copied files should be placed (e.g., "/src"). `sources` - `[FileID!]!` Identifiers of the files to copy. `permissions` - `Int` Permission given to the copied files (e.g., 0600). `owner` - `String` A user:group to set for the files. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`withLabel` - `Container!`	Retrieves this container plus the given label.
Arguments `name` - `String!` The name of the label (e.g., "org.opencontainers.artifact.created"). `value` - `String!` The value of the label (e.g., "2023-01-01T00:00:00Z").
`withMountedCache` - `Container!`	Retrieves this container plus a cache volume mounted at the given path.
Arguments `path` - `String!` Location of the cache directory (e.g., "/root/.npm"). `cache` - `CacheVolumeID!` Identifier of the cache volume to mount. `source` - `DirectoryID` Identifier of the directory to use as the cache volume's root. `sharing` - `CacheSharingMode` Sharing mode of the cache volume. `owner` - `String` A user:group to set for the mounted cache directory. Note that this changes the ownership of the specified mount along with the initial filesystem provided by source (if any). It does not have any effect if/when the cache has already been created. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withMountedDirectory` - `Container!`	Retrieves this container plus a directory mounted at the given path.
Arguments `path` - `String!` Location of the mounted directory (e.g., "/mnt/directory"). `source` - `DirectoryID!` Identifier of the mounted directory. `owner` - `String` A user:group to set for the mounted directory and its contents. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withMountedFile` - `Container!`	Retrieves this container plus a file mounted at the given path.
Arguments `path` - `String!` Location of the mounted file (e.g., "/tmp/file.txt"). `source` - `FileID!` Identifier of the mounted file. `owner` - `String` A user or user:group to set for the mounted file. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`withMountedSecret` - `Container!`	Retrieves this container plus a secret mounted into a file at the given path.
Arguments `path` - `String!` Location of the secret file (e.g., "/tmp/secret.txt"). `source` - `SecretID!` Identifier of the secret to mount. `owner` - `String` A user:group to set for the mounted secret. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `mode` - `Int` Permission given to the mounted secret (e.g., 0600). This option requires an owner to be set to be active. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withMountedTemp` - `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.
Arguments `path` - `String!` Location of the temporary directory (e.g., "/tmp/temp_dir"). `size` - `Int` Size of the temporary directory in bytes. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withNewFile` - `Container!`	Return a new container snapshot, with a file added to its filesystem with text content
Arguments `path` - `String!` Path of the new file. May be relative or absolute. Example: "README.md" or "/etc/profile" `contents` - `String!` Contents of the new file. Example: "Hello world!" `permissions` - `Int` Permissions of the new file. Example: 0600 `owner` - `String` A user:group to set for the file. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`withRegistryAuth` - `Container!`	Attach credentials for future publishing to a registry. Use in combination with publish
Arguments `address` - `String!` The image address that needs authentication. Same format as "docker push". Example: "registry.dagger.io/dagger:latest" `username` - `String!` The username to authenticate with. Example: "alice" `secret` - `SecretID!` The API key, password or token to authenticate to this registry
`withRootfs` - `Container!`	Change the container's root filesystem. The previous root filesystem will be lost.
Arguments `directory` - `DirectoryID!` The new root filesystem.
`withSecretVariable` - `Container!`	Set a new environment variable, using a secret value
Arguments `name` - `String!` Name of the secret variable (e.g., "API_SECRET"). `secret` - `SecretID!` Identifier of the secret value.
`withServiceBinding` - `Container!`	Establish a runtime dependency from a container to a network service. The service will be started automatically when needed and detached when it is no longer needed, executing the default command if none is set. The service will be reachable from the container via the provided hostname alias. The service dependency will also convey to any files or directories produced by the container.
Arguments `alias` - `String!` Hostname that will resolve to the target service (only accessible from within this container) `service` - `ServiceID!` The target service
`withSymlink` - `Container!`	Return a snapshot with a symlink
Arguments `target` - `String!` Location of the file or directory to link to (e.g., "/existing/file"). `linkName` - `String!` Location where the symbolic link will be created (e.g., "/new-file-link"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`withUnixSocket` - `Container!`	Retrieves this container plus a socket forwarded to the given Unix socket path.
Arguments `path` - `String!` Location of the forwarded Unix socket (e.g., "/tmp/socket"). `source` - `SocketID!` Identifier of the socket to forward. `owner` - `String` A user:group to set for the mounted socket. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user. `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withUser` - `Container!`	Retrieves this container with a different command user.
Arguments `name` - `String!` The user to set (e.g., "root").
`withWorkdir` - `Container!`	Change the container's working directory. Like WORKDIR in Dockerfile.
Arguments `path` - `String!` The path to set as the working directory (e.g., "/app"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withoutAnnotation` - `Container!`	Retrieves this container minus the given OCI annotation.
Arguments `name` - `String!` The name of the annotation.
`withoutDefaultArgs` - `Container!`	Remove the container's default arguments.
`withoutDirectory` - `Container!`	Return a new container snapshot, with a directory removed from its filesystem
Arguments `path` - `String!` Location of the directory to remove (e.g., ".github/"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withoutEntrypoint` - `Container!`	Reset the container's OCI entrypoint.
Arguments `keepDefaultArgs` - `Boolean` Don't remove the default arguments when unsetting the entrypoint.
`withoutEnvVariable` - `Container!`	Retrieves this container minus the given environment variable.
Arguments `name` - `String!` The name of the environment variable (e.g., "HOST").
`withoutExposedPort` - `Container!`	Unexpose a previously exposed port.
Arguments `port` - `Int!` Port number to unexpose `protocol` - `NetworkProtocol` Port protocol to unexpose
`withoutFile` - `Container!`	Retrieves this container with the file at the given path removed.
Arguments `path` - `String!` Location of the file to remove (e.g., "/file.txt"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`withoutFiles` - `Container!`	Return a new container spanshot with specified files removed
Arguments `paths` - `[String!]!` Paths of the files to remove. Example: ["foo.txt, "/root/.ssh/config" `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of paths according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
`withoutLabel` - `Container!`	Retrieves this container minus the given environment label.
Arguments `name` - `String!` The name of the label to remove (e.g., "org.opencontainers.artifact.created").
`withoutMount` - `Container!`	Retrieves this container after unmounting everything at the given path.
Arguments `path` - `String!` Location of the cache directory (e.g., "/root/.npm"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withoutRegistryAuth` - `Container!`	Retrieves this container without the registry authentication of a given address.
Arguments `address` - `String!` Registry's address to remove the authentication from. Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).
`withoutSecretVariable` - `Container!`	Retrieves this container minus the given environment variable containing the secret.
Arguments `name` - `String!` The name of the environment variable (e.g., "HOST").
`withoutUnixSocket` - `Container!`	Retrieves this container with a previously added Unix socket removed.
Arguments `path` - `String!` Location of the socket to remove (e.g., "/tmp/socket"). `expand` - `Boolean` Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
`withoutUser` - `Container!`	Retrieves this container with an unset command user. Should default to root.
`withoutWorkdir` - `Container!`	Unset the container's working directory. Should default to "/".
`workdir` - `String!`	Retrieves the working directory for all commands.

Types

ContainerID

Description

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

Types

CurrentModule

Description

Reflective module API provided to functions at runtime.

Fields

Field Name	Description
`id` - `CurrentModuleID!`	A unique identifier for this CurrentModule.
`name` - `String!`	The name of the module being executed in
`source` - `Directory!`	The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).
`workdir` - `Directory!`	Load a directory from the module's scratch working directory, including any changes that may have been made to it during module function execution.
Arguments `path` - `String!` Location of the directory to access (e.g., "."). `exclude` - `[String!]` Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git"]). `include` - `[String!]` Include only artifacts that match the given pattern (e.g., ["app/", "package."]).
`workdirFile` - `File!`	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.
Arguments `path` - `String!` Location of the file to retrieve (e.g., "README.md").

Types

CurrentModuleID

Description

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

Types

DirectoryID

Description

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

Types

Engine

Description

The Dagger engine configuration and state

Fields

Field Name	Description
`id` - `EngineID!`	A unique identifier for this Engine.
`localCache` - `EngineCache!`	The local (on-disk) cache for the Dagger engine

Types

EngineCache

Description

A cache storage for the Dagger engine

Fields

Field Name	Description
`entrySet` - `EngineCacheEntrySet!`	The current set of entries in the cache
Arguments `key` - `String`
`id` - `EngineCacheID!`	A unique identifier for this EngineCache.
`keepBytes` - `Int!`	The maximum bytes to keep in the cache without pruning, after which automatic pruning may kick in. Use minFreeSpace instead.
`maxUsedSpace` - `Int!`	The maximum bytes to keep in the cache without pruning.
`minFreeSpace` - `Int!`	The target amount of free disk space the garbage collector will attempt to leave.
`prune` - `Void`	Prune the cache of releaseable entries
Arguments `useDefaultPolicy` - `Boolean` Use the engine-wide default pruning policy if true, otherwise prune the whole cache of any releasable entries.
`reservedSpace` - `Int!`	The minimum amount of disk space this policy is guaranteed to retain.
`targetSpace` - `Int!`	The target number of bytes to keep when pruning.

Types

EngineCacheEntry

Description

An individual cache entry in a cache entry set

Fields

Field Name	Description
`activelyUsed` - `Boolean!`	Whether the cache entry is actively being used.
`createdTimeUnixNano` - `Int!`	The time the cache entry was created, in Unix nanoseconds.
`description` - `String!`	The description of the cache entry.
`diskSpaceBytes` - `Int!`	The disk space used by the cache entry.
`id` - `EngineCacheEntryID!`	A unique identifier for this EngineCacheEntry.
`mostRecentUseTimeUnixNano` - `Int!`	The most recent time the cache entry was used, in Unix nanoseconds.

Types

EngineCacheEntryID

Description

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

Types

EngineCacheEntrySet

Description

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

Fields

Field Name	Description
`diskSpaceBytes` - `Int!`	The total disk space used by the cache entries in this set.
`entries` - `[EngineCacheEntry!]!`	The list of individual cache entries in the set
`entryCount` - `Int!`	The number of cache entries in this set.
`id` - `EngineCacheEntrySetID!`	A unique identifier for this EngineCacheEntrySet.

Types

EngineCacheEntrySetID

Description

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

Types

EngineCacheID

Description

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

Types

EngineID

Description

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

Types

EnumTypeDef

Description

A definition of a custom enum defined in a Module.

Fields

Field Name	Description
`description` - `String!`	A doc string for the enum, if any.
`id` - `EnumTypeDefID!`	A unique identifier for this EnumTypeDef.
`members` - `[EnumValueTypeDef!]!`	The members of the enum.
`name` - `String!`	The name of the enum.
`sourceMap` - `SourceMap!`	The location of this enum declaration.
`sourceModuleName` - `String!`	If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.
`values` - `[EnumValueTypeDef!]!`	use members instead

Types

EnumTypeDefID

Description

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

Types

EnumValueTypeDef

Description

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

Fields

Field Name	Description
`description` - `String!`	A doc string for the enum member, if any.
`id` - `EnumValueTypeDefID!`	A unique identifier for this EnumValueTypeDef.
`name` - `String!`	The name of the enum member.
`sourceMap` - `SourceMap!`	The location of this enum member declaration.
`value` - `String!`	The value of the enum member

Types

EnumValueTypeDefID

Description

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

Types

Env

Fields

Field Name	Description
`id` - `EnvID!`	A unique identifier for this Env.
`input` - `Binding!`	retrieve an input value by name
Arguments `name` - `String!`
`inputs` - `[Binding!]!`	return all input values for the environment
`output` - `Binding!`	retrieve an output value by name
Arguments `name` - `String!`
`outputs` - `[Binding!]!`	return all output values for the environment
`withCacheVolumeInput` - `Env!`	Create or update a binding of type CacheVolume in the environment
Arguments `name` - `String!` The name of the binding `value` - `CacheVolumeID!` The CacheVolume value to assign to the binding `description` - `String!` The purpose of the input
`withCacheVolumeOutput` - `Env!`	Declare a desired CacheVolume output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withCloudInput` - `Env!`	Create or update a binding of type Cloud in the environment
Arguments `name` - `String!` The name of the binding `value` - `CloudID!` The Cloud value to assign to the binding `description` - `String!` The purpose of the input
`withCloudOutput` - `Env!`	Declare a desired Cloud output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withContainerInput` - `Env!`	Create or update a binding of type Container in the environment
Arguments `name` - `String!` The name of the binding `value` - `ContainerID!` The Container value to assign to the binding `description` - `String!` The purpose of the input
`withContainerOutput` - `Env!`	Declare a desired Container output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withDirectoryInput` - `Env!`	Create or update a binding of type Directory in the environment
Arguments `name` - `String!` The name of the binding `value` - `DirectoryID!` The Directory value to assign to the binding `description` - `String!` The purpose of the input
`withDirectoryOutput` - `Env!`	Declare a desired Directory output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withEnvInput` - `Env!`	Create or update a binding of type Env in the environment
Arguments `name` - `String!` The name of the binding `value` - `EnvID!` The Env value to assign to the binding `description` - `String!` The purpose of the input
`withEnvOutput` - `Env!`	Declare a desired Env output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withFileInput` - `Env!`	Create or update a binding of type File in the environment
Arguments `name` - `String!` The name of the binding `value` - `FileID!` The File value to assign to the binding `description` - `String!` The purpose of the input
`withFileOutput` - `Env!`	Declare a desired File output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withGitRefInput` - `Env!`	Create or update a binding of type GitRef in the environment
Arguments `name` - `String!` The name of the binding `value` - `GitRefID!` The GitRef value to assign to the binding `description` - `String!` The purpose of the input
`withGitRefOutput` - `Env!`	Declare a desired GitRef output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withGitRepositoryInput` - `Env!`	Create or update a binding of type GitRepository in the environment
Arguments `name` - `String!` The name of the binding `value` - `GitRepositoryID!` The GitRepository value to assign to the binding `description` - `String!` The purpose of the input
`withGitRepositoryOutput` - `Env!`	Declare a desired GitRepository output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withLLMInput` - `Env!`	Create or update a binding of type LLM in the environment
Arguments `name` - `String!` The name of the binding `value` - `LLMID!` The LLM value to assign to the binding `description` - `String!` The purpose of the input
`withLLMOutput` - `Env!`	Declare a desired LLM output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withModuleConfigClientInput` - `Env!`	Create or update a binding of type ModuleConfigClient in the environment
Arguments `name` - `String!` The name of the binding `value` - `ModuleConfigClientID!` The ModuleConfigClient value to assign to the binding `description` - `String!` The purpose of the input
`withModuleConfigClientOutput` - `Env!`	Declare a desired ModuleConfigClient output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withModuleInput` - `Env!`	Create or update a binding of type Module in the environment
Arguments `name` - `String!` The name of the binding `value` - `ModuleID!` The Module value to assign to the binding `description` - `String!` The purpose of the input
`withModuleOutput` - `Env!`	Declare a desired Module output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withModuleSourceInput` - `Env!`	Create or update a binding of type ModuleSource in the environment
Arguments `name` - `String!` The name of the binding `value` - `ModuleSourceID!` The ModuleSource value to assign to the binding `description` - `String!` The purpose of the input
`withModuleSourceOutput` - `Env!`	Declare a desired ModuleSource output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withSecretInput` - `Env!`	Create or update a binding of type Secret in the environment
Arguments `name` - `String!` The name of the binding `value` - `SecretID!` The Secret value to assign to the binding `description` - `String!` The purpose of the input
`withSecretOutput` - `Env!`	Declare a desired Secret output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withServiceInput` - `Env!`	Create or update a binding of type Service in the environment
Arguments `name` - `String!` The name of the binding `value` - `ServiceID!` The Service value to assign to the binding `description` - `String!` The purpose of the input
`withServiceOutput` - `Env!`	Declare a desired Service output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withSocketInput` - `Env!`	Create or update a binding of type Socket in the environment
Arguments `name` - `String!` The name of the binding `value` - `SocketID!` The Socket value to assign to the binding `description` - `String!` The purpose of the input
`withSocketOutput` - `Env!`	Declare a desired Socket output to be assigned in the environment
Arguments `name` - `String!` The name of the binding `description` - `String!` A description of the desired value of the binding
`withStringInput` - `Env!`	Create or update an input value of type string
Arguments `name` - `String!` The name of the binding `value` - `String!` The string value to assign to the binding `description` - `String!` The description of the input
`withStringOutput` - `Env!`	Create or update an input value of type string
Arguments `name` - `String!` The name of the binding `description` - `String!` The description of the output

Types

EnvID

Description

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

Types

EnvVariable

Description

An environment variable name and value.

Fields

Field Name	Description
`id` - `EnvVariableID!`	A unique identifier for this EnvVariable.
`name` - `String!`	The environment variable name.
`value` - `String!`	The environment variable value.

Types

EnvVariableID

Description

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

Types

Error

Fields

Field Name	Description
`id` - `ErrorID!`	A unique identifier for this Error.
`message` - `String!`	A description of the error.
`values` - `[ErrorValue!]!`	The extensions of the error.
`withValue` - `Error!`	Add a value to the error.
Arguments `name` - `String!` The name of the value. `value` - `JSON!` The value to store on the error.

Types

ErrorID

Description

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

Types

ErrorValue

Fields

Field Name	Description
`id` - `ErrorValueID!`	A unique identifier for this ErrorValue.
`name` - `String!`	The name of the value.
`value` - `JSON!`	The value.

Types

ErrorValueID

Description

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

Types

FieldTypeDef

Description

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

A field on an object has a static value, as opposed to a function on an object whose value is computed by invoking code (and can accept arguments).

Fields

Field Name	Description
`description` - `String!`	A doc string for the field, if any.
`id` - `FieldTypeDefID!`	A unique identifier for this FieldTypeDef.
`name` - `String!`	The name of the field in lowerCamelCase format.
`sourceMap` - `SourceMap!`	The location of this field declaration.
`typeDef` - `TypeDef!`	The type of the field.

Types

FieldTypeDefID

Description

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

Types

File

Description

A file.

Fields

Field Name	Description
`contents` - `String!`	Retrieves the contents of the file.
`digest` - `String!`	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.
Arguments `excludeMetadata` - `Boolean` If true, exclude metadata from the digest.
`export` - `String!`	Writes the file to a file path on the host.
Arguments `path` - `String!` Location of the written directory (e.g., "output.txt"). `allowParentDirPath` - `Boolean` If allowParentDirPath is true, the path argument can be a directory path, in which case the file will be created in that directory.
`id` - `FileID!`	A unique identifier for this File.
`name` - `String!`	Retrieves the name of the file.
`size` - `Int!`	Retrieves the size of the file, in bytes.
`sync` - `FileID!`	Force evaluation in the engine.
`withName` - `File!`	Retrieves this file with its name set to the given name.
Arguments `name` - `String!` Name to set file to.
`withTimestamps` - `File!`	Retrieves this file with its created/modified timestamps set to the given time.
Arguments `timestamp` - `Int!` Timestamp to set dir/files in. Formatted in seconds following Unix epoch (e.g., 1672531199).

Types

FileID

Description

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

Types

Function

Description

Function represents a resolver provided by a Module.

A function always evaluates against a parent object and is given a set of named arguments.

Fields

Field Name	Description
`args` - `[FunctionArg!]!`	Arguments accepted by the function, if any.
`description` - `String!`	A doc string for the function, if any.
`id` - `FunctionID!`	A unique identifier for this Function.
`name` - `String!`	The name of the function.
`returnType` - `TypeDef!`	The type returned by the function.
`sourceMap` - `SourceMap!`	The location of this function declaration.
`withArg` - `Function!`	Returns the function with the provided argument
Arguments `name` - `String!` The name of the argument `typeDef` - `TypeDefID!` The type of the argument `description` - `String` A doc string for the argument, if any `defaultValue` - `JSON` A default value to use for this argument if not explicitly set by the caller, if any `defaultPath` - `String` If the argument is a Directory or File type, default to load path from context directory, relative to root directory. `ignore` - `[String!]` Patterns to ignore when loading the contextual argument value. `sourceMap` - `SourceMapID` The source map for the argument definition.
`withDescription` - `Function!`	Returns the function with the given doc string.
Arguments `description` - `String!` The doc string to set.
`withSourceMap` - `Function!`	Returns the function with the given source map.
Arguments `sourceMap` - `SourceMapID!` The source map for the function definition.

Types

FunctionArg

Description

An argument accepted by a function.

This is a specification for an argument at function definition time, not an argument passed at function call time.

Fields

Field Name	Description
`defaultPath` - `String!`	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
`defaultValue` - `JSON!`	A default value to use for this argument when not explicitly set by the caller, if any.
`description` - `String!`	A doc string for the argument, if any.
`id` - `FunctionArgID!`	A unique identifier for this FunctionArg.
`ignore` - `[String!]!`	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.
`name` - `String!`	The name of the argument in lowerCamelCase format.
`sourceMap` - `SourceMap!`	The location of this arg declaration.
`typeDef` - `TypeDef!`	The type of the argument.

Types

FunctionArgID

Description

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

Types

FunctionCall

Description

An active function call.

Fields

Field Name	Description
`id` - `FunctionCallID!`	A unique identifier for this FunctionCall.
`inputArgs` - `[FunctionCallArgValue!]!`	The argument values the function is being invoked with.
`name` - `String!`	The name of the function being called.
`parent` - `JSON!`	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.
`parentName` - `String!`	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.
`returnError` - `Void`	Return an error from the function.
Arguments `error` - `ErrorID!` The error to return.
`returnValue` - `Void`	Set the return value of the function call to the provided value.
Arguments `value` - `JSON!` JSON serialization of the return value.

Types

FunctionCallArgValue

Description

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

Fields

Field Name	Description
`id` - `FunctionCallArgValueID!`	A unique identifier for this FunctionCallArgValue.
`name` - `String!`	The name of the argument.
`value` - `JSON!`	The value of the argument represented as a JSON serialized string.

Types

FunctionCallArgValueID

Description

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

Types

FunctionCallID

Description

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

Types

FunctionID

Description

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

Types

GeneratedCode

Description

The result of running an SDK's codegen.

Fields

Field Name	Description
`code` - `Directory!`	The directory containing the generated code.
`id` - `GeneratedCodeID!`	A unique identifier for this GeneratedCode.
`vcsGeneratedPaths` - `[String!]!`	List of paths to mark generated in version control (i.e. .gitattributes).
`vcsIgnoredPaths` - `[String!]!`	List of paths to ignore in version control (i.e. .gitignore).
`withVCSGeneratedPaths` - `GeneratedCode!`	Set the list of paths to mark generated in version control.
Arguments `paths` - `[String!]!`
`withVCSIgnoredPaths` - `GeneratedCode!`	Set the list of paths to ignore in version control.
Arguments `paths` - `[String!]!`

Types

GeneratedCodeID

Description

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

Types

GitRef

Description

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

Fields

Field Name	Description
`commit` - `String!`	The resolved commit id at this ref.
`id` - `GitRefID!`	A unique identifier for this GitRef.
`ref` - `String!`	The resolved ref name at this ref.
`tree` - `Directory!`	The filesystem tree at this ref.
Arguments `discardGitDir` - `Boolean` Set to true to discard .git directory. `depth` - `Int` The depth of the tree to fetch.

Types

GitRefID

Description

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

Types

GitRepository

Description

A git repository.

Fields

Field Name	Description
`branch` - `GitRef!`	Returns details of a branch.
Arguments `name` - `String!` Branch's name (e.g., "main").
`branches` - `[String!]!`	branches that match any of the given glob patterns.
Arguments `patterns` - `[String!]` Glob patterns (e.g., "refs/tags/v*").
`commit` - `GitRef!`	Returns details of a commit.
Arguments `id` - `String!` Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").
`head` - `GitRef!`	Returns details for HEAD.
`id` - `GitRepositoryID!`	A unique identifier for this GitRepository.
`ref` - `GitRef!`	Returns details of a ref.
Arguments `name` - `String!` Ref's name (can be a commit identifier, a tag name, a branch name, or a fully-qualified ref).
`tag` - `GitRef!`	Returns details of a tag.
Arguments `name` - `String!` Tag's name (e.g., "v0.3.9").
`tags` - `[String!]!`	tags that match any of the given glob patterns.
Arguments `patterns` - `[String!]` Glob patterns (e.g., "refs/tags/v*").
`withAuthHeader` - `GitRepository!`	Header to authenticate the remote with. Use "httpAuthHeader" in the constructor instead.
Arguments `header` - `SecretID!` Secret used to populate the Authorization HTTP header
`withAuthToken` - `GitRepository!`	Token to authenticate the remote with. Use "httpAuthToken" in the constructor instead.
Arguments `token` - `SecretID!` Secret used to populate the password during basic HTTP Authorization

Types

GitRepositoryID

Description

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

Types

Host

Description

Information about the host environment.

Fields

Field Name	Description
`directory` - `Directory!`	Accesses a directory on the host.
Arguments `path` - `String!` Location of the directory to access (e.g., "."). `exclude` - `[String!]` Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git"]). `include` - `[String!]` Include only artifacts that match the given pattern (e.g., ["app/", "package."]). `noCache` - `Boolean` If true, the directory will always be reloaded from the host.
`file` - `File!`	Accesses a file on the host.
Arguments `path` - `String!` Location of the file to retrieve (e.g., "README.md"). `noCache` - `Boolean` If true, the file will always be reloaded from the host.
`id` - `HostID!`	A unique identifier for this Host.
`service` - `Service!`	Creates a service that forwards traffic to a specified address via the host.
Arguments `ports` - `[PortForward!]!` Ports to expose via the service, forwarding through the host network. If a port's frontend is unspecified or 0, it defaults to the same as the backend port. An empty set of ports is not valid; an error will be returned. `host` - `String` Upstream host to forward traffic to.
`setSecretFile` - `Secret!`	Sets a secret given a user-defined name and the file path on the host, and returns the secret. The file is limited to a size of 512000 bytes. setSecretFile is superceded by use of the secret API with file:// URIs
Arguments `name` - `String!` The user defined name for this secret. `path` - `String!` Location of the file to set as a secret.
`tunnel` - `Service!`	Creates a tunnel that forwards traffic from the host to a service.
Arguments `service` - `ServiceID!` Service to send traffic from the tunnel. `native` - `Boolean` Map each service port to the same port on the host, as if the service were running natively. Note: enabling may result in port conflicts. `ports` - `[PortForward!]` Configure explicit port forwarding rules for the tunnel. If a port's frontend is unspecified or 0, a random port will be chosen by the host. If no ports are given, all of the service's ports are forwarded. If native is true, each port maps to the same port on the host. If native is false, each port maps to a random port chosen by the host. If ports are given and native is true, the ports are additive.
`unixSocket` - `Socket!`	Accesses a Unix socket on the host.
Arguments `path` - `String!` Location of the Unix socket (e.g., "/var/run/docker.sock").

Types

HostID

Description

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

Types

ImageLayerCompression

Description

Compression algorithm to use for image layers.

Values

Enum Value	Description
`Gzip`
`Zstd`
`EStarGZ`
`Uncompressed`
`GZIP`
`ZSTD`
`ESTARGZ`
`UNCOMPRESSED`

Example

"Gzip"

Types

ImageMediaTypes

Description

Mediatypes to use in published or exported image metadata.

Values

Enum Value	Description
`OCIMediaTypes`
`DockerMediaTypes`
`OCI`
`DOCKER`

Example

"OCIMediaTypes"

Types

InputTypeDef

Description

A graphql input type, which is essentially just a group of named args. This is currently only used to represent pre-existing usage of graphql input types in the core API. It is not used by user modules and shouldn't ever be as user module accept input objects via their id rather than graphql input types.

Fields

Field Name	Description
`fields` - `[FieldTypeDef!]!`	Static fields defined on this input object, if any.
`id` - `InputTypeDefID!`	A unique identifier for this InputTypeDef.
`name` - `String!`	The name of the input object.

Types

InputTypeDefID

Description

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

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Types

InterfaceTypeDef

Description

A definition of a custom interface defined in a Module.

Fields

Field Name	Description
`description` - `String!`	The doc string for the interface, if any.
`functions` - `[Function!]!`	Functions defined on this interface, if any.
`id` - `InterfaceTypeDefID!`	A unique identifier for this InterfaceTypeDef.
`name` - `String!`	The name of the interface.
`sourceMap` - `SourceMap!`	The location of this interface declaration.
`sourceModuleName` - `String!`	If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.

Types

InterfaceTypeDefID

Description

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

Types

JSON

Description

An arbitrary JSON-encoded value.

Types

LLM

Fields

Field Name	Description
`attempt` - `LLM!`	create a branch in the LLM's history
Arguments `number` - `Int!`
`bindResult` - `Binding`	returns the type of the current state
Arguments `name` - `String!`
`env` - `Env!`	return the LLM's current environment
`history` - `[String!]!`	return the llm message history
`historyJSON` - `JSON!`	return the raw llm message history as json
`id` - `LLMID!`	A unique identifier for this LLM.
`lastReply` - `String!`	return the last llm reply from the history
`loop` - `LLM!`	synchronize LLM state
`model` - `String!`	return the model used by the llm
`provider` - `String!`	return the provider used by the llm
`sync` - `LLMID!`	synchronize LLM state
`tokenUsage` - `LLMTokenUsage!`	returns the token usage of the current state
`tools` - `String!`	print documentation for available tools
`withEnv` - `LLM!`	allow the LLM to interact with an environment via MCP
Arguments `env` - `EnvID!`
`withModel` - `LLM!`	swap out the llm model
Arguments `model` - `String!` The model to use
`withPrompt` - `LLM!`	append a prompt to the llm context
Arguments `prompt` - `String!` The prompt to send
`withPromptFile` - `LLM!`	append the contents of a file to the llm context
Arguments `file` - `FileID!` The file to read the prompt from
`withSystemPrompt` - `LLM!`	Add a system prompt to the LLM's environment
Arguments `prompt` - `String!` The system prompt to send
`withoutDefaultSystemPrompt` - `LLM!`	Disable the default system prompt

Types

LLMID

Description

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

Types

LLMTokenUsage

Fields

Field Name	Description
`cachedTokenReads` - `Int!`
`cachedTokenWrites` - `Int!`
`id` - `LLMTokenUsageID!`	A unique identifier for this LLMTokenUsage.
`inputTokens` - `Int!`
`outputTokens` - `Int!`
`totalTokens` - `Int!`

Types

LLMTokenUsageID

Description

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

Types

Label

Description

A simple key value object that represents a label.

Fields

Field Name	Description
`id` - `LabelID!`	A unique identifier for this Label.
`name` - `String!`	The label name.
`value` - `String!`	The label value.

Types

LabelID

Description

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

Types

ListTypeDef

Description

A definition of a list type in a Module.

Fields

Field Name	Description
`elementTypeDef` - `TypeDef!`	The type of the elements in the list.
`id` - `ListTypeDefID!`	A unique identifier for this ListTypeDef.

Types

ListTypeDefID

Description

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

Types

Module

Description

A Dagger module.

Fields

Field Name	Description
`dependencies` - `[Module!]!`	The dependencies of the module.
`description` - `String!`	The doc string of the module, if any
`enums` - `[TypeDef!]!`	Enumerations served by this module.
`generatedContextDirectory` - `Directory!`	The generated files and directories made on top of the module source's context directory.
`id` - `ModuleID!`	A unique identifier for this Module.
`interfaces` - `[TypeDef!]!`	Interfaces served by this module.
`name` - `String!`	The name of the module
`objects` - `[TypeDef!]!`	Objects served by this module.
`runtime` - `Container!`	The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
`sdk` - `SDKConfig`	The SDK config used by this module.
`serve` - `Void`	Serve a module's API in the current session. Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect.
Arguments `includeDependencies` - `Boolean` Expose the dependencies of this module to the client
`source` - `ModuleSource!`	The source for the module.
`sync` - `ModuleID!`	Forces evaluation of the module, including any loading into the engine and associated validation.
`withDescription` - `Module!`	Retrieves the module with the given description
Arguments `description` - `String!` The description to set
`withEnum` - `Module!`	This module plus the given Enum type and associated values
Arguments `enum` - `TypeDefID!`
`withInterface` - `Module!`	This module plus the given Interface type and associated functions
Arguments `iface` - `TypeDefID!`
`withObject` - `Module!`	This module plus the given Object type and associated functions.
Arguments `object` - `TypeDefID!`

Types

ModuleConfigClient

Description

The client generated for the module.

Fields

Field Name	Description
`directory` - `String!`	The directory the client is generated in.
`generator` - `String!`	The generator to use
`id` - `ModuleConfigClientID!`	A unique identifier for this ModuleConfigClient.

Types

ModuleConfigClientID

Description

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

Types

ModuleID

Description

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

Types

ModuleSource

Description

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

Fields

Field Name	Description
`asModule` - `Module!`	Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation
`asString` - `String!`	A human readable ref string representation of this module source.
`cloneRef` - `String!`	The ref to clone the root of the git repo from. Only valid for git sources.
`commit` - `String!`	The resolved commit of the git repo this source points to.
`configClients` - `[ModuleConfigClient!]!`	The clients generated for the module.
`configExists` - `Boolean!`	Whether an existing dagger.json for the module was found.
`contextDirectory` - `Directory!`	The full directory loaded for the module source, including the source code as a subdirectory.
`dependencies` - `[ModuleSource!]!`	The dependencies of the module source.
`digest` - `String!`	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.
`directory` - `Directory!`	The directory containing the module configuration and source code (source code may be in a subdir).
Arguments `path` - `String!` A subpath from the source directory to select.
`engineVersion` - `String!`	The engine version of the module.
`generatedContextDirectory` - `Directory!`	The generated files and directories made on top of the module source's context directory.
`htmlRepoURL` - `String!`	The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket).
`htmlURL` - `String!`	The URL to the source's git repo in a web browser. Only valid for git sources.
`id` - `ModuleSourceID!`	A unique identifier for this ModuleSource.
`kind` - `ModuleSourceKind!`	The kind of module source (currently local, git or dir).
`localContextDirectoryPath` - `String!`	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.
`moduleName` - `String!`	The name of the module, including any setting via the withName API.
`moduleOriginalName` - `String!`	The original name of the module as read from the module's dagger.json (or set for the first time with the withName API).
`originalSubpath` - `String!`	The original subpath used when instantiating this module source, relative to the context directory.
`pin` - `String!`	The pinned version of this module source.
`repoRootPath` - `String!`	The import path corresponding to the root of the git repo this source points to. Only valid for git sources.
`sdk` - `SDKConfig`	The SDK configuration of the module.
`sourceRootSubpath` - `String!`	The path, relative to the context directory, that contains the module's dagger.json.
`sourceSubpath` - `String!`	The path to the directory containing the module's source code, relative to the context directory.
`sync` - `ModuleSourceID!`	Forces evaluation of the module source, including any loading into the engine and associated validation.
`version` - `String!`	The specified version of the git repo this source points to.
`withClient` - `ModuleSource!`	Update the module source with a new client to generate.
Arguments `generator` - `String!` The generator to use `outputDir` - `String!` The output directory for the generated client.
`withDependencies` - `ModuleSource!`	Append the provided dependencies to the module source's dependency list.
Arguments `dependencies` - `[ModuleSourceID!]!` The dependencies to append.
`withEngineVersion` - `ModuleSource!`	Upgrade the engine version of the module to the given value.
Arguments `version` - `String!` The engine version to upgrade to.
`withIncludes` - `ModuleSource!`	Update the module source with additional include patterns for files+directories from its context that are required for building it
Arguments `patterns` - `[String!]!` The new additional include patterns.
`withName` - `ModuleSource!`	Update the module source with a new name.
Arguments `name` - `String!` The name to set.
`withSDK` - `ModuleSource!`	Update the module source with a new SDK.
Arguments `source` - `String!` The SDK source to set.
`withSourceSubpath` - `ModuleSource!`	Update the module source with a new source subpath.
Arguments `path` - `String!` The path to set as the source subpath. Must be relative to the module source's source root directory.
`withUpdateDependencies` - `ModuleSource!`	Update one or more module dependencies.
Arguments `dependencies` - `[String!]!` The dependencies to update.
`withoutClient` - `ModuleSource!`	Remove a client from the module source.
Arguments `path` - `String!` The path of the client to remove.
`withoutDependencies` - `ModuleSource!`	Remove the provided dependencies from the module source's dependency list.
Arguments `dependencies` - `[String!]!` The dependencies to remove.

Types

ModuleSourceID

Description

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

Types

ModuleSourceKind

Description

The kind of module source.

Values

Enum Value	Description
`LOCAL_SOURCE`
`GIT_SOURCE`
`DIR_SOURCE`
`LOCAL`
`GIT`
`DIR`

Example

"LOCAL_SOURCE"

Types

NetworkProtocol

Description

Transport layer network protocol associated to a port.

Values

Enum Value	Description
`TCP`
`UDP`

Example

"TCP"

Types

ObjectTypeDef

Description

A definition of a custom object defined in a Module.

Fields

Field Name	Description
`constructor` - `Function`	The function used to construct new instances of this object, if any
`description` - `String!`	The doc string for the object, if any.
`fields` - `[FieldTypeDef!]!`	Static fields defined on this object, if any.
`functions` - `[Function!]!`	Functions defined on this object, if any.
`id` - `ObjectTypeDefID!`	A unique identifier for this ObjectTypeDef.
`name` - `String!`	The name of the object.
`sourceMap` - `SourceMap!`	The location of this object declaration.
`sourceModuleName` - `String!`	If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.

Types

ObjectTypeDefID

Description

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

Types

PipelineLabel

Description

Key value object that represents a pipeline label.

Fields

Input Field	Description
`name` - `String!`	Label name.
`value` - `String!`	Label value.

Example

{
  "name": "abc123",
  "value": "abc123"
}

Types

Platform

Description

The platform config OS and architecture in a Container.

The format is [os]/[platform]/[version] (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64").

Types

Port

Description

A port exposed by a container.

Fields

Field Name	Description
`description` - `String`	The port description.
`experimentalSkipHealthcheck` - `Boolean!`	Skip the health check when run as a service.
`id` - `PortID!`	A unique identifier for this Port.
`port` - `Int!`	The port number.
`protocol` - `NetworkProtocol!`	The transport layer protocol.

Types

PortForward

Description

Port forwarding rules for tunneling network traffic.

Fields

Input Field	Description
`frontend` - `Int`	Port to expose to clients. If unspecified, a default will be chosen.
`backend` - `Int!`	Destination port for traffic.
`protocol` - `NetworkProtocol`	Transport layer protocol to use for traffic.

Example

{"frontend": 123, "backend": 123, "protocol": "TCP"}

Types

PortID

Description

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

Types

ReturnType

Description

Expected return type of an execution

Values

Enum Value	Description
`SUCCESS`	A successful execution (exit code 0)
`FAILURE`	A failed execution (exit codes 1-127)
`ANY`	Any execution (exit codes 0-127)

Example

"SUCCESS"

Types

SDKConfig

Description

The SDK config of the module.

Fields

Field Name	Description
`id` - `SDKConfigID!`	A unique identifier for this SDKConfig.
`source` - `String!`	Source of the SDK. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation.

Types

SDKConfigID

Description

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

Types

ScalarTypeDef

Description

A definition of a custom scalar defined in a Module.

Fields

Field Name	Description
`description` - `String!`	A doc string for the scalar, if any.
`id` - `ScalarTypeDefID!`	A unique identifier for this ScalarTypeDef.
`name` - `String!`	The name of the scalar.
`sourceModuleName` - `String!`	If this ScalarTypeDef is associated with a Module, the name of the module. Unset otherwise.

Types

ScalarTypeDefID

Description

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

Types

Secret

Description

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

Fields

Field Name	Description
`id` - `SecretID!`	A unique identifier for this Secret.
`name` - `String!`	The name of this secret.
`plaintext` - `String!`	The value of this secret.
`uri` - `String!`	The URI of this secret.

Types

SecretID

Description

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

Types

Service

Description

A content-addressed service providing TCP connectivity.

Fields

Field Name	Description
`endpoint` - `String!`	Retrieves an endpoint that clients can use to reach this container. If no port is specified, the first exposed port is used. If none exist an error is returned. If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.
Arguments `port` - `Int` The exposed port number for the endpoint `scheme` - `String` Return a URL with the given scheme, eg. http for http://
`hostname` - `String!`	Retrieves a hostname which can be used by clients to reach this container.
`id` - `ServiceID!`	A unique identifier for this Service.
`ports` - `[Port!]!`	Retrieves the list of ports provided by the service.
`start` - `ServiceID!`	Start the service and wait for its health checks to succeed. Services bound to a Container do not need to be manually started.
`stop` - `ServiceID!`	Stop the service.
Arguments `kill` - `Boolean` Immediately kill the service without waiting for a graceful exit
`up` - `Void`	Creates a tunnel that forwards traffic from the caller's network to this service.
Arguments `ports` - `[PortForward!]` List of frontend/backend port mappings to forward. Frontend is the port accepting traffic on the host, backend is the service port. `random` - `Boolean` Bind each tunnel port to a random port on the host.
`withHostname` - `Service!`	Configures a hostname which can be used by clients within the session to reach this container.
Arguments `hostname` - `String!` The hostname to use.

Types

ServiceID

Description

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

Types

Socket

Description

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

Fields

Field Name	Description
`id` - `SocketID!`	A unique identifier for this Socket.

Types

SocketID

Description

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

Types

SourceMap

Description

Source location information.

Fields

Field Name	Description
`column` - `Int!`	The column number within the line.
`filename` - `String!`	The filename from the module source.
`id` - `SourceMapID!`	A unique identifier for this SourceMap.
`line` - `Int!`	The line number within the filename.
`module` - `String!`	The module dependency this was declared in.

Types

SourceMapID

Description

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

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Types

Terminal

Description

An interactive terminal that clients can connect to.

Fields

Field Name Description

id - TerminalID! A unique identifier for this Terminal.

sync - TerminalID!

Forces evaluation of the pipeline in the engine.

It doesn't run the default command if no exec has been set.

Types

TerminalID

Description

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

Types

TypeDef

Description

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

Fields

Field Name	Description
`asEnum` - `EnumTypeDef`	If kind is ENUM, the enum-specific type definition. If kind is not ENUM, this will be null.
`asInput` - `InputTypeDef`	If kind is INPUT, the input-specific type definition. If kind is not INPUT, this will be null.
`asInterface` - `InterfaceTypeDef`	If kind is INTERFACE, the interface-specific type definition. If kind is not INTERFACE, this will be null.
`asList` - `ListTypeDef`	If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.
`asObject` - `ObjectTypeDef`	If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.
`asScalar` - `ScalarTypeDef`	If kind is SCALAR, the scalar-specific type definition. If kind is not SCALAR, this will be null.
`id` - `TypeDefID!`	A unique identifier for this TypeDef.
`kind` - `TypeDefKind!`	The kind of type this is (e.g. primitive, list, object).
`optional` - `Boolean!`	Whether this type can be set to null. Defaults to false.
`withConstructor` - `TypeDef!`	Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object.
Arguments `function` - `FunctionID!`
`withEnum` - `TypeDef!`	Returns a TypeDef of kind Enum with the provided name. Note that an enum's values may be omitted if the intent is only to refer to an enum. This is how functions are able to return their own, or any other circular reference.
Arguments `name` - `String!` The name of the enum `description` - `String` A doc string for the enum, if any `sourceMap` - `SourceMapID` The source map for the enum definition.
`withEnumMember` - `TypeDef!`	Adds a static value for an Enum TypeDef, failing if the type is not an enum.
Arguments `name` - `String!` The name of the member in the enum `value` - `String` The value of the member in the enum `description` - `String` A doc string for the member, if any `sourceMap` - `SourceMapID` The source map for the enum member definition.
`withEnumValue` - `TypeDef!`	Adds a static value for an Enum TypeDef, failing if the type is not an enum. Use `withEnumMember` instead
Arguments `value` - `String!` The name of the value in the enum `description` - `String` A doc string for the value, if any `sourceMap` - `SourceMapID` The source map for the enum value definition.
`withField` - `TypeDef!`	Adds a static field for an Object TypeDef, failing if the type is not an object.
Arguments `name` - `String!` The name of the field in the object `typeDef` - `TypeDefID!` The type of the field `description` - `String` A doc string for the field, if any `sourceMap` - `SourceMapID` The source map for the field definition.
`withFunction` - `TypeDef!`	Adds a function for an Object or Interface TypeDef, failing if the type is not one of those kinds.
Arguments `function` - `FunctionID!`
`withInterface` - `TypeDef!`	Returns a TypeDef of kind Interface with the provided name.
Arguments `name` - `String!` `description` - `String` `sourceMap` - `SourceMapID`
`withKind` - `TypeDef!`	Sets the kind of the type.
Arguments `kind` - `TypeDefKind!`
`withListOf` - `TypeDef!`	Returns a TypeDef of kind List with the provided type for its elements.
Arguments `elementType` - `TypeDefID!`
`withObject` - `TypeDef!`	Returns a TypeDef of kind Object with the provided name. Note that an object's fields and functions may be omitted if the intent is only to refer to an object. This is how functions are able to return their own object, or any other circular reference.
Arguments `name` - `String!` `description` - `String` `sourceMap` - `SourceMapID`
`withOptional` - `TypeDef!`	Sets whether this type can be set to null.
Arguments `optional` - `Boolean!`
`withScalar` - `TypeDef!`	Returns a TypeDef of kind Scalar with the provided name.
Arguments `name` - `String!` `description` - `String`

Types

TypeDefID

Description

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

Types

TypeDefKind

Description

Distinguishes the different kinds of TypeDefs.

Values

Enum Value	Description
`STRING_KIND`	A string value.
`INTEGER_KIND`	An integer value.
`FLOAT_KIND`	A float value.
`BOOLEAN_KIND`	A boolean value.
`SCALAR_KIND`	A scalar value of any basic kind.
`LIST_KIND`	Always paired with a ListTypeDef. A list of values all having the same type.
`OBJECT_KIND`	Always paired with an ObjectTypeDef. A named type defined in the GraphQL schema, with fields and functions.
`INTERFACE_KIND`	Always paired with an InterfaceTypeDef. A named type of functions that can be matched+implemented by other objects+interfaces.
`INPUT_KIND`	A graphql input type, used only when representing the core API via TypeDefs.
`VOID_KIND`	A special kind used to signify that no value is returned. This is used for functions that have no return value. The outer TypeDef specifying this Kind is always Optional, as the Void is never actually represented.
`ENUM_KIND`	A GraphQL enum type and its values Always paired with an EnumTypeDef.
`STRING`	A string value.
`INTEGER`	An integer value.
`FLOAT`	A float value.
`BOOLEAN`	A boolean value.
`SCALAR`	A scalar value of any basic kind.
`LIST`	Always paired with a ListTypeDef. A list of values all having the same type.
`OBJECT`	Always paired with an ObjectTypeDef. A named type defined in the GraphQL schema, with fields and functions.
`INTERFACE`	Always paired with an InterfaceTypeDef. A named type of functions that can be matched+implemented by other objects+interfaces.
`INPUT`	A graphql input type, used only when representing the core API via TypeDefs.
`VOID`	A special kind used to signify that no value is returned. This is used for functions that have no return value. The outer TypeDef specifying this Kind is always Optional, as the Void is never actually represented.
`ENUM`	A GraphQL enum type and its values Always paired with an EnumTypeDef.

Example

"STRING_KIND"

Types

Void

Description

The absence of a value.

A Null Void is used as a placeholder for resolvers that do not return anything.

Documentation by Anvil SpectaQL

Field Name	Description
`asGit` - `GitRepository!`	Converts this directory to a local git repository
`asModule` - `Module!`	Load the directory as a Dagger module source
Arguments `sourceRootPath` - `String` An optional subpath of the directory which contains the module's configuration file. If not set, the module source code is loaded from the root of the directory.
`asModuleSource` - `ModuleSource!`	Load the directory as a Dagger module source
Arguments `sourceRootPath` - `String` An optional subpath of the directory which contains the module's configuration file. If not set, the module source code is loaded from the root of the directory.
`diff` - `Directory!`	Return the difference between this directory and an another directory. The difference is encoded as a directory.
Arguments `other` - `DirectoryID!` The directory to compare against
`digest` - `String!`	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!`	Retrieves a directory at the given path.
Arguments `path` - `String!` Location of the directory to retrieve. Example: "/src"
`dockerBuild` - `Container!`	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.
Arguments `dockerfile` - `String` Path to the Dockerfile to use (e.g., "frontend.Dockerfile"). `platform` - `Platform` The platform to build. `buildArgs` - `[BuildArg!]` Build arguments to use in the build. `target` - `String` Target build stage to build. `secrets` - `[SecretID!]` Secrets to pass to the build. They will be mounted at /run/secrets/[secret-name]. `noInit` - `Boolean` If set, skip the automatic init process injected into containers created by RUN statements. This should only be used if the user requires that their exec processes be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
`entries` - `[String!]!`	Returns a list of files and directories at the given path.
Arguments `path` - `String` Location of the directory to look at (e.g., "/src").
`export` - `String!`	Writes the contents of the directory to a path on the host.
Arguments `path` - `String!` Location of the copied directory (e.g., "logs/"). `wipe` - `Boolean` If true, then the host directory will be wiped clean before exporting so that it exactly matches the directory being exported; this means it will delete any files on the host that aren't in the exported dir. If false (the default), the contents of the directory will be merged with any existing contents of the host directory, leaving any existing files on the host that aren't in the exported directory alone.
`file` - `File!`	Retrieve a file at the given path.
Arguments `path` - `String!` Location of the file to retrieve (e.g., "README.md").
`filter` - `Directory!`	Return a snapshot with some paths included or excluded
Arguments `exclude` - `[String!]` If set, paths matching one of these glob patterns is excluded from the new snapshot. Example: ["node_modules/", ".git", ".env"] `include` - `[String!]` If set, only paths matching one of these glob patterns is included in the new snapshot. Example: (e.g., ["app/", "package."]).
`glob` - `[String!]!`	Returns a list of files and directories that matche the given pattern.
Arguments `pattern` - `String!` Pattern to match (e.g., "*.md").
`id` - `DirectoryID!`	A unique identifier for this Directory.
`name` - `String!`	Returns the name of the directory.
`sync` - `DirectoryID!`	Force evaluation in the engine.
`terminal` - `Directory!`	Opens an interactive terminal in new container with this directory mounted inside.
Arguments `container` - `ContainerID` If set, override the default container used for the terminal. `cmd` - `[String!]` If set, override the container's default terminal command and invoke these command arguments instead. `experimentalPrivilegedNesting` - `Boolean` Provides Dagger access to the executed command. `insecureRootCapabilities` - `Boolean` Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
`withDirectory` - `Directory!`	Return a snapshot with a directory added
Arguments `path` - `String!` Location of the written directory (e.g., "/src/"). `directory` - `DirectoryID!` Identifier of the directory to copy. `exclude` - `[String!]` Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git"]). `include` - `[String!]` Include only artifacts that match the given pattern (e.g., ["app/", "package."]).
`withFile` - `Directory!`	Retrieves this directory plus the contents of the given file copied to the given path.
Arguments `path` - `String!` Location of the copied file (e.g., "/file.txt"). `source` - `FileID!` Identifier of the file to copy. `permissions` - `Int` Permission given to the copied file (e.g., 0600).
`withFiles` - `Directory!`	Retrieves this directory plus the contents of the given files copied to the given path.
Arguments `path` - `String!` Location where copied files should be placed (e.g., "/src"). `sources` - `[FileID!]!` Identifiers of the files to copy. `permissions` - `Int` Permission given to the copied files (e.g., 0600).
`withNewDirectory` - `Directory!`	Retrieves this directory plus a new directory created at the given path.
Arguments `path` - `String!` Location of the directory created (e.g., "/logs"). `permissions` - `Int` Permission granted to the created directory (e.g., 0777).
`withNewFile` - `Directory!`	Return a snapshot with a new file added
Arguments `path` - `String!` Path of the new file. Example: "foo/bar.txt" `contents` - `String!` Contents of the new file. Example: "Hello world!" `permissions` - `Int` Permissions of the new file. Example: 0600
`withSymlink` - `Directory!`	Return a snapshot with a symlink
Arguments `target` - `String!` Location of the file or directory to link to (e.g., "/existing/file"). `linkName` - `String!` Location where the symbolic link will be created (e.g., "/new-file-link").
`withTimestamps` - `Directory!`	Retrieves this directory with all file/dir timestamps set to the given time.
Arguments `timestamp` - `Int!` Timestamp to set dir/files in. Formatted in seconds following Unix epoch (e.g., 1672531199).
`withoutDirectory` - `Directory!`	Return a snapshot with a subdirectory removed
Arguments `path` - `String!` Path of the subdirectory to remove. Example: ".github/workflows"
`withoutFile` - `Directory!`	Return a snapshot with a file removed
Arguments `path` - `String!` Path of the file to remove (e.g., "/file.txt").
`withoutFiles` - `Directory!`	Return a snapshot with files removed
Arguments `paths` - `[String!]!` Paths of the files to remove (e.g., ["/file.txt"]).