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
  }
}

Try it in the API Playground!

Queries

`checkVersionCompatibility`

Description

Checks if the current Dagger Engine is compatible with an SDK's required version.

Type

Boolean!

Arguments

Name	Description
`version` - `String!`	The SDK's required version.

Example

Queries

`container`

Description

Creates a scratch container or loads one by ID.

Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder's host.

Type

Container!

Arguments

Name	Description
`id` - `ContainerID`	Use `loadContainerFromID` instead.
`platform` - `Platform`

Example

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

Try it in the API Playground!

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

Module

Example

Queries

`defaultPlatform`

Description

The default platform of the builder.

Type

Platform!

Example

query {
  defaultPlatform
}

Try it in the API Playground!

Queries

`directory`

Description

Creates an empty directory or loads one by ID.

Type

Directory!

Arguments

Name	Description
`id` - `DirectoryID`	Use `loadDirectoryFromID` instead.

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
          }
        }
      }
    }
  }
}

Try it in the API Playground!

Queries

`file`

Use loadFileFromID instead.

Description

Loads a file by ID.

Type

File

Arguments

Name	Description
`id` - `FileID!`

Example

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

Try it in the API Playground!

Queries

`function`

Description

Create a function.

Type

Function!

Arguments

Name	Description
`name` - `String!`
`returnType` - `TypeDefID!`

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`	Set to true to keep .git directory.
`sshKnownHosts` - `String`	Set SSH known hosts
`sshAuthSocket` - `SocketID`	Set SSH auth socket
`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
        }
      }
    }
  }
}

Try it in the API Playground!

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: ".")
      }
    }
  }
}

Try it in the API Playground!

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").
`experimentalServiceHost` - `ServiceID`	A service which must be started before the URL is fetched.

Example

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

Try it in the API Playground!

Queries

`loadCacheVolumeFromID`

Description

Load a CacheVolume from its ID.

Type

CacheVolume!

Arguments

Name	Description
`id` - `CacheVolumeID!`

Example

Queries

`loadContainerFromID`

Description

Loads a container from an ID.

Type

Container!

Arguments

Name	Description
`id` - `ContainerID!`

Example

Queries

`loadDirectoryFromID`

Description

Load a Directory from its ID.

Type

Directory!

Arguments

Name	Description
`id` - `DirectoryID!`

Example

Queries

`loadFileFromID`

Description

Load a File from its ID.

Type

File!

Arguments

Name	Description
`id` - `FileID!`

Example

Queries

`loadFunctionArgFromID`

Description

Load a function argument by ID.

Type

FunctionArg!

Arguments

Name	Description
`id` - `FunctionArgID!`

Example

Queries

`loadFunctionFromID`

Description

Load a function by ID.

Type

Function!

Arguments

Name	Description
`id` - `FunctionID!`

Example

Queries

`loadGeneratedCodeFromID`

Description

Load a GeneratedCode by ID.

Type

GeneratedCode!

Arguments

Name	Description
`id` - `GeneratedCodeID!`

Example

Queries

`loadModuleFromID`

Description

Load a module by ID.

Type

Module!

Arguments

Name	Description
`id` - `ModuleID!`

Example

Queries

`loadSecretFromID`

Description

Load a Secret from its ID.

Type

Secret!

Arguments

Name	Description
`id` - `SecretID!`

Example

Queries

`loadServiceFromID`

Description

Loads a service from 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

`loadTypeDefFromID`

Description

Load a TypeDef by ID.

Type

TypeDef!

Arguments

Name	Description
`id` - `TypeDefID!`

Example

Queries

`module`

Description

Create a new module.

Type

Module!

Example

Queries

`moduleConfig`

Description

Load the static configuration for a module from the given source directory and optional subpath.

Type

ModuleConfig!

Arguments

Name	Description
`sourceDirectory` - `DirectoryID!`
`subpath` - `String`

Example

Queries

`pipeline`

Description

Creates a named sub-pipeline.

Type

Query!

Arguments

Name	Description
`name` - `String!`	Pipeline name.
`description` - `String`	Pipeline description.
`labels` - `[PipelineLabel!]`	Pipeline labels.

Example

query {
  pipeline(name: "build", description: "Builds the app container") {
    container {
      id
    }
  }
}

