{"id":37173587,"url":"https://github.com/arithran/buf","last_synced_at":"2026-01-14T20:17:24.758Z","repository":{"id":187694615,"uuid":"677490495","full_name":"arithran/buf","owner":"arithran","description":"A new way of working with Protocol Buffers.","archived":false,"fork":true,"pushed_at":"2023-08-11T19:14:59.000Z","size":12517,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-16T00:21:01.501Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://buf.build","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"bufbuild/buf","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arithran.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-11T17:50:48.000Z","updated_at":"2023-08-11T18:52:42.000Z","dependencies_parsed_at":"2023-08-11T20:05:34.832Z","dependency_job_id":null,"html_url":"https://github.com/arithran/buf","commit_stats":null,"previous_names":["arithran/buf"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/arithran/buf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arithran%2Fbuf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arithran%2Fbuf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arithran%2Fbuf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arithran%2Fbuf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arithran","download_url":"https://codeload.github.com/arithran/buf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arithran%2Fbuf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28434422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T18:57:19.464Z","status":"ssl_error","status_checked_at":"2026-01-14T18:52:48.501Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-14T20:17:24.071Z","updated_at":"2026-01-14T20:17:24.751Z","avatar_url":"https://github.com/arithran.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![The Buf logo](./.github/buf-logo.svg)\n\n# Buf\n\n[![License](https://img.shields.io/github/license/bufbuild/buf?color=blue)][badges_license]\n[![Release](https://img.shields.io/github/v/release/bufbuild/buf?include_prereleases)][badges_release]\n[![CI](https://github.com/bufbuild/buf/workflows/ci/badge.svg)][badges_ci]\n[![Docker](https://img.shields.io/docker/pulls/bufbuild/buf)][badges_docker]\n[![Homebrew](https://img.shields.io/homebrew/v/buf)][badges_homebrew]\n[![Slack](https://img.shields.io/badge/slack-buf-%23e01563)][badges_slack]\n\nThe [`buf`][buf] CLI is a tool for working with [Protocol Buffers][protobuf].\n\n\u003ca id=\"features\"\u003e\u003c/a\u003e\n\n- The ability to manage Protobuf assets on the [Buf Schema Registry][bsr] (BSR).\n- A [linter][lint_usage] that enforces good API design choices and structure.\n- A [breaking change detector][breaking_usage] that enforces compatibility at the source code or wire level.\n- A [generator][generate_usage] that invokes your plugins based on configurable [templates][templates].\n- A [formatter][format_usage] that formats your Protobuf files in accordance with industry standards.\n- Integration with the [Buf Schema Registry][bsr], including full dependency management.\n\n## Installation\n\n### Homebrew\n\nYou can install `buf` using [Homebrew][brew] (macOS or Linux):\n\n```sh\nbrew install bufbuild/buf/buf\n```\n\nThis installs:\n\n- The `buf`, [`protoc-gen-buf-breaking`][breaking], and [`protoc-gen-buf-lint`][lint] binaries\n- Shell completion scripts for [Bash], [Fish], [Powershell], and [zsh]\n\n### Other methods\n\nFor other installation methods, see our [official documentation][install], which covers:\n\n- Installing `buf` via [npm]\n- Installing `buf` on [Windows]\n- Using `buf` as a [Docker image][docker]\n- Installing as a [binary], from a [tarball], and from [source] through [GitHub Releases][releases]\n- [Verifying] releases using a [minisign] public key\n\n\n## Usage\n\nBuf's help interface provides summaries for commands and flags:\n\n```sh\nbuf --help\n```\n\nFor more comprehensive usage information, consult Buf's [documentation][docs], especially these guides:\n\n* [`buf breaking`][breaking_usage]\n* [`buf build`][build_usage]\n* [`buf generate`][generate_usage]\n* [`buf lint`][lint_usage]\n* [`buf format`][format_usage]\n* [`buf registry`][bsr_usage] (for using the [BSR])\n\n## CLI breaking change policy\n\nWe will never make breaking changes within a given major version of the CLI. Once `buf` reaches v1.0, you can expect no breaking changes until v2.0. But as we have no plans to ever release a v2.0, we will likely never break the `buf` CLI.\n\n\u003e This breaking change policy does _not_ apply to commands behind the `buf beta` gate, and you should expect breaking changes to commands like `buf beta registry`. The policy does go into effect, however, when those commands or flags are elevated out of beta.\n\n## Our goals for Protobuf\n\n[Buf]'s goal is to replace the current paradigm of API development, centered around REST/JSON, with a **schema-driven** paradigm. Defining APIs using an [IDL] provides numerous benefits over REST/JSON, and [Protobuf] is by far the most stable and widely adopted IDL in the industry. We've chosen to build on this widely trusted foundation rather than creating a new IDL from scratch.\n\nBut despite its technical merits, actually _using_ Protobuf has long been more challenging than it needs to be. The Buf CLI and the [BSR](#the-buf-schema-registry) are the cornerstones of our effort to change that for good and to make Protobuf reliable and easy to use for service owners and clients alike—in other words, to create a **modern Protobuf ecosystem**.\n\nWhile we intend to incrementally improve on the `buf` CLI and the [BSR](#the-buf-schema-registry), we're confident that the basic groundwork for such an ecosystem is _already_ in place.\n\n## The Buf Schema Registry\n\nThe [Buf Schema Registry][bsr] (BSR) is a SaaS platform for managing your Protobuf APIs. It provides a centralized registry and a single source of truth for all of your Protobuf assets, including not just your `.proto` files but also [remote plugins][bsr_plugins]. Although the BSR provides an intuitive browser UI, `buf` enables you to perform most BSR-related tasks from the command line, such as [pushing] Protobuf sources to the registry and managing [users] and [repositories]. \n\n\u003e The BSR is not required to use `buf`. We've made the core [features] of the `buf` CLI available to _all_ Protobuf users.\n\n## More advanced CLI features\n\nWhile `buf`'s [core features][features] should cover most use cases, we've included some more advanced features to cover edge cases:\n\n* **Automatic file discovery**. Buf walks your file tree and builds your `.proto` files in accordance with your supplied [build configuration][build_config], which means that you no longer need to manually specify `--proto_paths`. You can still, however, specify `.proto` files manually through CLI flags in cases where file discovery needs to be disabled.\n* **Fine-grained rule configuration** for [linting][lint_rules] and [breaking changes][breaking_rules]. While we do have recommended defaults, you can always select the exact set of rules that your use case requires, with [40 lint rules][lint_rules] and [53 breaking change rules][breaking_rules] available.\n* **Configurable error formats** for CLI output. `buf` outputs information in `file:line:column:message` form by default for each lint error and breaking change it encounters, but you can also select JSON and, in the near future, JUnit output.\n* **Editor integration** driven by `buf`'s granular error output. We currently provide linting integrations for both [Vim and Visual Studio Code][ide] but we plan to support other editors, such as Emacs and [JetBrains IDEs][jetbrains] like IntelliJ and GoLand, in the future.\n* **Universal Input targeting**. Buf enables you to perform actions like linting and breaking change detection not just against local `.proto` files but also against a broad range of other [Inputs], such as tarballs and ZIP files, remote Git repositories, and pre-built [image][images] files.\n* **Speed**. Buf's internal Protobuf compiler compiles your Protobuf sources using all available cores without compromising deterministic output, which is considerably faster than `protoc`. This allows for near-instantaneous feedback, which is of special importance for features like [editor integration][ide].\n\n## Next steps\n\nOnce you've installed `buf`, we recommend completing the [Tour of Buf][tour], which provides a broad but hands-on overview of the core functionality of both the CLI and the [BSR]. The tour takes about 10 minutes to complete.\n\nAfter completing the tour, check out the remainder of the [docs] for your specific areas of interest.\n\n## Community\n\nFor help and discussion around Protobuf, best practices, and more, join us on [Slack][badges_slack].\n\nFor updates on the Buf CLI, [follow this repo on GitHub][repo].\n\nFor feature requests, bugs, or technical questions, email us at [dev@buf.build][email_dev]. For general inquiries or inclusion in our upcoming feature betas, email us at [info@buf.build][email_info].\n\n[badges_aur]: https://aur.archlinux.org/packages/buf\n[badges_ci]: https://github.com/bufbuild/buf/actions?workflow=ci\n[badges_docker]: https://hub.docker.com/r/bufbuild/buf\n[badges_homebrew]: https://github.com/bufbuild/homebrew-buf\n[badges_license]: https://github.com/bufbuild/buf/blob/main/LICENSE\n[badges_release]: https://github.com/bufbuild/buf/releases\n[badges_slack]: https://buf.build/links/slack\n[bash]: https://www.gnu.org/software/bash\n[binary]: https://docs.buf.build/installation#binary\n[breaking]: https://docs.buf.build/breaking\n[breaking_rules]: https://docs.buf.build/breaking/rules\n[breaking_usage]: https://docs.buf.build/breaking/usage\n[brew]: https://brew.sh\n[bsr]: https://docs.buf.build/bsr\n[bsr_plugins]: https://buf.build/plugins\n[bsr_usage]: https://docs.buf.build/bsr/usage\n[buf]: https://buf.build\n[build_config]: https://docs.buf.build/build/usage/#configuration\n[build_usage]: https://docs.buf.build/build/usage\n[compiler]: https://docs.buf.build/build/internal-compiler\n[contact]: https://docs.buf.build/contact\n[docker]: https://docs.buf.build/installation#use-the-docker-image\n[docs]: https://docs.buf.build\n[email_dev]: mailto:dev@buf.build\n[email_info]: mailto:info@buf.build\n[filedescriptorset]: https://github.com/protocolbuffers/protobuf/blob/044c766fd4777713fef2d1a9a095e4308d770c68/src/google/protobuf/descriptor.proto#L57\n[features]: #features\n[fish]: https://fishshell.com\n[format_usage]: https://docs.buf.build/format/usage\n[generate_usage]: https://docs.buf.build/generate/usage\n[ide]: https://docs.buf.build/editor-integration\n[idl]: https://en.wikipedia.org/wiki/Interface_description_language\n[images]: https://docs.buf.build/reference/images\n[inputs]: https://docs.buf.build/reference/inputs\n[install]: https://docs.buf.build/installation\n[jetbrains]: https://docs.buf.build/editor-integration#jetbrains-ides\n[lint]: https://docs.buf.build/lint\n[lint_rules]: https://docs.buf.build/lint/rules\n[lint_usage]: https://docs.buf.build/lint/usage\n[npm]: https://docs.buf.build/installation#npm\n[minisign]: https://github.com/jedisct1/minisign\n[powershell]: https://docs.microsoft.com/en-us/powershell\n[protobuf]: https://developers.google.com/protocol-buffers\n[pushing]: https://docs.buf.build/bsr/usage#push-a-module\n[releases]: https://docs.buf.build/installation#github-releases\n[repo]: https://github.com/bufbuild/buf/\n[repositories]: https://docs.buf.build/bsr/overview#module\n[roadmap]: https://docs.buf.build/roadmap\n[source]: https://docs.buf.build/installation#from-source\n[tarball]: https://docs.buf.build/installation#tarball\n[templates]: https://docs.buf.build/configuration/v1/buf-gen-yaml\n[tour]: https://docs.buf.build/tour/introduction\n[users]: https://docs.buf.build/bsr/user-management#organization-roles\n[verifying]: https://docs.buf.build/installation#verifying-a-release\n[windows]: https://docs.buf.build/installation#windows-support\n[zsh]: https://zsh.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farithran%2Fbuf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farithran%2Fbuf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farithran%2Fbuf/lists"}