dag

func Address ¶ added in v0.18.19

func Address(value string) *dagger.Address

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

func CacheVolume ¶

func CacheVolume(key string) *dagger.CacheVolume

Constructs a cache volume for a given cache key.

func Close ¶

func Close() error

Close the engine connection

func Cloud ¶ added in v0.18.11

func Cloud() *dagger.Cloud

Dagger Cloud configuration and state

func Container ¶

func Container(opts ...dagger.ContainerOpts) *dagger.Container

Creates a scratch container, with no image or metadata.

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

func CurrentEnv ¶ added in v0.19.0

func CurrentEnv() *dagger.Env

Returns the current environment

When called from a function invoked via an LLM tool call, this will be the LLM's current environment, including any modifications made through calling tools. Env values returned by functions become the new environment for subsequent calls, and Changeset values returned by functions are applied to the environment's workspace.

When called from a module function outside of an LLM, this returns an Env with the current module installed, and with the current module's source directory as its workspace.

Experimental: Programmatic env access is speculative and might be replaced.

func CurrentFunctionCall ¶

func CurrentFunctionCall() *dagger.FunctionCall

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.

func CurrentModule ¶

func CurrentModule() *dagger.CurrentModule

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

func CurrentTypeDefs ¶

func CurrentTypeDefs(ctx context.Context) ([]dagger.TypeDef, error)

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

func CurrentWorkspace ¶ added in v0.20.0

func CurrentWorkspace(opts ...dagger.CurrentWorkspaceOpts) *dagger.Workspace

Detect and return the current workspace.

Experimental: Highly experimental API extracted from a more ambitious workspace implementation.

func DefaultPlatform ¶

func DefaultPlatform(ctx context.Context) (dagger.Platform, error)

The default platform of the engine.

func Directory ¶

func Directory() *dagger.Directory

Creates an empty directory.

func Engine ¶ added in v0.14.0

func Engine() *dagger.Engine

The Dagger engine container configuration and state

func Env ¶ added in v0.18.0

func Env(opts ...dagger.EnvOpts) *dagger.Env

Initializes a new environment

Experimental: Environments are not yet stabilized

func EnvFile ¶ added in v0.18.18

func EnvFile(opts ...dagger.EnvFileOpts) *dagger.EnvFile

Initialize an environment file

func Error ¶ added in v0.15.0

func Error(message string) *dagger.Error

Create a new error.

func File ¶

func File(name string, contents string, opts ...dagger.FileOpts) *dagger.File

Creates a file with the specified contents.

func Function ¶

func Function(name string, returnType *dagger.TypeDef) *dagger.Function

Creates a function.

func GeneratedCode ¶

func GeneratedCode(code *dagger.Directory) *dagger.GeneratedCode

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

func Git ¶

func Git(url string, opts ...dagger.GitOpts) *dagger.GitRepository

Queries a Git repository.

func HTTP ¶

func HTTP(url string, opts ...dagger.HTTPOpts) *dagger.File

Returns a file containing an http remote url content.

func Host ¶

func Host() *dagger.Host

Queries the host environment.

func JSON ¶ added in v0.18.17

func JSON() *dagger.JSONValue

Initialize a JSON value

func LLM ¶ added in v0.17.1

func LLM(opts ...dagger.LLMOpts) *dagger.LLM

Initialize a Large Language Model (LLM)

Experimental: LLM support is not yet stabilized

func LoadAddressFromID ¶ added in v0.18.19

func LoadAddressFromID(id dagger.AddressID) *dagger.Address

Load a Address from its ID.

func LoadBindingFromID ¶ added in v0.18.0

func LoadBindingFromID(id dagger.BindingID) *dagger.Binding

Load a Binding from its ID.

func LoadCacheVolumeFromID ¶

func LoadCacheVolumeFromID(id dagger.CacheVolumeID) *dagger.CacheVolume

Load a CacheVolume from its ID.

func LoadChangesetFromID ¶ added in v0.18.18

func LoadChangesetFromID(id dagger.ChangesetID) *dagger.Changeset

Load a Changeset from its ID.

func LoadCheckFromID ¶ added in v0.19.7

func LoadCheckFromID(id dagger.CheckID) *dagger.Check

Load a Check from its ID.

func LoadCheckGroupFromID ¶ added in v0.19.7

func LoadCheckGroupFromID(id dagger.CheckGroupID) *dagger.CheckGroup

Load a CheckGroup from its ID.

func LoadCloudFromID ¶ added in v0.18.11

func LoadCloudFromID(id dagger.CloudID) *dagger.Cloud

Load a Cloud from its ID.

func LoadContainerFromID ¶

func LoadContainerFromID(id dagger.ContainerID) *dagger.Container

Load a Container from its ID.

func LoadCurrentModuleFromID ¶ added in v0.9.8

func LoadCurrentModuleFromID(id dagger.CurrentModuleID) *dagger.CurrentModule

Load a CurrentModule from its ID.

func LoadDirectoryFromID ¶