Try it in the API Playground!

Queries

`secret`

Use loadSecretFromID instead

Description

Loads a secret from its ID.

Type

Secret!

Arguments

Name	Description
`id` - `SecretID!`

Example

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

Try it in the API Playground!

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

`socket`

Use loadSocketFromID instead.

Description

Loads a socket by its ID.

Type

Socket!

Arguments

Name	Description
`id` - `SocketID`

Example

query {
  socket(id: "eyJob3N0X3BhdGgiOiIvdmFyL3J1bi9kb2NrZXIuc29jayJ9") {
    id
  }
}

Try it in the API Playground!

Queries

`typeDef`

Description

Create a new TypeDef.

Type

TypeDef!

Example

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": "xyz789"
}

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!`

Types

CacheVolumeID

Description

A global cache volume identifier.

Types

Container

Description

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

Fields

Field Name	Description
`id` - `ContainerID!`	A unique identifier for this container.
`sync` - `ContainerID!`	Forces evaluation of the pipeline in the engine. It doesn't run the default command if no exec has been set.
`platform` - `Platform!`	The platform this container executes and publishes as.
`pipeline` - `Container!`	Creates a named sub-pipeline
Arguments `name` - `String!` Pipeline name. `description` - `String` Pipeline description. `labels` - `[PipelineLabel!]` Pipeline labels.
`from` - `Container!`	Initializes this container from a pulled base image.
Arguments `address` - `String!` Image's address from its registry. Formatted as [host]/[user]/[repo]:[tag] (e.g., "docker.io/dagger/dagger:main").
`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. Default: './Dockerfile'. `buildArgs` - `[BuildArg!]` Additional build arguments. `target` - `String` Target build stage to build. `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 url?token=$(cat /run/secrets/my-secret)"
`rootfs` - `Directory!`	Retrieves this container's root filesystem. Mounts are not included.
`withRootfs` - `Container!`	Initializes this container from this DirectoryID.
Arguments `directory` - `DirectoryID!`
`directory` - `Directory!`	Retrieves a directory at the given path. Mounts are included.
Arguments `path` - `String!` The path of the directory to retrieve (e.g., "./src").
`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").
`user` - `String`	Retrieves the user to be set for all commands.
`withUser` - `Container!`	Retrieves this container with a different command user.
Arguments `name` - `String!` The user to set (e.g., "root").
`workdir` - `String`	Retrieves the working directory for all commands.
`withWorkdir` - `Container!`	Retrieves this container with a different working directory.
Arguments `path` - `String!` The path to set as the working directory (e.g., "/app").
`envVariables` - `[EnvVariable!]!`	Retrieves the list of environment variables passed to commands.
`envVariable` - `String`	Retrieves the value of the specified environment variable.
Arguments `name` - `String!` The name of the environment variable to retrieve (e.g., "PATH").
`withEnvVariable` - `Container!`	Retrieves this container plus the given environment variable.
Arguments `name` - `String!` The name of the environment variable (e.g., "HOST"). `value` - `String!` The 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").
`labels` - `[Label!]!`	Retrieves the list of labels passed to container.
`label` - `String`	Retrieves the value of the specified label.
Arguments `name` - `String!`
`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").
`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").
`withSecretVariable` - `Container!`	Retrieves this container plus an env variable containing the given secret.
Arguments `name` - `String!` The name of the secret variable (e.g., "API_SECRET"). `secret` - `SecretID!` The identifier of the secret value.
`withoutEnvVariable` - `Container!`	Retrieves this container minus the given environment variable.
Arguments `name` - `String!` The name of the environment variable (e.g., "HOST").
`entrypoint` - `[String!]`	Retrieves entrypoint to be prepended to the arguments of all commands.
`withEntrypoint` - `Container!`	Retrieves this container but with a different command entrypoint.
Arguments `args` - `[String!]!` Entrypoint to use for future executions (e.g., ["go", "run"]).
`defaultArgs` - `[String!]`	Retrieves default arguments for future commands.
`withDefaultArgs` - `Container!`	Configures default arguments for future commands.
Arguments `args` - `[String!]` Arguments to prepend to future executions (e.g., ["-v", "--no-cache"]).
`mounts` - `[String!]!`	Retrieves the list of paths where a directory is mounted.
`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.
`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.
`withMountedTemp` - `Container!`	Retrieves this container plus a temporary directory mounted at the given path.
Arguments `path` - `String!` Location of the temporary directory (e.g., "/tmp/temp_dir").
`withMountedCache` - `Container!`	Retrieves this container plus a cache volume mounted at the given path.
Arguments `path` - `String!` Location of the cache directory (e.g., "/cache/node_modules"). `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.
`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. Default: 0400.
`withoutMount` - `Container!`	Retrieves this container after unmounting everything at the given path.
Arguments `path` - `String!` Location of the cache directory (e.g., "/cache/node_modules").
`withFile` - `Container!`	Retrieves this container plus the contents of the given file copied to the given path.
Arguments `path` - `String!` Location of the copied file (e.g., "/tmp/file.txt"). `source` - `FileID!` Identifier of the file to copy. `permissions` - `Int` Permission given to the copied file (e.g., 0600). Default: 0644. `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.
`withNewFile` - `Container!`	Retrieves this container plus a new file written at the given path.
Arguments `path` - `String!` Location of the written file (e.g., "/tmp/file.txt"). `contents` - `String` Content of the file to write (e.g., "Hello world!"). `permissions` - `Int` Permission given to the written file (e.g., 0600). Default: 0644. `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.
`withDirectory` - `Container!`	Retrieves this container plus a directory written at the given path.
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.
`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.
`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").
`withFocus` - `Container!`	Indicate that subsequent operations should be featured more prominently in the UI.
`withoutFocus` - `Container!`	Indicate that subsequent operations should not be featured more prominently in the UI. This is the initial state of all containers.
`withExec` - `Container!`	Retrieves this container after executing the specified command inside it.
Arguments `args` - `[String!]!` Command to run instead of the container's default command (e.g., ["run", "main.go"]). If empty, the container's default command is used. `skipEntrypoint` - `Boolean` If the container has an entrypoint, ignore it for args rather than using it to wrap them. `stdin` - `String` Content to write to the command's standard input before closing (e.g., "Hello world"). `redirectStdout` - `String` Redirect the command's standard output to a file in the container (e.g., "/tmp/stdout"). `redirectStderr` - `String` Redirect the command's standard error to a file in the container (e.g., "/tmp/stderr"). `experimentalPrivilegedNesting` - `Boolean` Provides dagger access to the executed command. Do not use this option unless you trust the command being executed. The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM. `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.
`stdout` - `String!`	The output stream of the last executed command. Will execute default command if none is set, or error if there's no default.
`stderr` - `String!`	The error stream of the last executed command. Will execute default command if none is set, or error if there's no default.
`publish` - `String!`	Publishes this container as a new image to the specified address. Publish returns a fully qualified ref. It can also publish platform variants.
Arguments `address` - `String!` Registry's address to publish the image to. Formatted as [host]/[user]/[repo]:[tag] (e.g. "docker.io/dagger/dagger:main"). `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 largely compatible with most recent registries, but Docker may be needed for older registries without OCI support.
`export` - `Boolean!`	Writes the container as an OCI tarball to the destination file path on the host for the specified platform variants. Return true on success. It can also publishes 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.
`asTarball` - `File!`	Returns a File representing the container serialized to a tarball.
Arguments `platformVariants` - `[ContainerID!]` Identifiers for other platform specific containers. Used for multi-platform image. `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.
`import` - `Container!`	Reads the container from an OCI tarball. NOTE: this involves unpacking the tarball to an OCI store on the host at $XDG_CACHE_DIR/dagger/oci. This directory can be removed whenever you like.
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.
`withRegistryAuth` - `Container!`	Retrieves this container with a registry authentication for a given address.
Arguments `address` - `String!` Registry's address to bind the authentication to. Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main). `username` - `String!` The username of the registry's account (e.g., "Dagger"). `secret` - `SecretID!` The API key, password or token to authenticate to this registry.
`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).
`imageRef` - `String`	The unique image reference which can only be retrieved immediately after the 'Container.From' call.
`withExposedPort` - `Container!`	Expose a network port. 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 `protocol` - `NetworkProtocol` Transport layer network protocol `description` - `String` Optional port description
`withoutExposedPort` - `Container!`	Unexpose a previously exposed port.
Arguments `port` - `Int!` Port number to unexpose `protocol` - `NetworkProtocol` Port protocol to unexpose
`exposedPorts` - `[Port!]!`	Retrieves the list of exposed ports. This includes ports already exposed by the image, even if not explicitly added with dagger.
`withServiceBinding` - `Container!`	Establish a runtime dependency on a 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!` A name that can be used to reach the service from the container `service` - `ServiceID!` Identifier of the service container
`shellEndpoint` - `String!`	Return a websocket endpoint that, if connected to, will start the container with a TTY streamed over the websocket. Primarily intended for internal use with the dagger CLI.
`experimentalWithGPU` - `Container!`	EXPERIMENTAL API! Subject to change/removal at any time. experimentalWithGPU configures the provided list of devices to be accesible to this container. This currently works for Nvidia devices only.
Arguments `devices` - `[String!]!`
`experimentalWithAllGPUs` - `Container!`	EXPERIMENTAL API! Subject to change/removal at any time. experimentalWithAllGPUs configures all available GPUs on the host to be accessible to this container. This currently works for Nvidia devices only.
`asService` - `Service!`	Turn the container into a Service. Be sure to set any exposed ports before this conversion.

Types

ContainerID

Description

A unique container identifier. Null designates an empty container (scratch).

Types

Field Name	Description
`id` - `DirectoryID!`	The content-addressed identifier of the directory.
`sync` - `DirectoryID!`	Force evaluation in the engine.
`pipeline` - `Directory!`	Creates a named sub-pipeline
Arguments `name` - `String!` Pipeline name. `description` - `String` Pipeline description. `labels` - `[PipelineLabel!]` Pipeline labels.
`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").
`glob` - `[String!]!`	Returns a list of files and directories that matche the given pattern.
Arguments `pattern` - `String!` Pattern to match (e.g., "*.md").
`file` - `File!`	Retrieves a file at the given path.
Arguments `path` - `String!` Location of the file to retrieve (e.g., "README.md").
`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). Default: 0644.
`withNewFile` - `Directory!`	Retrieves this directory plus a new file written at the given path.
Arguments `path` - `String!` Location of the written file (e.g., "/file.txt"). `contents` - `String!` Content of the written file (e.g., "Hello world!"). `permissions` - `Int` Permission given to the copied file (e.g., 0600). Default: 0644.
`withoutFile` - `Directory!`	Retrieves this directory with the file at the given path removed.
Arguments `path` - `String!` Location of the file to remove (e.g., "/file.txt").
`directory` - `Directory!`	Retrieves a directory at the given path.
Arguments `path` - `String!` Location of the directory to retrieve (e.g., "/src").
`withDirectory` - `Directory!`	Retrieves this directory plus a directory written at the given path.
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."]).
`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). Default: 0755.
`withoutDirectory` - `Directory!`	Retrieves this directory with the directory at the given path removed.
Arguments `path` - `String!` Location of the directory to remove (e.g., ".github/").
`diff` - `Directory!`	Gets the difference between this directory and an another directory.
Arguments `other` - `DirectoryID!` Identifier of the directory to compare.
`export` - `Boolean!`	Writes the contents of the directory to a path on the host.
Arguments `path` - `String!` Location of the copied directory (e.g., "logs/").
`dockerBuild` - `Container!`	Builds a new Docker container from this directory.
Arguments `dockerfile` - `String` Path to the Dockerfile to use (e.g., "frontend.Dockerfile"). Defaults: './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].
`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).
`asModule` - `Module!`	Load the directory as a Dagger module
Arguments `sourceSubpath` - `String` An optional subpath of the directory which contains the module's source code. This is needed when the module code is in a subdirectory but requires parent directories to be loaded in order to execute. For example, the module source code may need a go.mod, project.toml, package.json, etc. file from a parent directory. If not set, the module source code is loaded from the root of the directory.

DirectoryID

Description

A content-addressed directory identifier.

Types

EnvVariable

Description

A simple key value object that represents an environment variable.

Fields

Field Name	Description
`name` - `String!`	The environment variable name.
`value` - `String!`	The environment variable value.

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
`name` - `String!`	The name of the field in the object
`description` - `String`	A doc string for the field, if any
`typeDef` - `TypeDef!`	The type of the field

Types

File

Description

A file.

Fields

Field Name	Description
`id` - `FileID!`	Retrieves the content-addressed identifier of the file.
`sync` - `FileID!`	Force evaluation in the engine.
`contents` - `String!`	Retrieves the contents of the file.
`size` - `Int!`	Gets the size of the file, in bytes.
`export` - `Boolean!`	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.
`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

