shiryu
Installation
Entrypoint
Types
Shiryu

shiryu

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/fvonbergen/shiryu@e84488863fccf26c20f955f9425923890c0b002a

Entrypoint

Return Type

Shiryu !

Example

dagger -m github.com/fvonbergen/shiryu@e84488863fccf26c20f955f9425923890c0b002a call \

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

@function
def example() -> dag.Shiryu:
	return (
		dag.shiryu()
	)

@func()
example(): Shiryu {
	return dag
		.shiryu()
}

Types

Shiryu 🔗

Shiryu class.

build() 🔗

Initialize project.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
project	Directory !	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container
sdk	Enum !	"python"	Software Development Kit

Example

dagger -m github.com/fvonbergen/shiryu@e84488863fccf26c20f955f9425923890c0b002a call \
 build --project DIR_PATH --platform string

func (m *myModule) example(project *Directory, platform string, sdk ) *Directory  {
	return dag.
			Shiryu().
			Build(project, platform, sdk)
}

@function
def example(project: dagger.Directory, platform: str, sdk: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.build(project, platform, sdk)
	)

@func()
example(project: Directory, platform: string, sdk: ): Directory {
	return dag
		.shiryu()
		.build(project, platform, sdk)
}

check() 🔗

Run type checks in the project of the provided source Directory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory !	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container
sdk	Enum !	"python"	Software Development Kit

Example

dagger -m github.com/fvonbergen/shiryu@e84488863fccf26c20f955f9425923890c0b002a call \
 check --project DIR_PATH --platform string

func (m *myModule) example(ctx context.Context, project *Directory, platform string, sdk ) string  {
	return dag.
			Shiryu().
			Check(ctx, project, platform, sdk)
}

@function
async def example(project: dagger.Directory, platform: str, sdk: ) -> str:
	return await (
		dag.shiryu()
		.check(project, platform, sdk)
	)

@func()
async example(project: Directory, platform: string, sdk: ): Promise<string> {
	return dag
		.shiryu()
		.check(project, platform, sdk)
}

init() 🔗

Initialize project.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
projectName	String !	-	Project name
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container
sdk	Enum !	"python"	Software Development Kit

Example

dagger -m github.com/fvonbergen/shiryu@e84488863fccf26c20f955f9425923890c0b002a call \
 init --project-name string --platform string

func (m *myModule) example(projectName string, platform string, sdk ) *Directory  {
	return dag.
			Shiryu().
			Init(projectName, platform, sdk)
}

@function
def example(project_name: str, platform: str, sdk: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.init(project_name, platform, sdk)
	)

@func()
example(projectName: string, platform: string, sdk: ): Directory {
	return dag
		.shiryu()
		.init(projectName, platform, sdk)
}

lint() 🔗

Run linter checks in the project of the provided source Directory.

Return Type

String !

Arguments

Name	Type	Default Value	Description
project	Directory !	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container
sdk	Enum !	"python"	Software Development Kit

Example

dagger -m github.com/fvonbergen/shiryu@e84488863fccf26c20f955f9425923890c0b002a call \
 lint --project DIR_PATH --platform string

func (m *myModule) example(ctx context.Context, project *Directory, platform string, sdk ) string  {
	return dag.
			Shiryu().
			Lint(ctx, project, platform, sdk)
}

@function
async def example(project: dagger.Directory, platform: str, sdk: ) -> str:
	return await (
		dag.shiryu()
		.lint(project, platform, sdk)
	)

@func()
async example(project: Directory, platform: string, sdk: ): Promise<string> {
	return dag
		.shiryu()
		.lint(project, platform, sdk)
}

lintFix() 🔗

Run linter fixes in the project of the provided source Directory.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
project	Directory !	-	Project location
platform	String !	"linux/amd64"	Platform config OS and architecture in a Container
sdk	Enum !	"python"	Software Development Kit

Example

dagger -m github.com/fvonbergen/shiryu@e84488863fccf26c20f955f9425923890c0b002a call \
 lint-fix --project DIR_PATH --platform string

func (m *myModule) example(project *Directory, platform string, sdk ) *Directory  {
	return dag.
			Shiryu().
			LintFix(project, platform, sdk)
}

@function
def example(project: dagger.Directory, platform: str, sdk: ) -> dagger.Directory:
	return (
		dag.shiryu()
		.lint_fix(project, platform, sdk)
	)

@func()
example(project: Directory, platform: string, sdk: ): Directory {
	return dag
		.shiryu()
		.lintFix(project, platform, sdk)
}