The Buffrs Book

Buffrs manages versioned Protocol Buffer and gRPC API packages. It helps teams publish shared API definitions, consume them with full SemVer support, and keep migrations manageable with lockfiles and multi-version installs when needed.

Quick Start

# Install Buffrs from GitHub Releases or build it from source first

# Check for an update later
buffrs self-update --check-only

# Initialize a new API package
buffrs init --api

# Add a dependency
buffrs add --registry https://your.registry.com datatypes/user@^1.2.0

# Publish your package
buffrs publish

Get started →

Why Buffrs?

• 📦 Full SemVer support for gRPC APIs: declare compatible version ranges instead of pinning everything by hand
• 🔀 Multi-version support for staged migrations: install two API versions side by side when different consumers need different releases
• 🏷️ Package aliases for side-by-side versions: name each dependency entry clearly when one manifest references multiple versions of the same API
• 🛠️ Build tool integration: works with Cargo, CMake, Python, and other generated-code workflows

Documentation

• Getting Started: Install Buffrs and create your first package.
• Buffrs Guide: Learn core concepts and best practices.
• Commands Reference: Browse the full CLI reference.
• FAQ: Find common questions and troubleshooting guidance.

Need help? Check the FAQ or visit our GitHub repository.