dagger-dev

https://dagger.io

Installation

dagger install github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e

Entrypoint

Return Type

DaggerDev

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \

func (m *MyModule) Example() *dagger.DaggerDev  {
	return dag.
			DaggerDev()
}

@function
def example() -> dagger.DaggerDev:
	return (
		dag.dagger_dev()
	)

@func()
example(): DaggerDev {
	return dag
		.daggerDev()
}

Types

DaggerDev 🔗

A dev environment for the DaggerDev Engine

releaseDryRun() 🔗

Perform a dry run of the release process TODO: remove after merging https://github.com/dagger/dagger/pull/11211

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 release-dry-run

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			DaggerDev().
			ReleaseDryRun(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger_dev()
		.release_dry_run()
	)

@func()
async example(): Promise<void> {
	return dag
		.daggerDev()
		.releaseDryRun()
}

checkGenerated() 🔗

Verify that generated code is up to date

Return Type

Void !

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 check-generated

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			DaggerDev().
			CheckGenerated(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger_dev()
		.check_generated()
	)

@func()
async example(): Promise<void> {
	return dag
		.daggerDev()
		.checkGenerated()
}

generate() 🔗

Run all code generation - SDKs, docs, grpc stubs, changelog

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
check	Boolean	-	No description provided

Example

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

func (m *MyModule) Example() *dagger.Changeset  {
	return dag.
			DaggerDev().
			Generate()
}

@function
def example() -> dagger.Changeset:
	return (
		dag.dagger_dev()
		.generate()
	)

@func()
example(): Changeset {
	return dag
		.daggerDev()
		.generate()
}

bump() 🔗

Return Type

Changeset !

Arguments

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

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 bump --version string

func (m *MyModule) Example(version string) *dagger.Changeset  {
	return dag.
			DaggerDev().
			Bump(version)
}

@function
def example(version: str) -> dagger.Changeset:
	return (
		dag.dagger_dev()
		.bump(version)
	)

@func()
example(version: string): Changeset {
	return dag
		.daggerDev()
		.bump(version)
}

ciInCi() 🔗

“CI in CI”: check that Dagger can still run its own CI Note: this doesn’t actually call all CI checks: only a small subset, selected for maximum coverage of Dagger features with limited compute expenditure. The actual checks being performed is an implementation detail, and should NOT be relied on. In other words, don’t skip running just because it happens to be run here!

Return Type

Void !

Arguments

Name	Type	Default Value	Description
repo	GitRepository	-	The Dagger repository to run CI against

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			DaggerDev().
			CiInCi(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger_dev()
		.ci_in_ci()
	)

@func()
async example(): Promise<void> {
	return dag
		.daggerDev()
		.ciInCi()
}

changelog() 🔗

toolchain ‘changelog’:

Return Type

Changelog !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 changelog

func (m *MyModule) Example() *dagger.Changelog  {
	return dag.
			DaggerDev().
			Changelog()
}

@function
def example() -> dagger.Changelog:
	return (
		dag.dagger_dev()
		.changelog()
	)

@func()
example(): Changelog {
	return dag
		.daggerDev()
		.changelog()
}

ci() 🔗

toolchain ‘ci’:

Return Type

Ci !

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 ci

func (m *MyModule) Example() *dagger.Ci  {
	return dag.
			DaggerDev().
			Ci()
}

@function
def example() -> dagger.Ci:
	return (
		dag.dagger_dev()
		.ci()
	)

@func()
example(): Ci {
	return dag
		.daggerDev()
		.ci()
}

cli() 🔗

toolchain ‘cli’:

Return Type

Cli !

Arguments

Name	Type	Default Value	Description
runnerHost	String	-	No description provided
source	Directory	-	No description provided
base	Container	-	Base image for go build environment

Example

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

func (m *MyModule) Example() *dagger.Cli  {
	return dag.
			DaggerDev().
			Cli()
}

@function
def example() -> dagger.Cli:
	return (
		dag.dagger_dev()
		.cli()
	)

