Skip to content
Protocol Buffers - Google's data interchange format
Branch: master
Clone or download
Pull request Compare This branch is 27 commits behind protocolbuffers:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
benchmarks
cmake
conformance
csharp
docs
editors
examples
java
js
kokoro
m4
objectivec
php
protoc-artifacts
python
ruby
src
third_party
util/python
.gitignore
.gitmodules
BUILD
CHANGES.txt
CONTRIBUTING.md
CONTRIBUTORS.txt
LICENSE
Makefile.am
Protobuf.podspec
README.md
WORKSPACE
appveyor.bat
appveyor.yml
autogen.sh
compiler_config_setting.bzl
composer.json
configure.ac
generate_changelog.py
generate_descriptor_proto.sh
global.json
post_process_dist.sh
protobuf-lite.pc.in
protobuf.bzl
protobuf.pc.in
protobuf_deps.bzl
six.BUILD
tests.sh
update_file_lists.sh
update_version.py

README.md

Protocol Buffers - Google's data interchange format

Copyright 2008 Google Inc.

https://developers.google.com/protocol-buffers/

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can find protobuf's documentation on the Google Developers site.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Protocol Compiler Installation

The protocol compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our release page:

https://github.com/protocolbuffers/protobuf/releases

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the maven repo here:

https://repo1.maven.org/maven2/com/google/protobuf/protoc/

These pre-built binaries are only provided for released versions. If you want to use the github master version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

Language Source Ubuntu MacOS Windows
C++ (include C++ runtime and protoc) src Build status
Build status
Build status
Build status
Build status
Build status
Java java Build status
Build status
Build status
Python python Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Objective-C objectivec Build status
Build status
Build status
Build status
C# csharp Build status Build status
Build status
JavaScript js Build status Build status
Ruby ruby Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Go golang/protobuf
PHP php Build status
Build status
Build status
Build status
Dart dart-lang/protobuf Build Status

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide:

https://developers.google.com/protocol-buffers/docs/tutorials

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation for Protocol Buffers is available via the web at:

https://developers.google.com/protocol-buffers/

You can’t perform that action at this time.