dagger

https://dagger.io

Installation

dagger install github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80

Entrypoint

Return Type

Dagger !

Arguments

Name	Type	Description
source	Directory !	No description provided
version	String	No description provided
hostDockerConfig	Secret	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH

func (m *myModule) example(source *Directory) *Dagger  {
	return dag.
			Dagger(source)
}

@function
def example(source: dagger.Directory, ) -> dag.Dagger:
	return (
		dag.dagger(source)
	)

@func()
example(source: Directory, ): Dagger {
	return dag
		.dagger(source)
}

Types

Dagger 🔗

A dev environment for the Dagger Engine

version() 🔗

Return Type

VersionInfo !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH version

func (m *myModule) example(source *Directory) *DaggerVersionInfo  {
	return dag.
			Dagger(source).
			Version()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerVersionInfo:
	return (
		dag.dagger(source)
		.version()
	)

@func()
example(source: Directory, ): DaggerVersionInfo {
	return dag
		.dagger(source)
		.version()
}

check() 🔗

Check that everything works. Use this as CI entrypoint.

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH check

func (m *myModule) example(ctx context.Context, source *Directory)   {
	return dag.
			Dagger(source).
			Check(ctx)
}

@function
async def example(source: dagger.Directory, ) -> None:
	return await (
		dag.dagger(source)
		.check()
	)

@func()
async example(source: Directory, ): Promise<void> {
	return dag
		.dagger(source)
		.check()
}

cli() 🔗

Develop the Dagger CLI

Return Type

Cli !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH cli

func (m *myModule) example(source *Directory) *DaggerCli  {
	return dag.
			Dagger(source).
			Cli()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerCli:
	return (
		dag.dagger(source)
		.cli()
	)

@func()
example(source: Directory, ): DaggerCli {
	return dag
		.dagger(source)
		.cli()
}

go() 🔗

Dagger’s Go toolchain

Return Type

GoToolchain !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH go

func (m *myModule) example(source *Directory) *DaggerGoToolchain  {
	return dag.
			Dagger(source).
			Go()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerGoToolchain:
	return (
		dag.dagger(source)
		.go()
	)

@func()
example(source: Directory, ): DaggerGoToolchain {
	return dag
		.dagger(source)
		.go()
}

engine() 🔗

Develop the Dagger engine container

Return Type

Engine !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH engine

func (m *myModule) example(source *Directory) *DaggerEngine  {
	return dag.
			Dagger(source).
			Engine()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerEngine:
	return (
		dag.dagger(source)
		.engine()
	)

@func()
example(source: Directory, ): DaggerEngine {
	return dag
		.dagger(source)
		.engine()
}

docs() 🔗

Develop the Dagger documentation

Return Type

Docs !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH docs

func (m *myModule) example(source *Directory) *DaggerDocs  {
	return dag.
			Dagger(source).
			Docs()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerDocs:
	return (
		dag.dagger(source)
		.docs()
	)

@func()
example(source: Directory, ): DaggerDocs {
	return dag
		.dagger(source)
		.docs()
}

test() 🔗

Run all tests

Return Type

Test !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH test

func (m *myModule) example(source *Directory) *DaggerTest  {
	return dag.
			Dagger(source).
			Test()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerTest:
	return (
		dag.dagger(source)
		.test()
	)

@func()
example(source: Directory, ): DaggerTest {
	return dag
		.dagger(source)
		.test()
}

sdk() 🔗

Develop Dagger SDKs

Return Type

Sdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH sdk

func (m *myModule) example(source *Directory) *DaggerSdk  {
	return dag.
			Dagger(source).
			Sdk()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerSdk:
	return (
		dag.dagger(source)
		.sdk()
	)

@func()
example(source: Directory, ): DaggerSdk {
	return dag
		.dagger(source)
		.sdk()
}

helm() 🔗

Develop the Dagger helm chart

Return Type

Helm !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH helm

func (m *myModule) example(source *Directory) *DaggerHelm  {
	return dag.
			Dagger(source).
			Helm()
}

@function
def example(source: dagger.Directory, ) -> dag.DaggerHelm:
	return (
		dag.dagger(source)
		.helm()
	)

@func()
example(source: Directory, ): DaggerHelm {
	return dag
		.dagger(source)
		.helm()
}

dev() 🔗

Creates a dev container that has a running CLI connected to a dagger engine

Return Type

Container !

Arguments

Name	Type	Default Value	Description
target	Directory	-	Mount a directory into the container's workdir, for convenience
experimentalGpusupport	Boolean	-	Enable experimental GPU support

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 --source DIR_PATH dev

func (m *myModule) example(source *Directory) *Container  {
	return dag.
			Dagger(source).
			Dev()
}

@function
def example(source: dagger.Directory, ) -> dagger.Container:
	return (
		dag.dagger(source)
		.dev()
	)

@func()
example(source: Directory, ): Container {
	return dag
		.dagger(source)
		.dev()
}

Cli 🔗

file() 🔗

Build the CLI binary

Return Type

File !

Arguments

Name	Type	Default Value	Description
platform	Scalar	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 cli \
 file

func (m *myModule) example() *File  {
	return dag.
			Dagger().
			Cli().
			File()
}

@function
def example() -> dagger.File:
	return (
		dag.dagger()
		.cli()
		.file()
	)

@func()
example(): File {
	return dag
		.dagger()
		.cli()
		.file()
}

publish() 🔗

Publish the CLI using GoReleaser

Return Type

Void !

Arguments

Name	Type	Default Value	Description
gitDir	Directory !	-	No description provided
githubOrgName	String !	-	No description provided
githubToken	Secret !	-	No description provided
goreleaserKey	Secret !	-	No description provided
awsAccessKeyId	Secret !	-	No description provided
awsSecretAccessKey	Secret !	-	No description provided
awsRegion	Secret !	-	No description provided
awsBucket	Secret !	-	No description provided
artefactsFqdn	Secret !	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 cli \
 publish --git-dir DIR_PATH --github-org-name string --github-token env:MYSECRET --goreleaser-key env:MYSECRET --aws-access-key-id env:MYSECRET --aws-secret-access-key env:MYSECRET --aws-region env:MYSECRET --aws-bucket env:MYSECRET --artefacts-fqdn env:MYSECRET

func (m *myModule) example(ctx context.Context, gitDir *Directory, githubOrgName string, githubToken *Secret, goreleaserKey *Secret, awsAccessKeyId *Secret, awsSecretAccessKey *Secret, awsRegion *Secret, awsBucket *Secret, artefactsFqdn *Secret)   {
	return dag.
			Dagger().
			Cli().
			Publish(ctx, gitDir, githubOrgName, githubToken, goreleaserKey, awsAccessKeyId, awsSecretAccessKey, awsRegion, awsBucket, artefactsFqdn)
}

@function
async def example(git_dir: dagger.Directory, github_org_name: str, github_token: dagger.Secret, goreleaser_key: dagger.Secret, aws_access_key_id: dagger.Secret, aws_secret_access_key: dagger.Secret, aws_region: dagger.Secret, aws_bucket: dagger.Secret, artefacts_fqdn: dagger.Secret) -> None:
	return await (
		dag.dagger()
		.cli()
		.publish(git_dir, github_org_name, github_token, goreleaser_key, aws_access_key_id, aws_secret_access_key, aws_region, aws_bucket, artefacts_fqdn)
	)

@func()
async example(gitDir: Directory, githubOrgName: string, githubToken: Secret, goreleaserKey: Secret, awsAccessKeyId: Secret, awsSecretAccessKey: Secret, awsRegion: Secret, awsBucket: Secret, artefactsFqdn: Secret): Promise<void> {
	return dag
		.dagger()
		.cli()
		.publish(gitDir, githubOrgName, githubToken, goreleaserKey, awsAccessKeyId, awsSecretAccessKey, awsRegion, awsBucket, artefactsFqdn)
}

testPublish() 🔗

Verify that the CLI builds without actually publishing anything

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 cli \
 test-publish

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Cli().
			TestPublish(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.cli()
		.test_publish()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.cli()
		.testPublish()
}

GoToolchain 🔗

withCodegen() 🔗

Run codegen (equivalent to dagger develop) in the specified subdirectories

Return Type

GoToolchain !

Arguments

Name	Type	Default Value	Description
subdirs	[String ! ] !	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 go \
 with-codegen --subdirs string1 --subdirs string2

func (m *myModule) example(subdirs []string) *DaggerGoToolchain  {
	return dag.
			Dagger().
			Go().
			WithCodegen(subdirs)
}

@function
def example(subdirs: List[str]) -> dag.DaggerGoToolchain:
	return (
		dag.dagger()
		.go()
		.with_codegen(subdirs)
	)

@func()
example(subdirs: string[]): DaggerGoToolchain {
	return dag
		.dagger()
		.go()
		.withCodegen(subdirs)
}

env() 🔗

Return Type

Container !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 go \
 env

func (m *myModule) example() *Container  {
	return dag.
			Dagger().
			Go().
			Env()
}

@function
def example() -> dagger.Container:
	return (
		dag.dagger()
		.go()
		.env()
	)

@func()
example(): Container {
	return dag
		.dagger()
		.go()
		.env()
}

lint() 🔗

Return Type

Void !

Arguments

Name	Type	Default Value	Description
packages	[String ! ] !	-	No description provided
all	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 go \
 lint --packages string1 --packages string2

func (m *myModule) example(ctx context.Context, packages []string)   {
	return dag.
			Dagger().
			Go().
			Lint(ctx, packages)
}

@function
async def example(packages: List[str]) -> None:
	return await (
		dag.dagger()
		.go()
		.lint(packages)
	)

@func()
async example(packages: string[]): Promise<void> {
	return dag
		.dagger()
		.go()
		.lint(packages)
}

Engine 🔗

withConfig() 🔗

Return Type

Engine !

Arguments

Name	Type	Default Value	Description
key	String !	-	No description provided
value	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 with-config --key string --value string

func (m *myModule) example(key string, value string) *DaggerEngine  {
	return dag.
			Dagger().
			Engine().
			WithConfig(key, value)
}

@function
def example(key: str, value: str) -> dag.DaggerEngine:
	return (
		dag.dagger()
		.engine()
		.with_config(key, value)
	)

@func()
example(key: string, value: string): DaggerEngine {
	return dag
		.dagger()
		.engine()
		.withConfig(key, value)
}

withArg() 🔗

Return Type

Engine !

Arguments

Name	Type	Default Value	Description
key	String !	-	No description provided
value	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 with-arg --key string --value string

func (m *myModule) example(key string, value string) *DaggerEngine  {
	return dag.
			Dagger().
			Engine().
			WithArg(key, value)
}

@function
def example(key: str, value: str) -> dag.DaggerEngine:
	return (
		dag.dagger()
		.engine()
		.with_arg(key, value)
	)

@func()
example(key: string, value: string): DaggerEngine {
	return dag
		.dagger()
		.engine()
		.withArg(key, value)
}

withTrace() 🔗

Return Type

Engine !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 with-trace

func (m *myModule) example() *DaggerEngine  {
	return dag.
			Dagger().
			Engine().
			WithTrace()
}

@function
def example() -> dag.DaggerEngine:
	return (
		dag.dagger()
		.engine()
		.with_trace()
	)

@func()
example(): DaggerEngine {
	return dag
		.dagger()
		.engine()
		.withTrace()
}

withBase() 🔗

Return Type

Engine !

Arguments

Name	Type	Default Value	Description
image	String	-	No description provided
gpuSupport	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 with-base

func (m *myModule) example() *DaggerEngine  {
	return dag.
			Dagger().
			Engine().
			WithBase()
}

@function
def example() -> dag.DaggerEngine:
	return (
		dag.dagger()
		.engine()
		.with_base()
	)

@func()
example(): DaggerEngine {
	return dag
		.dagger()
		.engine()
		.withBase()
}

container() 🔗

Build the engine container

Return Type

Container !

Arguments

Name	Type	Default Value	Description
platform	Scalar	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 container

func (m *myModule) example() *Container  {
	return dag.
			Dagger().
			Engine().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.dagger()
		.engine()
		.container()
	)

@func()
example(): Container {
	return dag
		.dagger()
		.engine()
		.container()
}

service() 🔗

Create a test engine service

Return Type

Service !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 service --name string

func (m *myModule) example(name string) *Service  {
	return dag.
			Dagger().
			Engine().
			Service(name)
}

@function
def example(name: str) -> dagger.Service:
	return (
		dag.dagger()
		.engine()
		.service(name)
	)

@func()
example(name: string): Service {
	return dag
		.dagger()
		.engine()
		.service(name)
}

lint() 🔗

Lint the engine

Return Type

Void !

Arguments

Name	Type	Default Value	Description
all	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 lint

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Engine().
			Lint(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.engine()
		.lint()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.engine()
		.lint()
}

publish() 🔗

Publish all engine images to a registry

Return Type

String !

Arguments

Name	Type	Default Value	Description
image	String !	-	No description provided
platform	[Scalar ! ]	-	No description provided
registry	String	-	No description provided
registryUsername	String	-	No description provided
registryPassword	Secret	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 publish --image string

func (m *myModule) example(ctx context.Context, image string) string  {
	return dag.
			Dagger().
			Engine().
			Publish(ctx, image)
}

@function
async def example(image: str) -> str:
	return await (
		dag.dagger()
		.engine()
		.publish(image)
	)

@func()
async example(image: string): Promise<string> {
	return dag
		.dagger()
		.engine()
		.publish(image)
}

testPublish() 🔗

Verify that the engine builds without actually publishing anything

Return Type

Void !

Arguments

Name	Type	Default Value	Description
platform	[Scalar ! ]	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 test-publish

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Engine().
			TestPublish(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.engine()
		.test_publish()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.engine()
		.testPublish()
}

scan() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 engine \
 scan

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Dagger().
			Engine().
			Scan(ctx)
}

@function
async def example() -> str:
	return await (
		dag.dagger()
		.engine()
		.scan()
	)

@func()
async example(): Promise<string> {
	return dag
		.dagger()
		.engine()
		.scan()
}

Docs 🔗

site() 🔗

Build the docs website

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 docs \
 site

func (m *myModule) example() *Directory  {
	return dag.
			Dagger().
			Docs().
			Site()
}

@function
def example() -> dagger.Directory:
	return (
		dag.dagger()
		.docs()
		.site()
	)

@func()
example(): Directory {
	return dag
		.dagger()
		.docs()
		.site()
}

server() 🔗

Build the docs server

Return Type

Container !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 docs \
 server

func (m *myModule) example() *Container  {
	return dag.
			Dagger().
			Docs().
			Server()
}

@function
def example() -> dagger.Container:
	return (
		dag.dagger()
		.docs()
		.server()
	)

@func()
example(): Container {
	return dag
		.dagger()
		.docs()
		.server()
}

lint() 🔗

Lint documentation files

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 docs \
 lint

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Docs().
			Lint(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.docs()
		.lint()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.docs()
		.lint()
}

generate() 🔗

Regenerate the API schema and CLI reference docs

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 docs \
 generate

func (m *myModule) example() *Directory  {
	return dag.
			Dagger().
			Docs().
			Generate()
}

@function
def example() -> dagger.Directory:
	return (
		dag.dagger()
		.docs()
		.generate()
	)

@func()
example(): Directory {
	return dag
		.dagger()
		.docs()
		.generate()
}

generateSdl() 🔗

Regenerate the API schema

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 docs \
 generate-sdl

func (m *myModule) example() *Directory  {
	return dag.
			Dagger().
			Docs().
			GenerateSdl()
}

@function
def example() -> dagger.Directory:
	return (
		dag.dagger()
		.docs()
		.generate_sdl()
	)

@func()
example(): Directory {
	return dag
		.dagger()
		.docs()
		.generateSdl()
}

generateCli() 🔗

Regenerate the CLI reference docs

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 docs \
 generate-cli

func (m *myModule) example() *Directory  {
	return dag.
			Dagger().
			Docs().
			GenerateCli()
}

@function
def example() -> dagger.Directory:
	return (
		dag.dagger()
		.docs()
		.generate_cli()
	)

@func()
example(): Directory {
	return dag
		.dagger()
		.docs()
		.generateCli()
}

Test 🔗

withCache() 🔗

Return Type

Test !

Arguments

Name	Type	Default Value	Description
config	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 test \
 with-cache --config string

func (m *myModule) example(config string) *DaggerTest  {
	return dag.
			Dagger().
			Test().
			WithCache(config)
}

@function
def example(config: str) -> dag.DaggerTest:
	return (
		dag.dagger()
		.test()
		.with_cache(config)
	)

@func()
example(config: string): DaggerTest {
	return dag
		.dagger()
		.test()
		.withCache(config)
}

all() 🔗

Run all engine tests

Return Type

Void !

Arguments

Name	Type	Default Value	Description
failfast	Boolean	-	No description provided
parallel	Integer	-	No description provided
timeout	String	-	No description provided
race	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 test \
 all

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Test().
			All(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.test()
		.all()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.test()
		.all()
}

important() 🔗

Run “important” engine tests

Return Type

Void !

Arguments

Name	Type	Default Value	Description
failfast	Boolean	-	No description provided
parallel	Integer	-	No description provided
timeout	String	-	No description provided
race	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 test \
 important

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Test().
			Important(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.test()
		.important()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.test()
		.important()
}

custom() 🔗

Run custom engine tests

Return Type

Void !

Arguments

Name	Type	Default Value	Description
run	String !	-	No description provided
pkg	String	"./..."	No description provided
failfast	Boolean	-	No description provided
parallel	Integer	-	No description provided
timeout	String	-	No description provided
race	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 test \
 custom --run string

func (m *myModule) example(ctx context.Context, run string)   {
	return dag.
			Dagger().
			Test().
			Custom(ctx, run)
}

@function
async def example(run: str) -> None:
	return await (
		dag.dagger()
		.test()
		.custom(run)
	)

@func()
async example(run: string): Promise<void> {
	return dag
		.dagger()
		.test()
		.custom(run)
}

Sdk 🔗

A dev environment for the official Dagger SDKs

go() 🔗

Develop the Dagger Go SDK

Return Type

GoSdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 go

func (m *myModule) example() *DaggerGoSdk  {
	return dag.
			Dagger().
			Sdk().
			Go()
}

@function
def example() -> dag.DaggerGoSdk:
	return (
		dag.dagger()
		.sdk()
		.go()
	)

@func()
example(): DaggerGoSdk {
	return dag
		.dagger()
		.sdk()
		.go()
}

python() 🔗

Develop the Dagger Python SDK

Return Type

PythonSdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 python

func (m *myModule) example() *DaggerPythonSdk  {
	return dag.
			Dagger().
			Sdk().
			Python()
}

@function
def example() -> dag.DaggerPythonSdk:
	return (
		dag.dagger()
		.sdk()
		.python()
	)

@func()
example(): DaggerPythonSdk {
	return dag
		.dagger()
		.sdk()
		.python()
}

typescript() 🔗

Develop the Dagger Typescript SDK

Return Type

TypescriptSdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 typescript

func (m *myModule) example() *DaggerTypescriptSdk  {
	return dag.
			Dagger().
			Sdk().
			Typescript()
}

@function
def example() -> dag.DaggerTypescriptSdk:
	return (
		dag.dagger()
		.sdk()
		.typescript()
	)

@func()
example(): DaggerTypescriptSdk {
	return dag
		.dagger()
		.sdk()
		.typescript()
}

elixir() 🔗

Develop the Dagger Elixir SDK (experimental)

Return Type

ElixirSdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 elixir

func (m *myModule) example() *DaggerElixirSdk  {
	return dag.
			Dagger().
			Sdk().
			Elixir()
}

@function
def example() -> dag.DaggerElixirSdk:
	return (
		dag.dagger()
		.sdk()
		.elixir()
	)

@func()
example(): DaggerElixirSdk {
	return dag
		.dagger()
		.sdk()
		.elixir()
}

rust() 🔗

Develop the Dagger Rust SDK (experimental)

Return Type

RustSdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 rust

func (m *myModule) example() *DaggerRustSdk  {
	return dag.
			Dagger().
			Sdk().
			Rust()
}

@function
def example() -> dag.DaggerRustSdk:
	return (
		dag.dagger()
		.sdk()
		.rust()
	)

@func()
example(): DaggerRustSdk {
	return dag
		.dagger()
		.sdk()
		.rust()
}

php() 🔗

Develop the Dagger PHP SDK (experimental)

Return Type

Phpsdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 php

func (m *myModule) example() *DaggerPhpsdk  {
	return dag.
			Dagger().
			Sdk().
			Php()
}

@function
def example() -> dag.DaggerPhpsdk:
	return (
		dag.dagger()
		.sdk()
		.php()
	)

@func()
example(): DaggerPhpsdk {
	return dag
		.dagger()
		.sdk()
		.php()
}

java() 🔗

Develop the Dagger Java SDK (experimental)

Return Type

JavaSdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 java

func (m *myModule) example() *DaggerJavaSdk  {
	return dag.
			Dagger().
			Sdk().
			Java()
}

@function
def example() -> dag.DaggerJavaSdk:
	return (
		dag.dagger()
		.sdk()
		.java()
	)

@func()
example(): DaggerJavaSdk {
	return dag
		.dagger()
		.sdk()
		.java()
}

all() 🔗

Return Type

AllSdk !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 all

func (m *myModule) example() *DaggerAllSdk  {
	return dag.
			Dagger().
			Sdk().
			All()
}

@function
def example() -> dag.DaggerAllSdk:
	return (
		dag.dagger()
		.sdk()
		.all()
	)

@func()
example(): DaggerAllSdk {
	return dag
		.dagger()
		.sdk()
		.all()
}

Helm 🔗

test() 🔗

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 helm \
 test

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Helm().
			Test(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.helm()
		.test()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.helm()
		.test()
}

publish() 🔗

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
githubToken	Secret	-	No description provided
dryRun	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 helm \
 publish --tag string

func (m *myModule) example(ctx context.Context, tag string)   {
	return dag.
			Dagger().
			Helm().
			Publish(ctx, tag)
}

@function
async def example(tag: str) -> None:
	return await (
		dag.dagger()
		.helm()
		.publish(tag)
	)

@func()
async example(tag: string): Promise<void> {
	return dag
		.dagger()
		.helm()
		.publish(tag)
}

VersionInfo 🔗

tag() 🔗

Return Type

String !

Example

Function DaggerVersionInfo.tag is not accessible from the dagger module

Function DaggerVersionInfo.tag is not accessible from the dagger module

Function DaggerVersionInfo.tag is not accessible from the dagger module

Function DaggerVersionInfo.tag is not accessible from the dagger module

commit() 🔗

Return Type

String !

Example

Function DaggerVersionInfo.commit is not accessible from the dagger module

Function DaggerVersionInfo.commit is not accessible from the dagger module

Function DaggerVersionInfo.commit is not accessible from the dagger module

Function DaggerVersionInfo.commit is not accessible from the dagger module

dev() 🔗

Return Type

String !

Example

Function DaggerVersionInfo.dev is not accessible from the dagger module

Function DaggerVersionInfo.dev is not accessible from the dagger module

Function DaggerVersionInfo.dev is not accessible from the dagger module

Function DaggerVersionInfo.dev is not accessible from the dagger module

string() 🔗

Return Type

String !

Example

Function DaggerVersionInfo.string is not accessible from the dagger module

Function DaggerVersionInfo.string is not accessible from the dagger module

Function DaggerVersionInfo.string is not accessible from the dagger module

Function DaggerVersionInfo.string is not accessible from the dagger module

AllSdk 🔗

lint() 🔗

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 all \
 lint

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Sdk().
			All().
			Lint(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.sdk()
		.all()
		.lint()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.sdk()
		.all()
		.lint()
}

test() 🔗

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 all \
 test

func (m *myModule) example(ctx context.Context)   {
	return dag.
			Dagger().
			Sdk().
			All().
			Test(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger()
		.sdk()
		.all()
		.test()
	)

@func()
async example(): Promise<void> {
	return dag
		.dagger()
		.sdk()
		.all()
		.test()
}

generate() 🔗

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 all \
 generate

func (m *myModule) example() *Directory  {
	return dag.
			Dagger().
			Sdk().
			All().
			Generate()
}

@function
def example() -> dagger.Directory:
	return (
		dag.dagger()
		.sdk()
		.all()
		.generate()
	)

@func()
example(): Directory {
	return dag
		.dagger()
		.sdk()
		.all()
		.generate()
}

bump() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger@d0e97b1df946cb44df1415ed0e3bf2b8c4e91d80 call \
 sdk \
 all \
 bump --version string

func (m *myModule) example(version string) *Directory  {
	return dag.
			Dagger().
			Sdk().
			All().
			Bump(version)
}

@function
def example(version: str) -> dagger.Directory:
	return (
		dag.dagger()
		.sdk()
		.all()
		.bump(version)
	)

@func()
example(version: string): Directory {
	return dag
		.dagger()
		.sdk()
		.all()
		.bump(version)
}

GoSdk 🔗

lint() 🔗

Lint the Go SDK

Return Type

Void !

Example

Function DaggerGoSdk.lint is not accessible from the dagger module

Function DaggerGoSdk.lint is not accessible from the dagger module

Function DaggerGoSdk.lint is not accessible from the dagger module

Function DaggerGoSdk.lint is not accessible from the dagger module

test() 🔗

Test the Go SDK

Return Type

Void !

Example

Function DaggerGoSdk.test is not accessible from the dagger module

Function DaggerGoSdk.test is not accessible from the dagger module

Function DaggerGoSdk.test is not accessible from the dagger module

Function DaggerGoSdk.test is not accessible from the dagger module

generate() 🔗

Regenerate the Go SDK API

Return Type

Directory !

Example

Function DaggerGoSdk.generate is not accessible from the dagger module

Function DaggerGoSdk.generate is not accessible from the dagger module

Function DaggerGoSdk.generate is not accessible from the dagger module

Function DaggerGoSdk.generate is not accessible from the dagger module

publish() 🔗

Publish the Go SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
dryRun	Boolean	-	No description provided
gitRepo	String	"https://github.com/dagger/dagger-go-sdk.git"	No description provided
gitUserName	String	"dagger-ci"	No description provided
gitUserEmail	String	"[email protected]"	No description provided
githubToken	Secret	-	No description provided

Example

Function DaggerGoSdk.publish is not accessible from the dagger module

Function DaggerGoSdk.publish is not accessible from the dagger module

Function DaggerGoSdk.publish is not accessible from the dagger module

Function DaggerGoSdk.publish is not accessible from the dagger module

bump() 🔗

Bump the Go SDK’s Engine dependency

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

Function DaggerGoSdk.bump is not accessible from the dagger module

Function DaggerGoSdk.bump is not accessible from the dagger module

Function DaggerGoSdk.bump is not accessible from the dagger module

Function DaggerGoSdk.bump is not accessible from the dagger module

PythonSdk 🔗

lint() 🔗

Lint the Python SDK

Return Type

Void !

Example

Function DaggerPythonSdk.lint is not accessible from the dagger module

Function DaggerPythonSdk.lint is not accessible from the dagger module

Function DaggerPythonSdk.lint is not accessible from the dagger module

Function DaggerPythonSdk.lint is not accessible from the dagger module

test() 🔗

Test the Python SDK

Return Type

Void !

Example

Function DaggerPythonSdk.test is not accessible from the dagger module

Function DaggerPythonSdk.test is not accessible from the dagger module

Function DaggerPythonSdk.test is not accessible from the dagger module

Function DaggerPythonSdk.test is not accessible from the dagger module

generate() 🔗

Regenerate the Python SDK API

Return Type

Directory !

Example

Function DaggerPythonSdk.generate is not accessible from the dagger module

Function DaggerPythonSdk.generate is not accessible from the dagger module

Function DaggerPythonSdk.generate is not accessible from the dagger module

Function DaggerPythonSdk.generate is not accessible from the dagger module

publish() 🔗

Publish the Python SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
dryRun	Boolean	-	No description provided
pypiRepo	String	-	No description provided
pypiToken	Secret	-	No description provided

Example

Function DaggerPythonSdk.publish is not accessible from the dagger module

Function DaggerPythonSdk.publish is not accessible from the dagger module

Function DaggerPythonSdk.publish is not accessible from the dagger module

Function DaggerPythonSdk.publish is not accessible from the dagger module

bump() 🔗

Bump the Python SDK’s Engine dependency

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

Function DaggerPythonSdk.bump is not accessible from the dagger module

Function DaggerPythonSdk.bump is not accessible from the dagger module

Function DaggerPythonSdk.bump is not accessible from the dagger module

Function DaggerPythonSdk.bump is not accessible from the dagger module

TypescriptSdk 🔗

lint() 🔗

Lint the Typescript SDK

Return Type

Void !

Example

Function DaggerTypescriptSdk.lint is not accessible from the dagger module

Function DaggerTypescriptSdk.lint is not accessible from the dagger module

Function DaggerTypescriptSdk.lint is not accessible from the dagger module

Function DaggerTypescriptSdk.lint is not accessible from the dagger module

test() 🔗

Test the Typescript SDK

Return Type

Void !

Example

Function DaggerTypescriptSdk.test is not accessible from the dagger module

Function DaggerTypescriptSdk.test is not accessible from the dagger module

Function DaggerTypescriptSdk.test is not accessible from the dagger module

Function DaggerTypescriptSdk.test is not accessible from the dagger module

generate() 🔗

Regenerate the Typescript SDK API

Return Type

Directory !

Example

Function DaggerTypescriptSdk.generate is not accessible from the dagger module

Function DaggerTypescriptSdk.generate is not accessible from the dagger module

Function DaggerTypescriptSdk.generate is not accessible from the dagger module

Function DaggerTypescriptSdk.generate is not accessible from the dagger module

publish() 🔗

Publish the Typescript SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
dryRun	Boolean	-	No description provided
npmToken	Secret	-	No description provided

Example

Function DaggerTypescriptSdk.publish is not accessible from the dagger module

Function DaggerTypescriptSdk.publish is not accessible from the dagger module

Function DaggerTypescriptSdk.publish is not accessible from the dagger module

Function DaggerTypescriptSdk.publish is not accessible from the dagger module

bump() 🔗

Bump the Typescript SDK’s Engine dependency

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

Function DaggerTypescriptSdk.bump is not accessible from the dagger module

Function DaggerTypescriptSdk.bump is not accessible from the dagger module

Function DaggerTypescriptSdk.bump is not accessible from the dagger module

Function DaggerTypescriptSdk.bump is not accessible from the dagger module

ElixirSdk 🔗

lint() 🔗

Lint the Elixir SDK

Return Type

Void !

Example

Function DaggerElixirSdk.lint is not accessible from the dagger module

Function DaggerElixirSdk.lint is not accessible from the dagger module

Function DaggerElixirSdk.lint is not accessible from the dagger module

Function DaggerElixirSdk.lint is not accessible from the dagger module

test() 🔗

Test the Elixir SDK

Return Type

Void !

Example

Function DaggerElixirSdk.test is not accessible from the dagger module

Function DaggerElixirSdk.test is not accessible from the dagger module

Function DaggerElixirSdk.test is not accessible from the dagger module

Function DaggerElixirSdk.test is not accessible from the dagger module

generate() 🔗

Regenerate the Elixir SDK API

Return Type

Directory !

Example

Function DaggerElixirSdk.generate is not accessible from the dagger module

Function DaggerElixirSdk.generate is not accessible from the dagger module

Function DaggerElixirSdk.generate is not accessible from the dagger module

Function DaggerElixirSdk.generate is not accessible from the dagger module

publish() 🔗

Publish the Elixir SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
dryRun	Boolean	-	No description provided
hexApikey	Secret	-	No description provided

Example

Function DaggerElixirSdk.publish is not accessible from the dagger module

Function DaggerElixirSdk.publish is not accessible from the dagger module

Function DaggerElixirSdk.publish is not accessible from the dagger module

Function DaggerElixirSdk.publish is not accessible from the dagger module

bump() 🔗

Bump the Elixir SDK’s Engine dependency

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

Function DaggerElixirSdk.bump is not accessible from the dagger module

Function DaggerElixirSdk.bump is not accessible from the dagger module

Function DaggerElixirSdk.bump is not accessible from the dagger module

Function DaggerElixirSdk.bump is not accessible from the dagger module

RustSdk 🔗

lint() 🔗

Lint the Rust SDK

Return Type

Void !

Example

Function DaggerRustSdk.lint is not accessible from the dagger module

Function DaggerRustSdk.lint is not accessible from the dagger module

Function DaggerRustSdk.lint is not accessible from the dagger module

Function DaggerRustSdk.lint is not accessible from the dagger module

test() 🔗

Test the Rust SDK

Return Type

Void !

Example

Function DaggerRustSdk.test is not accessible from the dagger module

Function DaggerRustSdk.test is not accessible from the dagger module

Function DaggerRustSdk.test is not accessible from the dagger module

Function DaggerRustSdk.test is not accessible from the dagger module

generate() 🔗

Regenerate the Rust SDK API

Return Type

Directory !

Example

Function DaggerRustSdk.generate is not accessible from the dagger module

Function DaggerRustSdk.generate is not accessible from the dagger module

Function DaggerRustSdk.generate is not accessible from the dagger module

Function DaggerRustSdk.generate is not accessible from the dagger module

publish() 🔗

Publish the Rust SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
dryRun	Boolean	-	No description provided
cargoRegistryToken	Secret	-	No description provided

Example

Function DaggerRustSdk.publish is not accessible from the dagger module

Function DaggerRustSdk.publish is not accessible from the dagger module

Function DaggerRustSdk.publish is not accessible from the dagger module

Function DaggerRustSdk.publish is not accessible from the dagger module

bump() 🔗

Bump the Rust SDK’s Engine dependency

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

Function DaggerRustSdk.bump is not accessible from the dagger module

Function DaggerRustSdk.bump is not accessible from the dagger module

Function DaggerRustSdk.bump is not accessible from the dagger module

Function DaggerRustSdk.bump is not accessible from the dagger module

Phpsdk 🔗

lint() 🔗

Lint the PHP SDK

Return Type

Void !

Example

Function DaggerPhpsdk.lint is not accessible from the dagger module

Function DaggerPhpsdk.lint is not accessible from the dagger module

Function DaggerPhpsdk.lint is not accessible from the dagger module

Function DaggerPhpsdk.lint is not accessible from the dagger module

test() 🔗

Test the PHP SDK

Return Type

Void !

Example

Function DaggerPhpsdk.test is not accessible from the dagger module

Function DaggerPhpsdk.test is not accessible from the dagger module

Function DaggerPhpsdk.test is not accessible from the dagger module

Function DaggerPhpsdk.test is not accessible from the dagger module

generate() 🔗

Regenerate the PHP SDK API

Return Type

Directory !

Example

Function DaggerPhpsdk.generate is not accessible from the dagger module

Function DaggerPhpsdk.generate is not accessible from the dagger module

Function DaggerPhpsdk.generate is not accessible from the dagger module

Function DaggerPhpsdk.generate is not accessible from the dagger module

publish() 🔗

Publish the PHP SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
dryRun	Boolean	-	No description provided
gitRepo	String	"https://github.com/dagger/dagger-php-sdk.git"	No description provided
gitUserName	String	"dagger-ci"	No description provided
gitUserEmail	String	"[email protected]"	No description provided
githubToken	Secret	-	No description provided

Example

Function DaggerPhpsdk.publish is not accessible from the dagger module

Function DaggerPhpsdk.publish is not accessible from the dagger module

Function DaggerPhpsdk.publish is not accessible from the dagger module

Function DaggerPhpsdk.publish is not accessible from the dagger module

bump() 🔗

Bump the PHP SDK’s Engine dependency

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

Function DaggerPhpsdk.bump is not accessible from the dagger module

Function DaggerPhpsdk.bump is not accessible from the dagger module

Function DaggerPhpsdk.bump is not accessible from the dagger module

Function DaggerPhpsdk.bump is not accessible from the dagger module

JavaSdk 🔗

lint() 🔗

Lint the Java SDK

Return Type

Void !

Example

Function DaggerJavaSdk.lint is not accessible from the dagger module

Function DaggerJavaSdk.lint is not accessible from the dagger module

Function DaggerJavaSdk.lint is not accessible from the dagger module

Function DaggerJavaSdk.lint is not accessible from the dagger module

test() 🔗

Test the Java SDK

Return Type

Void !

Example

Function DaggerJavaSdk.test is not accessible from the dagger module

Function DaggerJavaSdk.test is not accessible from the dagger module

Function DaggerJavaSdk.test is not accessible from the dagger module

Function DaggerJavaSdk.test is not accessible from the dagger module

generate() 🔗

Regenerate the Java SDK API

Return Type

Directory !

Example

Function DaggerJavaSdk.generate is not accessible from the dagger module

Function DaggerJavaSdk.generate is not accessible from the dagger module

Function DaggerJavaSdk.generate is not accessible from the dagger module

Function DaggerJavaSdk.generate is not accessible from the dagger module

publish() 🔗

Publish the Java SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
dryRun	Boolean	-	No description provided

Example

Function DaggerJavaSdk.publish is not accessible from the dagger module

Function DaggerJavaSdk.publish is not accessible from the dagger module

Function DaggerJavaSdk.publish is not accessible from the dagger module

Function DaggerJavaSdk.publish is not accessible from the dagger module

bump() 🔗

Bump the Java SDK’s Engine dependency

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

Function DaggerJavaSdk.bump is not accessible from the dagger module

Function DaggerJavaSdk.bump is not accessible from the dagger module

Function DaggerJavaSdk.bump is not accessible from the dagger module

Function DaggerJavaSdk.bump is not accessible from the dagger module