func LoadDirectoryFromID(id dagger.DirectoryID) *dagger.Directory

Load a Directory from its ID.

func LoadEngineCacheEntryFromID ¶ added in v0.14.0

func LoadEngineCacheEntryFromID(id dagger.EngineCacheEntryID) *dagger.EngineCacheEntry

Load a EngineCacheEntry from its ID.

func LoadEngineCacheEntrySetFromID ¶ added in v0.14.0

func LoadEngineCacheEntrySetFromID(id dagger.EngineCacheEntrySetID) *dagger.EngineCacheEntrySet

Load a EngineCacheEntrySet from its ID.

func LoadEngineCacheFromID ¶ added in v0.14.0

func LoadEngineCacheFromID(id dagger.EngineCacheID) *dagger.EngineCache

Load a EngineCache from its ID.

func LoadEngineFromID ¶ added in v0.14.0

func LoadEngineFromID(id dagger.EngineID) *dagger.Engine

Load a Engine from its ID.

func LoadEnumTypeDefFromID ¶ added in v0.12.1

func LoadEnumTypeDefFromID(id dagger.EnumTypeDefID) *dagger.EnumTypeDef

Load a EnumTypeDef from its ID.

func LoadEnumValueTypeDefFromID ¶ added in v0.12.1

func LoadEnumValueTypeDefFromID(id dagger.EnumValueTypeDefID) *dagger.EnumValueTypeDef

Load a EnumValueTypeDef from its ID.

func LoadEnvFileFromID ¶ added in v0.18.18

func LoadEnvFileFromID(id dagger.EnvFileID) *dagger.EnvFile

Load a EnvFile from its ID.

func LoadEnvFromID ¶ added in v0.18.0

func LoadEnvFromID(id dagger.EnvID) *dagger.Env

Load a Env from its ID.

func LoadEnvVariableFromID ¶ added in v0.9.7

func LoadEnvVariableFromID(id dagger.EnvVariableID) *dagger.EnvVariable

Load a EnvVariable from its ID.

func LoadErrorFromID ¶ added in v0.15.0

func LoadErrorFromID(id dagger.ErrorID) *dagger.Error

Load a Error from its ID.

func LoadErrorValueFromID ¶ added in v0.17.0

func LoadErrorValueFromID(id dagger.ErrorValueID) *dagger.ErrorValue

Load a ErrorValue from its ID.

func LoadFieldTypeDefFromID ¶ added in v0.9.7

func LoadFieldTypeDefFromID(id dagger.FieldTypeDefID) *dagger.FieldTypeDef

Load a FieldTypeDef from its ID.

func LoadFileFromID ¶

func LoadFileFromID(id dagger.FileID) *dagger.File

Load a File from its ID.

func LoadFunctionArgFromID ¶

func LoadFunctionArgFromID(id dagger.FunctionArgID) *dagger.FunctionArg

Load a FunctionArg from its ID.

func LoadFunctionCallArgValueFromID ¶ added in v0.9.7

func LoadFunctionCallArgValueFromID(id dagger.FunctionCallArgValueID) *dagger.FunctionCallArgValue

Load a FunctionCallArgValue from its ID.

func LoadFunctionCallFromID ¶ added in v0.9.7

func LoadFunctionCallFromID(id dagger.FunctionCallID) *dagger.FunctionCall

Load a FunctionCall from its ID.

func LoadFunctionFromID ¶

func LoadFunctionFromID(id dagger.FunctionID) *dagger.Function

Load a Function from its ID.

func LoadGeneratedCodeFromID ¶

func LoadGeneratedCodeFromID(id dagger.GeneratedCodeID) *dagger.GeneratedCode

Load a GeneratedCode from its ID.

func LoadGeneratorFromID ¶ added in v0.19.11

func LoadGeneratorFromID(id dagger.GeneratorID) *dagger.Generator

Load a Generator from its ID.

func LoadGeneratorGroupFromID ¶ added in v0.19.11

func LoadGeneratorGroupFromID(id dagger.GeneratorGroupID) *dagger.GeneratorGroup

Load a GeneratorGroup from its ID.

func LoadGitRefFromID ¶

func LoadGitRefFromID(id dagger.GitRefID) *dagger.GitRef

Load a GitRef from its ID.

func LoadGitRepositoryFromID ¶

func LoadGitRepositoryFromID(id dagger.GitRepositoryID) *dagger.GitRepository

Load a GitRepository from its ID.

func LoadHostFromID ¶ added in v0.9.7

func LoadHostFromID(id dagger.HostID) *dagger.Host

Load a Host from its ID.

func LoadInputTypeDefFromID ¶ added in v0.9.8

func LoadInputTypeDefFromID(id dagger.InputTypeDefID) *dagger.InputTypeDef

Load a InputTypeDef from its ID.

func LoadInterfaceTypeDefFromID ¶ added in v0.9.7

func LoadInterfaceTypeDefFromID(id dagger.InterfaceTypeDefID) *dagger.InterfaceTypeDef

