API Reference dagger v#0.21.4

Copy Markdown

Modules

The Dagger SDK for Elixir.

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

A unique identifier for an object.

Dagger.Binding

A unique identifier for an object.

Key value object that represents a build argument.

Sharing mode of the cache volume.

A directory whose contents persist across runs.

A unique identifier for an object.

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

A unique identifier for an object.

Strategy to use when merging changesets with conflicting changes.

Strategy to use when merging multiple changesets with git octopus merge.

Dagger.Check

Dagger.CheckGroup

A unique identifier for an object.

A unique identifier for an object.

The root of the DAG.

An internal persistent filesync mirror.

A unique identifier for an object.

Dagger Cloud configuration and state

A unique identifier for an object.

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

A unique identifier for an object.

GraphQL client for Dagger.

API error from an exec operation.

GraphQL Response type.

:httpc HTTP adapter for GraphQL client.

:req adapter for GraphQL client.

Reflective module API provided to functions at runtime.

A unique identifier for an object.

Dagger.DiffStat

A unique identifier for an object.

The type of change for a diff stat entry.

A directory.

A unique identifier for an object.

The Dagger engine configuration and state

A cache storage for the Dagger engine

An individual cache entry in a cache entry set

A unique identifier for an object.

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

A unique identifier for an object.

A unique identifier for an object.

A unique identifier for an object.

A definition of a custom enum defined in a Module.

A unique identifier for an object.

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

A unique identifier for an object.

Dagger.Env

A collection of environment variables.

A unique identifier for an object.

A unique identifier for an object.

An environment variable name and value.

A unique identifier for an object.

Dagger.Error

A unique identifier for an object.

Dagger.ErrorValue

A unique identifier for an object.

File type.

An object that can be exported to the host.

A unique identifier for an object.

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

A unique identifier for an object.

A file.

A unique identifier for an object.

File type.

Function represents a resolver provided by a Module.

An argument accepted by a function.

A unique identifier for an object.

The behavior configured for function result caching.

An active function call.

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

A unique identifier for an object.

A unique identifier for an object.

A unique identifier for an object.

The result of running an SDK's codegen.

A unique identifier for an object.

Dagger.Generator

Dagger.GeneratorGroup

A unique identifier for an object.

A unique identifier for an object.

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

A unique identifier for an object.

A git repository.

A unique identifier for an object.

An internal persistent HTTP state.

A unique identifier for an object.

Image healthcheck configuration.

A unique identifier for an object.

Information about the host environment.

A unique identifier for an object.

Compression algorithm to use for image layers.

Mediatypes to use in published or exported image metadata.

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.

A unique identifier for an object.

A definition of a custom interface defined in a Module.

A unique identifier for an object.

An arbitrary JSON-encoded value.

Dagger.JSONValue

A unique identifier for an object.

Dagger.LLM

A unique identifier for an object.

Dagger.LLMTokenUsage

A unique identifier for an object.

A simple key value object that represents a label.

A unique identifier for an object.

A definition of a list type in a Module.

A unique identifier for an object.

Provides set of functions for decoding value from function call.

Provides set of functions for encoding value from function call.

Declare a module as an enum type.

Declare a module as an object type.

An error raise when the value is incompatible with type.

A Dagger module.

The client generated for the module.

A unique identifier for an object.

A unique identifier for an object.

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

Experimental features of a module

A unique identifier for an object.

The kind of module source.

Transport layer network protocol associated to a port.

An object with a globally unique ID.

A definition of a custom object defined in a Module.

A unique identifier for an object.

Key value object that represents a pipeline label.

The platform config OS and architecture in a Container.

A port exposed by a container.

Port forwarding rules for tunneling network traffic.

A unique identifier for an object.

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

An internal persistent bare git mirror.

A unique identifier for an object.

Expected return type of an execution

The SDK config of the module.

A unique identifier for an object.

A definition of a custom scalar defined in a Module.

A unique identifier for an object.

Dagger.SearchResult

A unique identifier for an object.

Dagger.SearchSubmatch

A unique identifier for an object.

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

A unique identifier for an object.

A content-addressed service providing TCP connectivity.

A unique identifier for an object.

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

A unique identifier for an object.

Source location information.

A unique identifier for an object.

A file or directory status object.

A unique identifier for an object.

Dagger.Sub1

Dagger.Sub1Obj

Dagger.Sub2

Dagger.Sub2Obj

An object that can be force-evaluated.

A unique identifier for an object.

An interactive terminal that clients can connect to.

A unique identifier for an object.

Dagger.Test

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

A unique identifier for an object.

Distinguishes the different kinds of TypeDefs.

Dagger.Up

Dagger.UpGroup

A unique identifier for an object.

A unique identifier for an object.

The absence of a value.

A Dagger workspace detected from the current working directory.

A unique identifier for an object.

Mix Tasks

Main entrypoint for invoking a Dagger Module.