Skip to main content
Version: 0.21

Class: Client

The root of the DAG.

Extends​

  • BaseClient

Constructors​

Constructor​

new Client(ctx?, _id?, _defaultPlatform?, _version?): Client

Constructor is used for internal usage only, do not create object from it.

Parameters​

ctx?​

Context

_id?​

ID

_defaultPlatform?​

Platform

_version?​

string

Returns​

Client

Overrides​

BaseClient.constructor

Methods​

address()​

address(value): Address

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

Parameters​

value​

string

Returns​

Address

cacheVolume()​

cacheVolume(key, opts?): CacheVolume

Constructs a cache volume for a given cache key.

Parameters​

key​

string

A string identifier to target this cache volume (e.g., "modules-cache").

opts?​

ClientCacheVolumeOpts

Returns​

CacheVolume

changeset()​

changeset(): Changeset

Creates an empty changeset

Returns​

Changeset

cloud()​

cloud(): Cloud

Dagger Cloud configuration and state

Returns​

Cloud

container()​

container(opts?): Container

Creates a scratch container, with no image or metadata.

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

Parameters​

opts?​

ClientContainerOpts

Returns​

Container

currentEnv()​

currentEnv(): Env

Experimental

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.

Returns​

Env

currentFunctionCall()​

currentFunctionCall(): 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.

Returns​

FunctionCall

currentModule()​

currentModule(): CurrentModule

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

Returns​

CurrentModule

currentTypeDefs()​

currentTypeDefs(opts?): Promise<TypeDef[]>

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

Parameters​

opts?​

ClientCurrentTypeDefsOpts

Returns​

Promise<TypeDef[]>

currentWorkspace()​

currentWorkspace(): Workspace

Experimental

Detect and return the current workspace.

Returns​

Workspace

defaultPlatform()​

defaultPlatform(): Promise<Platform>

The default platform of the engine.

Returns​

Promise<Platform>

directory()​

directory(): Directory

Creates an empty directory.

Returns​

Directory

engine()​

engine(): Engine

The Dagger engine container configuration and state

Returns​

Engine

env()​

env(opts?): Env

Experimental

Initializes a new environment

Parameters​

opts?​

ClientEnvOpts

Returns​

Env

envFile()​

envFile(opts?): EnvFile

Initialize an environment file

Parameters​

opts?​

ClientEnvFileOpts

Returns​

EnvFile

error()​

error(message): Error

Create a new error.

Parameters​

message​

string

A brief description of the error.

Returns​

Error

file()​

file(name, contents, opts?): File

Creates a file with the specified contents.

Parameters​

name​

string

Name of the new file. Example: "foo.txt"

contents​

string

Contents of the new file. Example: "Hello world!"

opts?​

ClientFileOpts

Returns​

File

function_()​

function_(name, returnType): Function_

Creates a function.

Parameters​

name​

string

Name of the function, in its original format from the implementation language.

returnType​

TypeDef

Return type of the function.

Returns​

Function_

generatedCode()​

generatedCode(code): GeneratedCode

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

Parameters​

code​

Directory

Returns​

GeneratedCode

getGQLClient()​

getGQLClient(): GraphQLClient

Get the Raw GraphQL client.

Returns​

GraphQLClient

git()​

git(url, opts?): GitRepository

Queries a Git repository.

Parameters​

url​

string

URL of the git repository.

Can be formatted as https://{host}/{owner}/{repo}, git@{host}:{owner}/{repo}.

Suffix ".git" is optional.

opts?​

ClientGitOpts

Returns​

GitRepository

host()​

host(): Host

Queries the host environment.

Returns​

Host

http()​

http(url, opts?): File

Returns a file containing an http remote url content.

Parameters​

url​

string

HTTP url to get the content from (e.g., "https://docs.dagger.io").

opts?​

ClientHttpOpts

Returns​

File

id()​

id(): Promise<ID>

A unique identifier for this Query.

Returns​

Promise<ID>

json()​

json(): JSONValue

Initialize a JSON value

Returns​

JSONValue

llm()​

llm(opts?): LLM

Experimental

Initialize a Large Language Model (LLM)

Parameters​

opts?​

ClientLlmOpts

Returns​

LLM

loadAddressFromID()​

loadAddressFromID(id): Address

Load a Address from its ID.

Parameters​

id​

AddressID

Returns​

Address

loadBindingFromID()​

loadBindingFromID(id): Binding

Load a Binding from its ID.

Parameters​

id​

BindingID

Returns​

Binding

