C++ Java Objective-C C# C Python Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Add github issue templates Jun 19, 2018
benchmarks Merge pull request #4951 from BSBandme/add_js_benchmark Aug 10, 2018
cmake Update build files. Aug 13, 2018
conformance Merge pull request #5032 from TeBoring/json-wrapper Aug 13, 2018
csharp Support creating FileDescriptors dynamically from binary data. Aug 20, 2018
docs Update third party RPC implementations list (#4977) Jul 30, 2018
editors Improve fix for #295 May 23, 2017
examples fix golang kokoro linux build Jul 16, 2018
java Fix failing tests. Aug 10, 2018
js Merge master branch. Aug 9, 2018
kokoro Update build files. Aug 13, 2018
m4 Merge pull request #1333 from cgull/pkg-config-issue Mar 12, 2018
objectivec Update generated descriptors. Aug 9, 2018
php Merge pull request #5032 from TeBoring/json-wrapper Aug 13, 2018
protoc-artifacts Added support for building the aarch64 and ppcle64 protoc binaries wi… Aug 1, 2018
python Disable surrogate check for ucs2 (#5039) Aug 14, 2018
ruby Merge branch '3.6.x' into merge-3-6-x Aug 1, 2018
src Merge pull request #5024 from greenhouse-org/fix-windows-path Aug 20, 2018
third_party Include googletest as a submodule (#3993) Mar 26, 2018
util/python Remove hack for building Python support with Bazel. Feb 25, 2016
.gitignore Ignore python .egg file to make git status clean #5004 Aug 5, 2018
.gitmodules Include googletest as a submodule (#3993) Mar 26, 2018
BUILD Update build files. Aug 13, 2018
CHANGES.txt Updated change log for 3.6.1 release Jul 27, 2018
CONTRIBUTORS.txt Add nano proto authors and update LICENSE file to include Android.mk. Nov 20, 2014
LICENSE Cleanup LICENSE file. Mar 26, 2018
Makefile.am Fix failing tests. Aug 10, 2018
Protobuf.podspec Updated version numbers to 3.6.1 Jul 27, 2018
README.md Add status badge for bazel build. Aug 13, 2018
WORKSPACE Merge pull request #4168 from jin/master Jun 23, 2018
appveyor.bat Appveyor MinGW build May 3, 2018
appveyor.yml Merge branch '3.6.x' into merge-3-6-x Jun 25, 2018
autogen.sh Add cpp tests under release docker image. Jul 16, 2018
composer.json Update PHP descriptors (#3391) Aug 4, 2017
configure.ac Merge branch '3.6.x' into merge-3-6-x Aug 1, 2018
generate_changelog.py Updated generate_changelog.py May 24, 2018
generate_descriptor_proto.sh Merge from Google internal for 3.4 release Jul 18, 2017
post_process_dist.sh Removed javanano from post_process_dist.sh Jun 5, 2018
protobuf-lite.pc.in Uncomment conflict fields from pkg-config files. May 12, 2015
protobuf.bzl Change deprecated Bazel single file attr param Aug 15, 2018
protobuf.pc.in Uncomment conflict fields from pkg-config files. May 12, 2015
six.BUILD Add srcs_version = "PY2AND3" in BUILD files Dec 3, 2015
tests.sh Fix failing tests. Aug 10, 2018
update_file_lists.sh fix duplicate mkdir in update_file_lists.sh Apr 25, 2018

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/google/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
Java java Build status
Build status
Build status
Python python 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
JavaScript js Build status Build status
Ruby ruby Build status Build status
Build status
Go golang/protobuf
PHP php Build status
Build status
Build status
Build status
Dart dart-lang/protobuf

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/