shuttle
Installation
Entrypoint
Types
Shuttle

shuttle

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/kjuulh/shuttle-dagger@v0.1.0

Entrypoint

Return Type

Shuttle

Example

func (m *myModule) example() *Shuttle  {
	return dag.
			Shuttle()
}

@function
def example() -> dag.Shuttle:
	return (
		dag.shuttle()
	)

@func()
example(): Shuttle {
	return dag
		.shuttle()
}

Types

Shuttle

shuttleBin()

ShuttleBin Provides the raw binary for shuttle as a file

Return Type

File !

Example

dagger -m github.com/kjuulh/shuttle-dagger@f1fe84a328d4bd25065a62bfa88e9771f4231385 call \
 shuttle-bin

func (m *myModule) example() *File  {
	return dag.
			Shuttle().
			ShuttleBin()
}

@function
def example() -> dagger.File:
	return (
		dag.shuttle()
		.shuttle_bin()
	)

@func()
example(): File {
	return dag
		.shuttle()
		.shuttleBin()
}

exec()

Exec allows calling into a user generated query for the shuttle binary

Return Type

Container !

Arguments

Name	Type	Default Value	Description
directory	Directory !	-	No description provided
args	[String ! ] !	-	No description provided

Example

dagger -m github.com/kjuulh/shuttle-dagger@f1fe84a328d4bd25065a62bfa88e9771f4231385 call \
 exec --directory DIR_PATH --args string1 --args string2

func (m *myModule) example(directory *Directory, args []string) *Container  {
	return dag.
			Shuttle().
			Exec(directory, args)
}

@function
def example(directory: dagger.Directory, args: List[str]) -> dagger.Container:
	return (
		dag.shuttle()
		.exec(directory, args)
	)

@func()
example(directory: Directory, args: string[]): Container {
	return dag
		.shuttle()
		.exec(directory, args)
}

version()

Version prints the version of the shuttle binary

Return Type

String !

Arguments

Name	Type	Default Value	Description
directory	Directory !	-	No description provided

Example

dagger -m github.com/kjuulh/shuttle-dagger@f1fe84a328d4bd25065a62bfa88e9771f4231385 call \
 version --directory DIR_PATH

func (m *myModule) example(ctx context.Context, directory *Directory) string  {
	return dag.
			Shuttle().
			Version(ctx, directory)
}

@function
async def example(directory: dagger.Directory) -> str:
	return await (
		dag.shuttle()
		.version(directory)
	)

@func()
async example(directory: Directory): Promise<string> {
	return dag
		.shuttle()
		.version(directory)
}

prepare()

Prepare pulls the latest plan from shuttle if found and exports it to the host directory at .shuttle

Return Type

Container !

Arguments

Name	Type	Default Value	Description
directory	Directory !	-	No description provided
skipPull	Boolean !	false	No description provided

Example

dagger -m github.com/kjuulh/shuttle-dagger@f1fe84a328d4bd25065a62bfa88e9771f4231385 call \
 prepare --directory DIR_PATH --skip-pull boolean

func (m *myModule) example(directory *Directory, skipPull bool) *Container  {
	return dag.
			Shuttle().
			Prepare(directory, skipPull)
}

@function
def example(directory: dagger.Directory, skip_pull: bool) -> dagger.Container:
	return (
		dag.shuttle()
		.prepare(directory, skip_pull)
	)

@func()
example(directory: Directory, skipPull: boolean): Container {
	return dag
		.shuttle()
		.prepare(directory, skipPull)
}

run()

Run executes a user defined query on a prepared shuttle repository

Return Type

Container !

Arguments

Name	Type	Default Value	Description
directory	Directory !	-	No description provided
args	[String ! ] !	-	No description provided

Example

dagger -m github.com/kjuulh/shuttle-dagger@f1fe84a328d4bd25065a62bfa88e9771f4231385 call \
 run --directory DIR_PATH --args string1 --args string2

func (m *myModule) example(directory *Directory, args []string) *Container  {
	return dag.
			Shuttle().
			Run(directory, args)
}

@function
def example(directory: dagger.Directory, args: List[str]) -> dagger.Container:
	return (
		dag.shuttle()
		.run(directory, args)
	)

@func()
example(directory: Directory, args: string[]): Container {
	return dag
		.shuttle()
		.run(directory, args)
}