loadCacheVolumeFromID()​

loadCacheVolumeFromID(id): CacheVolume

Load a CacheVolume from its ID.

Parameters​

id​

CacheVolumeID

Returns​

CacheVolume

loadChangesetFromID()​

loadChangesetFromID(id): Changeset

Load a Changeset from its ID.

Parameters​

id​

ChangesetID

Returns​

Changeset

loadCheckFromID()​

loadCheckFromID(id): Check

Load a Check from its ID.

Parameters​

id​

CheckID

Returns​

Check

loadCheckGroupFromID()​

loadCheckGroupFromID(id): CheckGroup

Load a CheckGroup from its ID.

Parameters​

id​

CheckGroupID

Returns​

CheckGroup

loadClientFilesyncMirrorFromID()​

loadClientFilesyncMirrorFromID(id): ClientFilesyncMirror

Load a ClientFilesyncMirror from its ID.

Parameters​

id​

ClientFilesyncMirrorID

Returns​

ClientFilesyncMirror

loadCloudFromID()​

loadCloudFromID(id): Cloud

Load a Cloud from its ID.

Parameters​

id​

CloudID

Returns​

Cloud

loadContainerFromID()​

loadContainerFromID(id): Container

Load a Container from its ID.

Parameters​

id​

ContainerID

Returns​

Container

loadCurrentModuleFromID()​

loadCurrentModuleFromID(id): CurrentModule

Load a CurrentModule from its ID.

Parameters​

id​

CurrentModuleID

Returns​

CurrentModule

loadDiffStatFromID()​

loadDiffStatFromID(id): DiffStat

Load a DiffStat from its ID.

Parameters​

id​

DiffStatID

Returns​

DiffStat

loadDirectoryFromID()​

loadDirectoryFromID(id): Directory

Load a Directory from its ID.

Parameters​

id​

DirectoryID

Returns​

Directory

loadEngineCacheEntryFromID()​

loadEngineCacheEntryFromID(id): EngineCacheEntry

Load a EngineCacheEntry from its ID.

Parameters​

id​

EngineCacheEntryID

Returns​

EngineCacheEntry

loadEngineCacheEntrySetFromID()​

loadEngineCacheEntrySetFromID(id): EngineCacheEntrySet

Load a EngineCacheEntrySet from its ID.

Parameters​

id​

EngineCacheEntrySetID

Returns​

EngineCacheEntrySet

loadEngineCacheFromID()​

loadEngineCacheFromID(id): EngineCache

Load a EngineCache from its ID.

Parameters​

id​

EngineCacheID

Returns​

EngineCache

loadEngineFromID()​

loadEngineFromID(id): Engine

Load a Engine from its ID.

Parameters​

id​

EngineID

Returns​

Engine

loadEnumTypeDefFromID()​

loadEnumTypeDefFromID(id): EnumTypeDef

Load a EnumTypeDef from its ID.

Parameters​

id​

EnumTypeDefID

Returns​

EnumTypeDef

loadEnumValueTypeDefFromID()​

loadEnumValueTypeDefFromID(id): EnumValueTypeDef

Load a EnumValueTypeDef from its ID.

Parameters​

id​

EnumValueTypeDefID

Returns​

EnumValueTypeDef

loadEnvFileFromID()​

loadEnvFileFromID(id): EnvFile

Load a EnvFile from its ID.

Parameters​

id​

EnvFileID

Returns​

EnvFile

loadEnvFromID()​

loadEnvFromID(id): Env

Load a Env from its ID.

Parameters​

id​

EnvID

Returns​

Env

loadEnvVariableFromID()​

loadEnvVariableFromID(id): EnvVariable

Load a EnvVariable from its ID.

Parameters​

id​

EnvVariableID

Returns​

EnvVariable

loadErrorFromID()​

loadErrorFromID(id): Error

Load a Error from its ID.

Parameters​

id​

ErrorID

Returns​

Error

loadErrorValueFromID()​

loadErrorValueFromID(id): ErrorValue

Load a ErrorValue from its ID.

Parameters​

id​

ErrorValueID

Returns​

ErrorValue

loadExportableFromID()​

loadExportableFromID(id): Exportable

Load a Exportable from its ID.

Parameters​

id​

ExportableID

Returns​

Exportable

loadFieldTypeDefFromID()​

loadFieldTypeDefFromID(id): FieldTypeDef

Load a FieldTypeDef from its ID.

Parameters​

id​

FieldTypeDefID

Returns​

FieldTypeDef

loadFileFromID()​

