kas

No long description provided.

Installation

dagger install github.com/skycaptain/daggerverse/kas@2157d21c9fbbf0497c5253f5a490a15cbce1ccdf

Entrypoint

Return Type

Kas !

Arguments

Name	Type	Description
baseRef	String !	No description provided
src	Directory	A directory.
netrc	Secret	No description provided

Example

func (m *myModule) example(baseRef string) *Kas  {
	return dag.
			Kas(baseRef)
}

@function
def example(base_ref: str, ) -> dag.Kas:
	return (
		dag.kas(base_ref)
	)

@func()
example(baseRef: string, ): Kas {
	return dag
		.kas(baseRef)
}

Types

Kas 🔗

baseRef() 🔗

Return Type

String !

Example

func (m *myModule) example(ctx context.Context, baseRef string) string  {
	return dag.
			Kas(baseRef).
			BaseRef(ctx)
}

@function
async def example(base_ref: str, ) -> str:
	return await (
		dag.kas(base_ref)
		.base_ref()
	)

@func()
async example(baseRef: string, ): Promise<string> {
	return dag
		.kas(baseRef)
		.baseRef()
}

ctr() 🔗

An OCI-compatible container, also known as a Docker container.

Return Type

Container !

Example

func (m *myModule) example(baseRef string) *Container  {
	return dag.
			Kas(baseRef).
			Ctr()
}

@function
def example(base_ref: str, ) -> dagger.Container:
	return (
		dag.kas(base_ref)
		.ctr()
	)

@func()
example(baseRef: string, ): Container {
	return dag
		.kas(baseRef)
		.ctr()
}

src() 🔗

A directory.

Return Type

Directory !

Example

func (m *myModule) example(baseRef string) *Directory  {
	return dag.
			Kas(baseRef).
			Src()
}

@function
def example(base_ref: str, ) -> dagger.Directory:
	return (
		dag.kas(base_ref)
		.src()
	)

@func()
example(baseRef: string, ): Directory {
	return dag
		.kas(baseRef)
		.src()
}

container() 🔗

Return Type

Container !

Example

func (m *myModule) example(baseRef string) *Container  {
	return dag.
			Kas(baseRef).
			Container()
}

@function
def example(base_ref: str, ) -> dagger.Container:
	return (
		dag.kas(base_ref)
		.container()
	)

@func()
example(baseRef: string, ): Container {
	return dag
		.kas(baseRef)
		.container()
}

withContainer() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
ctr	Container !	-	An OCI-compatible container, also known as a Docker container.

Example

func (m *myModule) example(baseRef string, ctr *Container) *Kas  {
	return dag.
			Kas(baseRef).
			WithContainer(ctr)
}

@function
def example(base_ref: str, ctr: dagger.Container) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_container(ctr)
	)

@func()
example(baseRef: string, ctr: Container): Kas {
	return dag
		.kas(baseRef)
		.withContainer(ctr)
}

source() 🔗

Return Type

Directory !

Example

func (m *myModule) example(baseRef string) *Directory  {
	return dag.
			Kas(baseRef).
			Source()
}

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

@func()
example(baseRef: string, ): Directory {
	return dag
		.kas(baseRef)
		.source()
}

withSource() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
path	Directory !	-	A directory.

Example

func (m *myModule) example(baseRef string, path *Directory) *Kas  {
	return dag.
			Kas(baseRef).
			WithSource(path)
}

@function
def example(base_ref: str, path: dagger.Directory) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_source(path)
	)

@func()
example(baseRef: string, path: Directory): Kas {
	return dag
		.kas(baseRef)
		.withSource(path)
}

withNetrc() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
path	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.

Example

func (m *myModule) example(baseRef string, path *Secret) *Kas  {
	return dag.
			Kas(baseRef).
			WithNetrc(path)
}

@function
def example(base_ref: str, path: dagger.Secret) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_netrc(path)
	)

@func()
example(baseRef: string, path: Secret): Kas {
	return dag
		.kas(baseRef)
		.withNetrc(path)
}

withNewNetrc() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
host	String !	-	No description provided
username	String !	-	No description provided
credential	Secret !	-	A reference to a secret value, which can be handled more safely than the value itself.

