Dagger
Search

sample-dagger-module

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/willgorman/sample-dagger-module@ae8784e3a0e2ecd09ae6e36272005cb8e95a1d1b

Entrypoint

Return Type 
SampleDaggerModule
Example
dagger -m github.com/willgorman/sample-dagger-module@ae8784e3a0e2ecd09ae6e36272005cb8e95a1d1b call \

func (m *myModule) example() *SampleDaggerModule  {
	return dag.
			SampleDaggerModule()
}
@function
def example() -> dag.SampleDaggerModule:
	return (
		dag.sample_dagger_module()
	)
@func()
example(): SampleDaggerModule {
	return dag
		.sampleDaggerModule()
}

Types

SampleDaggerModule 🔗

containerEcho() 🔗

Returns a container that echoes whatever string argument is provided

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
stringArgString !-No description provided
Example
dagger -m github.com/willgorman/sample-dagger-module@ae8784e3a0e2ecd09ae6e36272005cb8e95a1d1b call \
 container-echo --string-arg string
func (m *myModule) example(stringArg string) *Container  {
	return dag.
			SampleDaggerModule().
			ContainerEcho(stringArg)
}
@function
def example(string_arg: str) -> dagger.Container:
	return (
		dag.sample_dagger_module()
		.container_echo(string_arg)
	)
@func()
example(stringArg: string): Container {
	return dag
		.sampleDaggerModule()
		.containerEcho(stringArg)
}

grepDir() 🔗

Returns lines that match a pattern in the files of the provided Directory

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
directoryArgDirectory !-No description provided
patternString !-No description provided
Example
dagger -m github.com/willgorman/sample-dagger-module@ae8784e3a0e2ecd09ae6e36272005cb8e95a1d1b call \
 grep-dir --directory-arg DIR_PATH --pattern string
func (m *myModule) example(ctx context.Context, directoryArg *Directory, pattern string) string  {
	return dag.
			SampleDaggerModule().
			GrepDir(ctx, directoryArg, pattern)
}
@function
async def example(directory_arg: dagger.Directory, pattern: str) -> str:
	return await (
		dag.sample_dagger_module()
		.grep_dir(directory_arg, pattern)
	)
@func()
async example(directoryArg: Directory, pattern: string): Promise<string> {
	return dag
		.sampleDaggerModule()
		.grepDir(directoryArg, pattern)
}

httpService() 🔗

Return Type 
Service !
Example
dagger -m github.com/willgorman/sample-dagger-module@ae8784e3a0e2ecd09ae6e36272005cb8e95a1d1b call \
 http-service
func (m *myModule) example() *Service  {
	return dag.
			SampleDaggerModule().
			HttpService()
}
@function
def example() -> dagger.Service:
	return (
		dag.sample_dagger_module()
		.http_service()
	)
@func()
example(): Service {
	return dag
		.sampleDaggerModule()
		.httpService()
}