loadFileFromID(id): File

Load a File from its ID.

Parameters​

id​

FileID

Returns​

File

loadFunctionArgFromID()​

loadFunctionArgFromID(id): FunctionArg

Load a FunctionArg from its ID.

Parameters​

id​

FunctionArgID

Returns​

FunctionArg

loadFunctionCallArgValueFromID()​

loadFunctionCallArgValueFromID(id): FunctionCallArgValue

Load a FunctionCallArgValue from its ID.

Parameters​

id​

FunctionCallArgValueID

Returns​

FunctionCallArgValue

loadFunctionCallFromID()​

loadFunctionCallFromID(id): FunctionCall

Load a FunctionCall from its ID.

Parameters​

id​

FunctionCallID

Returns​

FunctionCall

loadFunctionFromID()​

loadFunctionFromID(id): Function_

Load a Function from its ID.

Parameters​

id​

FunctionID

Returns​

Function_

loadGeneratedCodeFromID()​

loadGeneratedCodeFromID(id): GeneratedCode

Load a GeneratedCode from its ID.

Parameters​

id​

GeneratedCodeID

Returns​

GeneratedCode

loadGeneratorFromID()​

loadGeneratorFromID(id): Generator

Load a Generator from its ID.

Parameters​

id​

GeneratorID

Returns​

Generator

loadGeneratorGroupFromID()​

loadGeneratorGroupFromID(id): GeneratorGroup

Load a GeneratorGroup from its ID.

Parameters​

id​

GeneratorGroupID

Returns​

GeneratorGroup

loadGitRefFromID()​

loadGitRefFromID(id): GitRef

Load a GitRef from its ID.

Parameters​

id​

GitRefID

Returns​

GitRef

loadGitRepositoryFromID()​

loadGitRepositoryFromID(id): GitRepository

Load a GitRepository from its ID.

Parameters​

id​

GitRepositoryID

Returns​

GitRepository

loadHealthcheckConfigFromID()​

loadHealthcheckConfigFromID(id): HealthcheckConfig

Load a HealthcheckConfig from its ID.

Parameters​

id​

HealthcheckConfigID

Returns​

HealthcheckConfig

loadHostFromID()​

loadHostFromID(id): Host

Load a Host from its ID.

Parameters​

id​

HostID

Returns​

Host

loadHTTPStateFromID()​

loadHTTPStateFromID(id): HTTPState

Load a HTTPState from its ID.

Parameters​

id​

HTTPStateID

Returns​

HTTPState

loadInputTypeDefFromID()​

loadInputTypeDefFromID(id): InputTypeDef

Load a InputTypeDef from its ID.

Parameters​

id​

InputTypeDefID

Returns​

InputTypeDef

loadInterfaceTypeDefFromID()​

loadInterfaceTypeDefFromID(id): InterfaceTypeDef

Load a InterfaceTypeDef from its ID.

Parameters​

id​

InterfaceTypeDefID

Returns​

InterfaceTypeDef

loadJSONValueFromID()​

loadJSONValueFromID(id): JSONValue

Load a JSONValue from its ID.

Parameters​

id​

JSONValueID

Returns​

JSONValue

loadLabelFromID()​

loadLabelFromID(id): Label

Load a Label from its ID.

Parameters​

id​

LabelID

Returns​

Label

loadListTypeDefFromID()​

loadListTypeDefFromID(id): ListTypeDef

Load a ListTypeDef from its ID.

Parameters​

id​

ListTypeDefID

Returns​

ListTypeDef

loadLLMFromID()​

loadLLMFromID(id): LLM

Load a LLM from its ID.

Parameters​

id​

LLMID

Returns​

LLM

loadLLMTokenUsageFromID()​

loadLLMTokenUsageFromID(id): LLMTokenUsage

Load a LLMTokenUsage from its ID.

Parameters​

id​

LLMTokenUsageID

Returns​

LLMTokenUsage

loadModuleConfigClientFromID()​

loadModuleConfigClientFromID(id): ModuleConfigClient

Load a ModuleConfigClient from its ID.

Parameters​

id​

ModuleConfigClientID

Returns​

ModuleConfigClient

loadModuleFromID()​

loadModuleFromID(id): Module_

Load a Module from its ID.

Parameters​

id​

ModuleID

Returns​

Module_

loadModuleSourceFromID()​

loadModuleSourceFromID(id): ModuleSource

Load a ModuleSource from its ID.

Parameters​

id​

ModuleSourceID

Returns​

ModuleSource

