buf
Installation
Entrypoint
Types
Buf

buf

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/JFenstermacher/daggerverse/buf@5f181d12250a34feab8deeb720606fc794d6f503

Entrypoint

Return Type

Buf !

Arguments

Name	Type	Description
source	Directory	Project source directory
packages	[String ! ]	Packages to install
config	String	Path to buf.yaml

Example

dagger -m github.com/JFenstermacher/daggerverse/buf@5f181d12250a34feab8deeb720606fc794d6f503 call \

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

@function
def example() -> dag.Buf:
	return (
		dag.buf()
	)

@func()
example(): Buf {
	return dag
		.buf()
}

Types

Buf 🔗

Buf project

packages() 🔗

Go packages to install Each will be run with ‘go install ’ The following packages will be installed by default: * github.com/bufbuild/buf/cmd/buf@latest * google.golang.org/protobuf/cmd/protoc-gen-go@latest * connectrpc.com/connect/cmd/protoc-gen-connect-go@latest

Return Type

[String ! ] !

Example

dagger -m github.com/JFenstermacher/daggerverse/buf@5f181d12250a34feab8deeb720606fc794d6f503 call \
 packages

func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			Buf().
			Packages(ctx)
}

@function
async def example() -> List[str]:
	return await (
		dag.buf()
		.packages()
	)

@func()
async example(): Promise<string[]> {
	return dag
		.buf()
		.packages()
}

source() 🔗

Project source directory

Return Type

Directory !

Example

dagger -m github.com/JFenstermacher/daggerverse/buf@5f181d12250a34feab8deeb720606fc794d6f503 call \
 source

func (m *myModule) example() *Directory  {
	return dag.
			Buf().
			Source()
}

@function
def example() -> dagger.Directory:
	return (
		dag.buf()
		.source()
	)

@func()
example(): Directory {
	return dag
		.buf()
		.source()
}

config() 🔗

Path to config file

Return Type

String !

Example

dagger -m github.com/JFenstermacher/daggerverse/buf@5f181d12250a34feab8deeb720606fc794d6f503 call \
 config

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Buf().
			Config(ctx)
}

@function
async def example() -> str:
	return await (
		dag.buf()
		.config()
	)

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

container() 🔗

Return Type

Container !

Example

dagger -m github.com/JFenstermacher/daggerverse/buf@5f181d12250a34feab8deeb720606fc794d6f503 call \
 container

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

@function
def example() -> dagger.Container:
	return (
		dag.buf()
		.container()
	)

@func()
example(): Container {
	return dag
		.buf()
		.container()
}

lint() 🔗

Return Type

Container !

Example

dagger -m github.com/JFenstermacher/daggerverse/buf@5f181d12250a34feab8deeb720606fc794d6f503 call \
 lint

func (m *myModule) example() *Container  {
	return dag.
			Buf().
			Lint()
}

@function
def example() -> dagger.Container:
	return (
		dag.buf()
		.lint()
	)

@func()
example(): Container {
	return dag
		.buf()
		.lint()
}