Example

func (m *myModule) example(baseRef string, host string, username string, credential *Secret) *Kas  {
	return dag.
			Kas(baseRef).
			WithNewNetrc(host, username, credential)
}

@function
def example(base_ref: str, host: str, username: str, credential: dagger.Secret) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_new_netrc(host, username, credential)
	)

@func()
example(baseRef: string, host: string, username: string, credential: Secret): Kas {
	return dag
		.kas(baseRef)
		.withNewNetrc(host, username, credential)
}

deployDir() 🔗

Return Type

Directory !

Example

func (m *myModule) example(baseRef string) *Directory  {
	return dag.
			Kas(baseRef).
			DeployDir()
}

@function
def example(base_ref: str, ) -> dagger.Directory:
	return (
		dag.kas(base_ref)
		.deploy_dir()
	)

@func()
example(baseRef: string, ): Directory {
	return dag
		.kas(baseRef)
		.deployDir()
}

withPrepare() 🔗

Return Type

Kas !

Example

func (m *myModule) example(baseRef string) *Kas  {
	return dag.
			Kas(baseRef).
			WithPrepare()
}

@function
def example(base_ref: str, ) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_prepare()
	)

@func()
example(baseRef: string, ): Kas {
	return dag
		.kas(baseRef)
		.withPrepare()
}

prepare() 🔗

Return Type

Container !

Example

func (m *myModule) example(baseRef string) *Container  {
	return dag.
			Kas(baseRef).
			Prepare()
}

@function
def example(base_ref: str, ) -> dagger.Container:
	return (
		dag.kas(base_ref)
		.prepare()
	)

@func()
example(baseRef: string, ): Container {
	return dag
		.kas(baseRef)
		.prepare()
}

withExec() 🔗

Return Type

Kas !

Arguments

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

Example

func (m *myModule) example(baseRef string, args []string) *Kas  {
	return dag.
			Kas(baseRef).
			WithExec(args)
}

@function
def example(base_ref: str, args: List[str]) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_exec(args)
	)

@func()
example(baseRef: string, args: string[]): Kas {
	return dag
		.kas(baseRef)
		.withExec(args)
}

exec() 🔗

Return Type

String !

Arguments

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

Example

func (m *myModule) example(ctx context.Context, baseRef string, args []string) string  {
	return dag.
			Kas(baseRef).
			Exec(ctx, args)
}

@function
async def example(base_ref: str, args: List[str]) -> str:
	return await (
		dag.kas(base_ref)
		.exec(args)
	)

@func()
async example(baseRef: string, args: string[]): Promise<string> {
	return dag
		.kas(baseRef)
		.exec(args)
}

withKas() 🔗

Return Type

Kas !

Arguments

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

Example

func (m *myModule) example(baseRef string, args []string) *Kas  {
	return dag.
			Kas(baseRef).
			WithKas(args)
}

@function
def example(base_ref: str, args: List[str]) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_kas(args)
	)

@func()
example(baseRef: string, args: string[]): Kas {
	return dag
		.kas(baseRef)
		.withKas(args)
}

kas() 🔗

Return Type

String !

Arguments

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

Example

func (m *myModule) example(ctx context.Context, baseRef string, args []string) string  {
	return dag.
			Kas(baseRef).
			Kas(ctx, args)
}

@function
async def example(base_ref: str, args: List[str]) -> str:
	return await (
		dag.kas(base_ref)
		.kas(args)
	)

@func()
async example(baseRef: string, args: string[]): Promise<string> {
	return dag
		.kas(baseRef)
		.kas(args)
}

withCheckout() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
config	String !	".config.yaml"	Config file(s), separated by colon

Example

func (m *myModule) example(baseRef string, config string) *Kas  {
	return dag.
			Kas(baseRef).
			WithCheckout(config)
}

@function
def example(base_ref: str, config: str) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_checkout(config)
	)

@func()
example(baseRef: string, config: string): Kas {
	return dag
		.kas(baseRef)
		.withCheckout(config)
}

checkout() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
config	String !	".config.yaml"	Config file(s), separated by colon

Example