@func()
example(): Cli {
	return dag
		.daggerDev()
		.cli()
}

docs() 🔗

toolchain ‘docs’:

Return Type

Docs !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided
nginxConfig	File	-	No description provided

Example

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

func (m *MyModule) Example() *dagger.Docs  {
	return dag.
			DaggerDev().
			Docs()
}

@function
def example() -> dagger.Docs:
	return (
		dag.dagger_dev()
		.docs()
	)

@func()
example(): Docs {
	return dag
		.daggerDev()
		.docs()
}

engineDev() 🔗

toolchain ‘engine-dev’:

Return Type

EngineDev !

Arguments

Name	Type	Default Value	Description
source	Directory	-	"", "!/go.", "!version", "!core", "!engine", "!util", "!network", "!dagql", "!analytics", "!auth", "!cmd", "!internal" ]
subnetNumber	Integer !	89	A configurable part of the IP subnet managed by the engine Change this to allow nested dagger engines
clientDockerConfig	Secret	-	A docker config file with credentials to install on clients, to ensure they can access private registries

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 engine-dev --subnet-number integer

func (m *MyModule) Example(subnetNumber int) *dagger.EngineDev  {
	return dag.
			DaggerDev().
			EngineDev(subnetNumber)
}

@function
def example(subnet_number: int) -> dagger.EngineDev:
	return (
		dag.dagger_dev()
		.engine_dev(subnet_number)
	)

@func()
example(subnetNumber: number): EngineDev {
	return dag
		.daggerDev()
		.engineDev(subnetNumber)
}

go() 🔗

toolchain ‘go’:

Return Type

Go !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Project source directory
version	String	"1.25.3"	Go version
moduleCache	CacheVolume	-	Use a custom module cache
buildCache	CacheVolume	-	Use a custom build cache
base	Container	-	Use a custom base container. The container must have Go installed.
ldflags	[String ! ]	-	Pass arguments to 'go build -ldflags''
values	[String ! ]	-	Add string value definition of the form importpath.name=value Example: "github.com/my/module.Foo=bar"
cgo	Boolean	-	Enable CGO
race	Boolean	-	Enable race detector. Implies cgo=true
experiment	[String ! ]	-	Enable go experiments https://pkg.go.dev/internal/goexperiment

Example

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

func (m *MyModule) Example() *dagger.Go  {
	return dag.
			DaggerDev().
			Go()
}

@function
def example() -> dagger.Go:
	return (
		dag.dagger_dev()
		.go()
	)

@func()
example(): Go {
	return dag
		.daggerDev()
		.go()
}

goSdk() 🔗

toolchain ‘go-sdk’:

Return Type

GoSdk !

Arguments

Name	Type	Default Value	Description
workspace	Directory	-	No description provided
sourcePath	String	-	No description provided

Example

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

func (m *MyModule) Example() *dagger.GoSdk  {
	return dag.
			DaggerDev().
			GoSdk()
}

@function
def example() -> dagger.GoSdk:
	return (
		dag.dagger_dev()
		.go_sdk()
	)

@func()
example(): GoSdk {
	return dag
		.daggerDev()
		.goSdk()
}

helm() 🔗

toolchain ‘helm’:

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
chart	Directory	-	The dagger helm chart directory

Example

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

func (m *MyModule) Example() *dagger.Helm  {
	return dag.
			DaggerDev().
			Helm()
}

@function
def example() -> dagger.Helm:
	return (
		dag.dagger_dev()
		.helm()
	)

@func()
example(): Helm {
	return dag
		.daggerDev()
		.helm()
}

installers() 🔗

toolchain ‘installers’:

Return Type

Installers !

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 installers

func (m *MyModule) Example() *dagger.Installers  {
	return dag.
			DaggerDev().
			Installers()
}

@function
def example() -> dagger.Installers:
	return (
		dag.dagger_dev()
		.installers()
	)

@func()
example(): Installers {
	return dag
		.daggerDev()
		.installers()
}

phpSdk() 🔗

toolchain ‘php-sdk’:

