mukan-ignite/docs/versioned_docs/version-v29/07-packages/cosmosbuf.md

sidebar_position	title	slug
14	Buf Integration (cosmosbuf)	/packages/cosmosbuf

Buf Integration (cosmosbuf)

The cosmosbuf package wraps Buf workflows (generate, export, format, migrate, dep update) used by Ignite's protobuf pipelines.

For full API details, see the cosmosbuf Go package documentation.

When to use

• Trigger Buf code generation from Go services.
• Keep Buf invocation flags and error handling consistent.
• Reuse cache-aware generation behavior.

Key APIs

• New(cacheStorage cache.Storage, goModPath string) (Buf, error)
• (Buf) Generate(ctx, protoPath, output, template, options...)
• (Buf) Format(ctx, path)
• (Buf) Export(ctx, protoDir, output)
• Version(ctx context.Context) (string, error)

Example

package main

import (
	"context"
	"log"
	"os"
	"path/filepath"

	"github.com/ignite/cli/v29/ignite/pkg/cache"
	"github.com/ignite/cli/v29/ignite/pkg/cosmosbuf"
)

func main() {
	storage, err := cache.NewStorage(filepath.Join(os.TempDir(), "ignite-cache.db"))
	if err != nil {
		log.Fatal(err)
	}

	buf, err := cosmosbuf.New(storage, "github.com/acme/my-chain")
	if err != nil {
		log.Fatal(err)
	}

	if err := buf.Format(context.Background(), "./proto"); err != nil {
		log.Fatal(err)
	}
}