Load a InterfaceTypeDef from its ID.

func LoadJSONValueFromID ¶ added in v0.18.17

func LoadJSONValueFromID(id dagger.JSONValueID) *dagger.JSONValue

Load a JSONValue from its ID.

func LoadLLMFromID ¶ added in v0.17.0

func LoadLLMFromID(id dagger.LLMID) *dagger.LLM

Load a LLM from its ID.

func LoadLLMTokenUsageFromID ¶ added in v0.17.2

func LoadLLMTokenUsageFromID(id dagger.LLMTokenUsageID) *dagger.LLMTokenUsage

Load a LLMTokenUsage from its ID.

func LoadLabelFromID ¶ added in v0.9.7

func LoadLabelFromID(id dagger.LabelID) *dagger.Label

Load a Label from its ID.

func LoadListTypeDefFromID ¶ added in v0.9.7

func LoadListTypeDefFromID(id dagger.ListTypeDefID) *dagger.ListTypeDef

Load a ListTypeDef from its ID.

func LoadModuleConfigClientFromID ¶ added in v0.16.3

func LoadModuleConfigClientFromID(id dagger.ModuleConfigClientID) *dagger.ModuleConfigClient

Load a ModuleConfigClient from its ID.

func LoadModuleFromID ¶

func LoadModuleFromID(id dagger.ModuleID) *dagger.Module

Load a Module from its ID.

func LoadModuleSourceFromID ¶ added in v0.9.8

func LoadModuleSourceFromID(id dagger.ModuleSourceID) *dagger.ModuleSource

Load a ModuleSource from its ID.

func LoadObjectTypeDefFromID ¶ added in v0.9.7

func LoadObjectTypeDefFromID(id dagger.ObjectTypeDefID) *dagger.ObjectTypeDef

Load a ObjectTypeDef from its ID.

func LoadPortFromID ¶ added in v0.9.7

func LoadPortFromID(id dagger.PortID) *dagger.Port

Load a Port from its ID.

func LoadSDKConfigFromID ¶ added in v0.15.4

func LoadSDKConfigFromID(id dagger.SDKConfigID) *dagger.SDKConfig

Load a SDKConfig from its ID.

func LoadScalarTypeDefFromID ¶ added in v0.11.3

func LoadScalarTypeDefFromID(id dagger.ScalarTypeDefID) *dagger.ScalarTypeDef

Load a ScalarTypeDef from its ID.

func LoadSearchResultFromID ¶ added in v0.18.17

func LoadSearchResultFromID(id dagger.SearchResultID) *dagger.SearchResult

Load a SearchResult from its ID.

func LoadSearchSubmatchFromID ¶ added in v0.18.17

func LoadSearchSubmatchFromID(id dagger.SearchSubmatchID) *dagger.SearchSubmatch

Load a SearchSubmatch from its ID.

func LoadSecretFromID ¶

func LoadSecretFromID(id dagger.SecretID) *dagger.Secret

Load a Secret from its ID.

func LoadServiceFromID ¶

func LoadServiceFromID(id dagger.ServiceID) *dagger.Service

Load a Service from its ID.

func LoadSocketFromID ¶

func LoadSocketFromID(id dagger.SocketID) *dagger.Socket

Load a Socket from its ID.

func LoadSourceMapFromID ¶ added in v0.13.7

func LoadSourceMapFromID(id dagger.SourceMapID) *dagger.SourceMap

Load a SourceMap from its ID.

func LoadStatFromID ¶ added in v0.19.9

func LoadStatFromID(id dagger.StatID) *dagger.Stat

Load a Stat from its ID.

func LoadTerminalFromID ¶ added in v0.9.8

func LoadTerminalFromID(id dagger.TerminalID) *dagger.Terminal

Load a Terminal from its ID.

func LoadTypeDefFromID ¶

func LoadTypeDefFromID(id dagger.TypeDefID) *dagger.TypeDef

Load a TypeDef from its ID.

func LoadWorkspaceFromID ¶ added in v0.20.0

func LoadWorkspaceFromID(id dagger.WorkspaceID) *dagger.Workspace

Load a Workspace from its ID.

func Module ¶

func Module() *dagger.Module

Create a new module.

func ModuleSource ¶ added in v0.9.8

func ModuleSource(refString string, opts ...dagger.ModuleSourceOpts) *dagger.ModuleSource

Create a new module source instance from a source ref string

func Secret ¶

func Secret(uri string, opts ...dagger.SecretOpts) *dagger.Secret

Creates a new secret.

func SetSecret ¶

func SetSecret(name string, plaintext string) *dagger.Secret

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.

func SourceMap ¶ added in v0.13.7

func SourceMap(filename string, line int, column int) *dagger.SourceMap

Creates source map metadata.

func TypeDef ¶

func TypeDef() *dagger.TypeDef

Create a new TypeDef.

func Version ¶ added in v0.11.2

func Version(ctx context.Context) (string, error)

Get the current Dagger Engine version.