Return Type

PhpSdk !

Arguments

Name	Type	Default Value	Description
workspace	Directory	-	A directory with all the files needed to develop the SDK
sourcePath	String !	"sdk/php"	The path of the SDK source in the workspace
doctumConfigPath	String !	"docs/doctum-config.php"	The path of the doctum config in the workspace

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 php-sdk --source-path string --doctum-config-path string

func (m *MyModule) Example(sourcePath string, doctumConfigPath string) *dagger.PhpSdk  {
	return dag.
			DaggerDev().
			PhpSdk(sourcePath, doctumConfigPath)
}

@function
def example(source_path: str, doctum_config_path: str) -> dagger.PhpSdk:
	return (
		dag.dagger_dev()
		.php_sdk(source_path, doctum_config_path)
	)

@func()
example(sourcePath: string, doctumConfigPath: string): PhpSdk {
	return dag
		.daggerDev()
		.phpSdk(sourcePath, doctumConfigPath)
}

pythonSdk() 🔗

toolchain ‘python-sdk’:

Return Type

PythonSdk !

Arguments

Name	Type	Default Value	Description
workspace	Directory	-	No description provided
sourcePath	String !	"sdk/python"	No description provided

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 python-sdk --source-path string

func (m *MyModule) Example(sourcePath string) *dagger.PythonSdk  {
	return dag.
			DaggerDev().
			PythonSdk(sourcePath)
}

@function
def example(source_path: str) -> dagger.PythonSdk:
	return (
		dag.dagger_dev()
		.python_sdk(source_path)
	)

@func()
example(sourcePath: string): PythonSdk {
	return dag
		.daggerDev()
		.pythonSdk(sourcePath)
}

javaSdk() 🔗

toolchain ‘java-sdk’:

Return Type

JavaSdk !

Arguments

Name	Type	Default Value	Description
workspace	Directory	-	No description provided
sourcePath	String	-	No description provided

Example

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

func (m *MyModule) Example() *dagger.JavaSdk  {
	return dag.
			DaggerDev().
			JavaSdk()
}

@function
def example() -> dagger.JavaSdk:
	return (
		dag.dagger_dev()
		.java_sdk()
	)

@func()
example(): JavaSdk {
	return dag
		.daggerDev()
		.javaSdk()
}

sdks() 🔗

toolchain ‘sdks’:

Return Type

Sdks !

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 sdks

func (m *MyModule) Example() *dagger.Sdks  {
	return dag.
			DaggerDev().
			Sdks()
}

@function
def example() -> dagger.Sdks:
	return (
		dag.dagger_dev()
		.sdks()
	)

@func()
example(): Sdks {
	return dag
		.daggerDev()
		.sdks()
}

security() 🔗

toolchain ‘security’:

Return Type

Security !

Example

dagger -m github.com/shykes/dagger@edc4753d3d6a93ef6f7f1705f28b6b545596e27e call \
 security

func (m *MyModule) Example() *dagger.Security  {
	return dag.
			DaggerDev().
			Security()
}

@function
def example() -> dagger.Security:
	return (
		dag.dagger_dev()
		.security()
	)

@func()
example(): Security {
	return dag
		.daggerDev()
		.security()
}

typescriptSdk() 🔗

toolchain ‘typescript-sdk’:

Return Type

TypescriptSdk !

Arguments

Name	Type	Default Value	Description
nodeVersionPrevLts	String	-	No description provided
nodeVersionLts	String	-	No description provided
bunVersion	String	-	No description provided
workspace	Directory	-	No description provided
sourcePath	String	-	No description provided
source	Directory	-	No description provided

Example

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

func (m *MyModule) Example() *dagger.TypescriptSdk  {
	return dag.
			DaggerDev().
			TypescriptSdk()
}

@function
def example() -> dagger.TypescriptSdk:
	return (
		dag.dagger_dev()
		.typescript_sdk()
	)

@func()
example(): TypescriptSdk {
	return dag
		.daggerDev()
		.typescriptSdk()
}