dagger-cli
Installation
Entrypoint
Types
DaggerCli

dagger-cli

No long description provided.

Installation

dagger install github.com/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7

Entrypoint

Return Type

DaggerCli !

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/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7 call \

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

@function
def example() -> dagger.DaggerCli:
	return (
		dag.dagger_cli()
	)

@func()
example(): DaggerCli {
	return dag
		.daggerCli()
}

Types

DaggerCli 🔗

version() 🔗

Return Type

String !

Example

dagger -m github.com/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7 call \
 version

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			DaggerCli().
			Version(ctx)
}

@function
async def example() -> str:
	return await (
		dag.dagger_cli()
		.version()
	)

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

tag() 🔗

Return Type

String !

Example

dagger -m github.com/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7 call \
 tag

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			DaggerCli().
			Tag(ctx)
}

@function
async def example() -> str:
	return await (
		dag.dagger_cli()
		.tag()
	)

@func()
async example(): Promise<string> {
	return dag
		.daggerCli()
		.tag()
}

publish() 🔗

Publish the CLI using GoReleaser

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
goreleaserKey	Secret !	-	No description provided
githubOrgName	String !	-	No description provided
githubToken	Secret	-	No description provided
git	GitRepository	-	No description provided
awsAccessKeyId	Secret	-	No description provided
awsSecretAccessKey	Secret	-	No description provided
awsRegion	String	-	No description provided
awsBucket	String	-	No description provided
artefactsFqdn	String	-	No description provided
dryRun	Boolean	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(tag string, goreleaserKey *dagger.Secret, githubOrgName string) *dagger.Directory  {
	return dag.
			DaggerCli().
			Publish(tag, goreleaserKey, githubOrgName)
}

@function
def example(tag: str, goreleaser_key: dagger.Secret, github_org_name: str) -> dagger.Directory:
	return (
		dag.dagger_cli()
		.publish(tag, goreleaser_key, github_org_name)
	)

@func()
example(tag: string, goreleaserKey: Secret, githubOrgName: string): Directory {
	return dag
		.daggerCli()
		.publish(tag, goreleaserKey, githubOrgName)
}

publishMetadata() 🔗

Return Type

Void !

Arguments

Name	Type	Default Value	Description
awsAccessKeyId	Secret !	-	No description provided
awsSecretAccessKey	Secret !	-	No description provided
awsRegion	String !	-	No description provided
awsBucket	String !	-	No description provided
awsCloudfrontDistribution	String !	-	No description provided

Example

dagger -m github.com/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7 call \
 publish-metadata --aws-access-key-id env:MYSECRET --aws-secret-access-key env:MYSECRET --aws-region string --aws-bucket string --aws-cloudfront-distribution string

func (m *MyModule) Example(ctx context.Context, awsAccessKeyId *dagger.Secret, awsSecretAccessKey *dagger.Secret, awsRegion string, awsBucket string, awsCloudfrontDistribution string)   {
	return dag.
			DaggerCli().
			PublishMetadata(ctx, awsAccessKeyId, awsSecretAccessKey, awsRegion, awsBucket, awsCloudfrontDistribution)
}

@function
async def example(aws_access_key_id: dagger.Secret, aws_secret_access_key: dagger.Secret, aws_region: str, aws_bucket: str, aws_cloudfront_distribution: str) -> None:
	return await (
		dag.dagger_cli()
		.publish_metadata(aws_access_key_id, aws_secret_access_key, aws_region, aws_bucket, aws_cloudfront_distribution)
	)

@func()
async example(awsAccessKeyId: Secret, awsSecretAccessKey: Secret, awsRegion: string, awsBucket: string, awsCloudfrontDistribution: string): Promise<void> {
	return dag
		.daggerCli()
		.publishMetadata(awsAccessKeyId, awsSecretAccessKey, awsRegion, awsBucket, awsCloudfrontDistribution)
}

checkReleaseDryRun() 🔗

Verify that the CLI builds without actually publishing anything

Return Type

Void !

Example

dagger -m github.com/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7 call \
 check-release-dry-run

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			DaggerCli().
			CheckReleaseDryRun(ctx)
}

@function
async def example() -> None:
	return await (
		dag.dagger_cli()
		.check_release_dry_run()
	)

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

binary() 🔗

Build the dagger CLI binary for a single platform

Return Type

File !

Arguments

Name	Type	Default Value	Description
platform	Scalar	-	No description provided

Example

dagger -m github.com/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7 call \
 binary

func (m *MyModule) Example() *dagger.File  {
	return dag.
			DaggerCli().
			Binary()
}

@function
def example() -> dagger.File:
	return (
		dag.dagger_cli()
		.binary()
	)

@func()
example(): File {
	return dag
		.daggerCli()
		.binary()
}

reference() 🔗

Generate a markdown CLI reference doc

Return Type

File !

Arguments

Name	Type	Default Value	Description
frontmatter	String	-	No description provided
includeExperimental	Boolean	-	Include experimental commands

Example

dagger -m github.com/dagger/dagger/cmd/dagger@84f3bf311551ee31eec567975072d8ee209141f7 call \
 reference

func (m *MyModule) Example() *dagger.File  {
	return dag.
			DaggerCli().
			Reference()
}

@function
def example() -> dagger.File:
	return (
		dag.dagger_cli()
		.reference()
	)

@func()
example(): File {
	return dag
		.daggerCli()
		.reference()
}