A file identifier.

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
`id` - `FunctionID!`	The ID of the function
`name` - `String!`	The name of the function
`returnType` - `TypeDef!`	The type returned by this function
`description` - `String`	A doc string for the function, if any
`withDescription` - `Function!`	Returns the function with the doc string
Arguments `description` - `String!`
`args` - `[FunctionArg!]`	Arguments accepted by this function, if any
`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

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
`id` - `FunctionArgID!`	The ID of the argument
`name` - `String!`	The name of the argument
`description` - `String`	A doc string for the argument, if any
`typeDef` - `TypeDef!`	The type of the argument
`defaultValue` - `JSON`	A default value to use for this argument when not explicitly set by the caller, if any

Types

FunctionArgID

Description

A reference to a FunctionArg.

Types

FunctionCall

Fields

Field Name	Description
`name` - `String!`	The name of the function being called.
`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.
`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.
`inputArgs` - `[FunctionCallArgValue!]`	The argument values the function is being invoked with.
`returnValue` - `Void`	Set the return value of the function call to the provided value. The value should be a string of the JSON serialization of the return value.
Arguments `value` - `JSON!`

Types

FunctionCallArgValue

Fields

Field Name	Description
`name` - `String!`	The name of the argument.
`value` - `JSON!`	The value of the argument represented as a string of the JSON serialization.

Types

FunctionID

Description

A reference to a Function.

Types

GeneratedCode

Fields

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

Types

GeneratedCodeID

Description

A reference to GeneratedCode.

Types

GitRef

Description

A git ref (tag, branch or commit).

Fields

Field Name	Description
`tree` - `Directory!`	The filesystem tree at this ref.
Arguments `sshKnownHosts` - `String` `sshAuthSocket` - `SocketID`
`commit` - `String!`	The resolved commit id at this ref.

Types

GitRepository

Description

A git repository.

Fields

Field Name	Description
`branch` - `GitRef!`	Returns details on one branch.
Arguments `name` - `String!` Branch's name (e.g., "main").
`tag` - `GitRef!`	Returns details on one tag.
Arguments `name` - `String!` Tag's name (e.g., "v0.3.9").
`commit` - `GitRef!`	Returns details on one commit.
Arguments `id` - `String!` Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").

Types

Host

Description

Information about the host execution 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."]).
`file` - `File!`	Accesses a file on the host.
Arguments `path` - `String!` Location of the file to retrieve (e.g., "README.md").
`unixSocket` - `Socket!`	Accesses a Unix socket on the host.
Arguments `path` - `String!` Location of the Unix socket (e.g., "/var/run/docker.sock").
`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.
`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.
Arguments `name` - `String!` The user defined name for this secret. `path` - `String!` Location of the file to set as a secret.

Types

ImageLayerCompression

Description

Compression algorithm to use for image layers.

Values

Enum Value	Description
`Gzip`
`Zstd`
`EStarGZ`
`Uncompressed`

Example

"Gzip"

Types

ImageMediaTypes

Description

Mediatypes to use in published or exported image metadata.

Values

Enum Value	Description
`OCIMediaTypes`
`DockerMediaTypes`

Example

"OCIMediaTypes"

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

JSON

Description

An arbitrary JSON-encoded value.

Types

Label

Description

A simple key value object that represents a label.

Fields

Field Name	Description
`name` - `String!`	The label name.
`value` - `String!`	The label value.

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

Types

Module

Fields

Field Name	Description
`id` - `ModuleID!`	The ID of the module
`name` - `String!`	The name of the module
`description` - `String`	The doc string of the module, if any
`sdk` - `String!`	The SDK used by this module. Either a name of a builtin SDK or a module ref pointing to the SDK's implementation.
`generatedCode` - `GeneratedCode!`	The code generated by the SDK's runtime
`dependencies` - `[Module!]!`	Modules used by this module
`dependencyConfig` - `[String!]!`	The dependencies as configured by the module
`sourceDirectory` - `Directory!`	The directory containing the module's source code
`sourceDirectorySubPath` - `String!`	The module's subpath within the source directory
`objects` - `[TypeDef!]`	Objects served by this module
`withObject` - `Module!`	This module plus the given Object type and associated functions
Arguments `object` - `TypeDefID!`
`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.