func (m *myModule) example(baseRef string, config string) *Directory  {
	return dag.
			Kas(baseRef).
			Checkout(config)
}

@function
def example(base_ref: str, config: str) -> dagger.Directory:
	return (
		dag.kas(base_ref)
		.checkout(config)
	)

@func()
example(baseRef: string, config: string): Directory {
	return dag
		.kas(baseRef)
		.checkout(config)
}

withDump() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
config	String !	".config.yaml"	Config file(s), separated by colon
skip	[String ! ]	null	Skip build steps
forceCheckout	Boolean !	false	Always checkout the desired commit/branch/tag of each repository, discarding any local changes
update	Boolean !	false	Pull new upstream changes to the desired branch even if it is already checked out locally
format	String !	"yaml"	Output format. Possible choices: yaml, json
indent	Integer !	4	Line indent (# of spaces)
resolveRefs	Boolean !	false	Replace floating refs with exact SHAs
resolveEnv	Boolean !	false	Set env defaults to captured env value
lock	Boolean !	false	Create lockfile with exact SHAs
inplace	Boolean !	false	Update lockfile in-place (requires –lock)

Example

func (m *myModule) example(baseRef string, config string, forceCheckout bool, update bool, format string, indent int, resolveRefs bool, resolveEnv bool, lock bool, inplace bool) *Kas  {
	return dag.
			Kas(baseRef).
			WithDump(config, forceCheckout, update, format, indent, resolveRefs, resolveEnv, lock, inplace)
}

@function
def example(base_ref: str, config: str, force_checkout: bool, update: bool, format: str, indent: int, resolve_refs: bool, resolve_env: bool, lock: bool, inplace: bool) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_dump(config, force_checkout, update, format, indent, resolve_refs, resolve_env, lock, inplace)
	)

@func()
example(baseRef: string, config: string, forceCheckout: boolean, update: boolean, format: string, indent: number, resolveRefs: boolean, resolveEnv: boolean, lock: boolean, inplace: boolean): Kas {
	return dag
		.kas(baseRef)
		.withDump(config, forceCheckout, update, format, indent, resolveRefs, resolveEnv, lock, inplace)
}

dump() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
config	String !	".config.yaml"	Config file(s), separated by colon
skip	[String ! ]	null	Skip build steps
forceCheckout	Boolean !	false	Always checkout the desired commit/branch/tag of each repository, discarding any local changes
update	Boolean !	false	Pull new upstream changes to the desired branch even if it is already checked out locally
format	String !	"yaml"	Output format. Possible choices: yaml, json
indent	Integer !	4	Line indent (# of spaces)
resolveRefs	Boolean !	false	Replace floating refs with exact SHAs
resolveEnv	Boolean !	false	Set env defaults to captured env value
lock	Boolean !	false	Create lockfile with exact SHAs

Example

func (m *myModule) example(ctx context.Context, baseRef string, config string, forceCheckout bool, update bool, format string, indent int, resolveRefs bool, resolveEnv bool, lock bool) string  {
	return dag.
			Kas(baseRef).
			Dump(ctx, config, forceCheckout, update, format, indent, resolveRefs, resolveEnv, lock)
}

@function
async def example(base_ref: str, config: str, force_checkout: bool, update: bool, format: str, indent: int, resolve_refs: bool, resolve_env: bool, lock: bool) -> str:
	return await (
		dag.kas(base_ref)
		.dump(config, force_checkout, update, format, indent, resolve_refs, resolve_env, lock)
	)

@func()
async example(baseRef: string, config: string, forceCheckout: boolean, update: boolean, format: string, indent: number, resolveRefs: boolean, resolveEnv: boolean, lock: boolean): Promise<string> {
	return dag
		.kas(baseRef)
		.dump(config, forceCheckout, update, format, indent, resolveRefs, resolveEnv, lock)
}

withBuild() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
config	String !	".config.yaml"	Config file(s), separated by colon
target	String	null	Target to built
task	String	"build"	Task to run
extraBitbakeArgs	[String ! ]	null	Extra arguments to pass to bitbake

Example

func (m *myModule) example(baseRef string, config string) *Kas  {
	return dag.
			Kas(baseRef).
			WithBuild(config)
}

@function
def example(base_ref: str, config: str) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_build(config)
	)