loadObjectTypeDefFromID()​

loadObjectTypeDefFromID(id): ObjectTypeDef

Load a ObjectTypeDef from its ID.

Parameters​

id​

ObjectTypeDefID

Returns​

ObjectTypeDef

loadPortFromID()​

loadPortFromID(id): Port

Load a Port from its ID.

Parameters​

id​

PortID

Returns​

Port

loadRemoteGitMirrorFromID()​

loadRemoteGitMirrorFromID(id): RemoteGitMirror

Load a RemoteGitMirror from its ID.

Parameters​

id​

RemoteGitMirrorID

Returns​

RemoteGitMirror

loadScalarTypeDefFromID()​

loadScalarTypeDefFromID(id): ScalarTypeDef

Load a ScalarTypeDef from its ID.

Parameters​

id​

ScalarTypeDefID

Returns​

ScalarTypeDef

loadSDKConfigFromID()​

loadSDKConfigFromID(id): SDKConfig

Load a SDKConfig from its ID.

Parameters​

id​

SDKConfigID

Returns​

SDKConfig

loadSearchResultFromID()​

loadSearchResultFromID(id): SearchResult

Load a SearchResult from its ID.

Parameters​

id​

SearchResultID

Returns​

SearchResult

loadSearchSubmatchFromID()​

loadSearchSubmatchFromID(id): SearchSubmatch

Load a SearchSubmatch from its ID.

Parameters​

id​

SearchSubmatchID

Returns​

SearchSubmatch

loadSecretFromID()​

loadSecretFromID(id): Secret

Load a Secret from its ID.

Parameters​

id​

SecretID

Returns​

Secret

loadServiceFromID()​

loadServiceFromID(id): Service

Load a Service from its ID.

Parameters​

id​

ServiceID

Returns​

Service

loadSocketFromID()​

loadSocketFromID(id): Socket

Load a Socket from its ID.

Parameters​

id​

SocketID

Returns​

Socket

loadSourceMapFromID()​

loadSourceMapFromID(id): SourceMap

Load a SourceMap from its ID.

Parameters​

id​

SourceMapID

Returns​

SourceMap

loadStatFromID()​

loadStatFromID(id): Stat

Load a Stat from its ID.

Parameters​

id​

StatID

Returns​

Stat

loadSyncerFromID()​

loadSyncerFromID(id): Syncer

Load a Syncer from its ID.

Parameters​

id​

SyncerID

Returns​

Syncer

loadTerminalFromID()​

loadTerminalFromID(id): Terminal

Load a Terminal from its ID.

Parameters​

id​

TerminalID

Returns​

Terminal

loadTypeDefFromID()​

loadTypeDefFromID(id): TypeDef

Load a TypeDef from its ID.

Parameters​

id​

TypeDefID

Returns​

TypeDef

loadUpFromID()​

loadUpFromID(id): Up

Load a Up from its ID.

Parameters​

id​

UpID

Returns​

Up

loadUpGroupFromID()​

loadUpGroupFromID(id): UpGroup

Load a UpGroup from its ID.

Parameters​

id​

UpGroupID

Returns​

UpGroup

loadWorkspaceFromID()​

loadWorkspaceFromID(id): Workspace

Load a Workspace from its ID.

Parameters​

id​

WorkspaceID

Returns​

Workspace

module_()​

module_(): Module_

Create a new module.

Returns​

Module_

moduleSource()​

moduleSource(refString, opts?): ModuleSource

Create a new module source instance from a source ref string

Parameters​

refString​

string

The string ref representation of the module source

opts?​

ClientModuleSourceOpts

Returns​

ModuleSource

node()​

node(id): Node

Load any object by its ID.

Parameters​

id​

ID

Returns​

Node

secret()​

secret(uri, opts?): Secret

Creates a new secret.

Parameters​

uri​

string

The URI of the secret store

opts?​

ClientSecretOpts

Returns​

Secret

setSecret()​

setSecret(name, plaintext): 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.

Parameters​

name​

string

The user defined name for this secret

plaintext​

string

The plaintext of the secret

Returns​

Secret

sourceMap()​

sourceMap(filename, line, column): SourceMap

Creates source map metadata.

Parameters​

filename​

string

The filename from the module source.

line​

number

The line number within the filename.

column​

number

The column number within the line.

Returns​

SourceMap

typeDef()​

typeDef(): TypeDef

Create a new TypeDef.

Returns​

TypeDef

version()​

version(): Promise<string>

Get the current Dagger Engine version.

Returns​

Promise<string>