Types

ModuleConfig

Description

Static configuration for a module (e.g. parsed contents of dagger.json)

Fields

Field Name	Description
`name` - `String!`	The name of the module.
`root` - `String`	The root directory of the module's project, which may be above the module source code.
`sdk` - `String!`	Either the name of a built-in SDK ('go', 'python', etc.) OR a module reference pointing to the SDK's module implementation.
`include` - `[String!]`	Include only these file globs when loading the module root.
`exclude` - `[String!]`	Exclude these file globs when loading the module root.
`dependencies` - `[String!]`	Modules that this module depends on.

Types

ModuleID

Description

A reference to a Module.

Types

NetworkProtocol

Description

Transport layer network protocol associated to a port.

Values

Enum Value	Description
`TCP`	TCP (Transmission Control Protocol)
`UDP`	UDP (User Datagram Protocol)

Example

"TCP"

Types

ObjectTypeDef

Description

A definition of a custom object defined in a Module.

Fields

Field Name	Description
`name` - `String!`	The name of the object
`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
`constructor` - `Function`	The function used to construct new instances of this object, if any

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": "xyz789",
  "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
`port` - `Int!`	The port number.
`protocol` - `NetworkProtocol!`	The transport layer network protocol.
`description` - `String`	The port description.

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`	Protocol to use for traffic. Default = `TCP`

