Dagger
Search

charm

A generated module for Charm functions

Installation

dagger install github.com/ernesto27/daggerverse/charm@e6d73b6f68ea48712ea9b0ca1fb9d0da03c9ce7d

Entrypoint

Return Type
Charm
Example
func (m *myModule) example() *Charm  {
	return dag.
			Charm()
}
@function
def example() -> dag.Charm:
	return (
		dag.charm()
	)
@func()
example(): Charm {
	return dag
		.charm()
}

Types

Charm 🔗

vhs() 🔗

Executes a charm VHS command that generates a gif from a demo.tape file

Return Type
File !
Arguments
NameTypeDefault ValueDescription
fileTapeFile !-tape file to generate gif
Example
dagger -m github.com/ernesto27/daggerverse/charm@e6d73b6f68ea48712ea9b0ca1fb9d0da03c9ce7d call \
 vhs --file-tape file:path
func (m *myModule) example(fileTape *File) *File  {
	return dag.
			Charm().
			Vhs(fileTape)
}
@function
def example(file_tape: dagger.File) -> dagger.File:
	return (
		dag.charm()
		.vhs(file_tape)
	)
@func()
example(fileTape: File): File {
	return dag
		.charm()
		.vhs(fileTape)
}

vhsPublish() 🔗

Publish a gif file to the VHS service

Return Type
String !
Arguments
NameTypeDefault ValueDescription
fileFile !-No description provided
Example
dagger -m github.com/ernesto27/daggerverse/charm@e6d73b6f68ea48712ea9b0ca1fb9d0da03c9ce7d call \
 vhs-publish --file file:path
func (m *myModule) example(ctx context.Context, file *File) string  {
	return dag.
			Charm().
			VhsPublish(ctx, file)
}
@function
async def example(file: dagger.File) -> str:
	return await (
		dag.charm()
		.vhs_publish(file)
	)
@func()
async example(file: File): Promise<string> {
	return dag
		.charm()
		.vhsPublish(file)
}

freeze() 🔗

Executes a charm freeze command that generate images from a source code file

Return Type
File !
Arguments
NameTypeDefault ValueDescription
fileFile !-Source code file to generate images
paramsString -No description provided
Example
dagger -m github.com/ernesto27/daggerverse/charm@e6d73b6f68ea48712ea9b0ca1fb9d0da03c9ce7d call \
 freeze --file file:path
func (m *myModule) example(file *File) *File  {
	return dag.
			Charm().
			Freeze(file)
}
@function
def example(file: dagger.File) -> dagger.File:
	return (
		dag.charm()
		.freeze(file)
	)
@func()
example(file: File): File {
	return dag
		.charm()
		.freeze(file)
}