@func()
example(baseRef: string, config: string): Kas {
	return dag
		.kas(baseRef)
		.withBuild(config)
}

build() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
config	String !	".config.yaml"	Config file(s), separated by colon
target	String	null	Target to built
task	String	"build"	Task to run
extraBitbakeArgs	[String ! ]	null	Extra arguments to pass to bitbake

Example

func (m *myModule) example(baseRef string, config string) *Directory  {
	return dag.
			Kas(baseRef).
			Build(config)
}

@function
def example(base_ref: str, config: str) -> dagger.Directory:
	return (
		dag.kas(base_ref)
		.build(config)
	)

@func()
example(baseRef: string, config: string): Directory {
	return dag
		.kas(baseRef)
		.build(config)
}

withShell() 🔗

Return Type

Kas !

Arguments

Name	Type	Default Value	Description
command	String !	-	Run command
config	String !	".config.yaml"	Config file(s), separated by colon
forceCheckout	Boolean !	false	Always checkout the desired commit/branch/tag of each repository, discarding any local changes
update	Boolean !	false	Pull new upstream changes to the desired branch even if it is already checked out locally
preserveEnv	Boolean !	false	Keep current user environment block
keepConfigUnchanged	Boolean !	false	Skip steps that change the configuration

Example

func (m *myModule) example(baseRef string, command string, config string, forceCheckout bool, update bool, preserveEnv bool, keepConfigUnchanged bool) *Kas  {
	return dag.
			Kas(baseRef).
			WithShell(command, config, forceCheckout, update, preserveEnv, keepConfigUnchanged)
}

@function
def example(base_ref: str, command: str, config: str, force_checkout: bool, update: bool, preserve_env: bool, keep_config_unchanged: bool) -> dag.Kas:
	return (
		dag.kas(base_ref)
		.with_shell(command, config, force_checkout, update, preserve_env, keep_config_unchanged)
	)

@func()
example(baseRef: string, command: string, config: string, forceCheckout: boolean, update: boolean, preserveEnv: boolean, keepConfigUnchanged: boolean): Kas {
	return dag
		.kas(baseRef)
		.withShell(command, config, forceCheckout, update, preserveEnv, keepConfigUnchanged)
}

shell() 🔗

Return Type

Container !

Arguments

Name	Type	Default Value	Description
command	String !	-	Run command
config	String !	".config.yaml"	Config file(s), separated by colon
forceCheckout	Boolean !	false	Always checkout the desired commit/branch/tag of each repository, discarding any local changes
update	Boolean !	false	Pull new upstream changes to the desired branch even if it is already checked out locally
preserveEnv	Boolean !	false	Keep current user environment block
keepConfigUnchanged	Boolean !	false	Skip steps that change the configuration

Example

func (m *myModule) example(baseRef string, command string, config string, forceCheckout bool, update bool, preserveEnv bool, keepConfigUnchanged bool) *Container  {
	return dag.
			Kas(baseRef).
			Shell(command, config, forceCheckout, update, preserveEnv, keepConfigUnchanged)
}

@function
def example(base_ref: str, command: str, config: str, force_checkout: bool, update: bool, preserve_env: bool, keep_config_unchanged: bool) -> dagger.Container:
	return (
		dag.kas(base_ref)
		.shell(command, config, force_checkout, update, preserve_env, keep_config_unchanged)
	)

@func()
example(baseRef: string, command: string, config: string, forceCheckout: boolean, update: boolean, preserveEnv: boolean, keepConfigUnchanged: boolean): Container {
	return dag
		.kas(baseRef)
		.shell(command, config, forceCheckout, update, preserveEnv, keepConfigUnchanged)
}

wipeCache() 🔗

Return Type

String !

Example

func (m *myModule) example(ctx context.Context, baseRef string) string  {
	return dag.
			Kas(baseRef).
			WipeCache(ctx)
}

@function
async def example(base_ref: str, ) -> str:
	return await (
		dag.kas(base_ref)
		.wipe_cache()
	)

@func()
async example(baseRef: string, ): Promise<string> {
	return dag
		.kas(baseRef)
		.wipeCache()
}