Example

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

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!`	The identifier for this secret.
`plaintext` - `String!`	The value of this secret.

Types

SecretID

Description

A unique identifier for a secret.

Types

Service

Fields

Field Name	Description
`id` - `ServiceID!`	A unique identifier for this service.
`hostname` - `String!`	Retrieves a hostname which can be used by clients to reach this container.
`ports` - `[Port!]!`	Retrieves the list of ports provided by the service.
`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://
`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.

Types

ServiceID

Description

A unique service identifier.

Types

Socket

Fields

Field Name	Description
`id` - `SocketID!`	The content-addressed identifier of the socket.

Types

SocketID

Description

A content-addressed socket identifier.

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

TypeDef

Description

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

Fields

Field Name	Description
`id` - `TypeDefID!`
`kind` - `TypeDefKind`	The kind of type this is (e.g. primitive, list, object)
`withKind` - `TypeDef!`	Sets the kind of the type.
Arguments `kind` - `TypeDefKind!`
`optional` - `Boolean!`	Whether this type can be set to null. Defaults to false.
`withOptional` - `TypeDef!`	Sets whether this type can be set to null.
Arguments `optional` - `Boolean!`
`withListOf` - `TypeDef!`	Returns a TypeDef of kind List with the provided type for its elements.
Arguments `elementType` - `TypeDefID!`
`asList` - `ListTypeDef`	If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.
`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`
`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
`withFunction` - `TypeDef!`	Adds a function for an Object TypeDef, failing if the type is not an object.
Arguments `function` - `FunctionID!`
`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!`
`asObject` - `ObjectTypeDef`	If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.

Types

TypeDefID

Description

A reference to a TypeDef.

Types

TypeDefKind

Description

Distinguishes the different kinds of TypeDefs.

Values

Enum Value	Description
`StringKind`	A string value
`IntegerKind`	An integer value
`BooleanKind`	A boolean value
`ListKind`	A list of values all having the same type. Always paired with a ListTypeDef.
`ObjectKind`	A named type defined in the GraphQL schema, with fields and functions. Always paired with an ObjectTypeDef.
`VoidKind`	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.

Example

"StringKind"

Types

Void

Description

The absense of a value.

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

Documentation by Anvil SpectaQL