Protocol Buffers protobuf compiler - multi-platform executable protoc JAR and API
Branch: master
Clone or download
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.
bin release protoc sunos-x86_64 binaries Aug 25, 2018
src cosmetics Dec 9, 2018
LICENSE Initial commit May 28, 2014
README.md version 3.6.0.1 Dec 15, 2018
RELEASE_NOTES.md version 3.6.0.1 Dec 15, 2018
assembly.xml switch to 3.6.0 Jun 29, 2018
pom.xml version 3.6.0.1 Dec 15, 2018

README.md

protoc-jar

Protocol Buffers protobuf compiler - multi-platform executable protoc JAR and API. Available on Maven Central: http://central.maven.org/maven2/com/github/os72/protoc-jar/3.6.0.1/

Maven Central


Simple convenience JAR that embeds protoc compiler binaries for Linux, Mac/OSX, and Windows, providing some portability across the major platforms. At runtime the library detects the platform and executes the corresponding protoc binary. Supports embedded protoc versions 2.4.1, 2.5.0, 2.6.1, 3.6.0, and any protoc version available for download from maven central

  • New: Support for FreeBSD on x86 platform (freebsd-x86_64), thanks kjopek
  • New: Support for Solaris on x86 platform (sunos-x86_64), thanks siepkes
  • New: Support for Linux on POWER8 platform (linux-ppcle_64), thanks to Apache SystemML folks (nakul02)
  • New: Support for Linux on ARM platform (linux-aarch_64; 2.4.1, 2.6.1, 3.4.0), thanks garciagorka

See also

Binaries

Version support

  • protobuf 2.4.1: -v2.4.1, -v241
  • protobuf 2.5.0: -v2.5.0, -v250
  • protobuf 2.6.1: -v2.6.1, -v261
  • protobuf 3.6.0: -v3.6.0, -v360
  • Other versions: will attempt download from maven central
  • Download by maven artifact id: -v:<group>:<artifact>:<version> (eg, -v:com.google.protobuf:protoc:3.0.0)

Usage - executable

$ java -jar protoc-jar-3.6.0.1.jar -v2.4.1 --version
protoc-jar: protoc version: 2.4.1, detected platform: windows-x86_64 (windows 8.1/amd64)
protoc-jar: embedded: bin/2.4.1/protoc-2.4.1-windows-x86_64.exe
protoc-jar: executing: [C:\cygwin64\tmp\protocjar4043021753132417014\bin\protoc.exe, --version]
libprotoc 2.4.1

$ java -jar protoc-jar-3.6.0.1.jar -v2.5.0 --version
protoc-jar: protoc version: 2.5.0, detected platform: windows-x86_64 (windows 8.1/amd64)
protoc-jar: embedded: bin/2.5.0/protoc-2.5.0-windows-x86_64.exe
protoc-jar: executing: [C:\cygwin64\tmp\protocjar1249962506895049512\bin\protoc.exe, --version]
libprotoc 2.5.0

$ java -jar protoc-jar-3.6.0.1.jar -v2.6.1 --version
protoc-jar: protoc version: 2.6.1, detected platform: windows-x86_64 (windows 8.1/amd64)
protoc-jar: embedded: bin/2.6.1/protoc-2.6.1-windows-x86_64.exe
protoc-jar: executing: [C:\cygwin64\tmp\protocjar6776927966028536935\bin\protoc.exe, --version]
libprotoc 2.6.1

$ java -jar protoc-jar-3.6.0.1.jar -v3.6.0 --version
protoc-jar: protoc version: 3.6.0, detected platform: windows-x86_64 (windows 8.1/amd64)
protoc-jar: embedded: bin/3.6.0/protoc-3.6.0-windows-x86_64.exe
protoc-jar: executing: [C:\cygwin64\tmp\protocjar6721276946617095290\bin\protoc.exe, --version]
libprotoc 3.6.0

$ java -jar protoc-jar-3.6.0.1.jar -v3.1.0 --version
protoc-jar: protoc version: 3.1.0, detected platform: windows-x86_64 (windows 8.1/amd64)
protoc-jar: downloading: http://central.maven.org/maven2/com/google/protobuf/protoc/maven-metadata.xml
protoc-jar: saved: C:\cygwin64\tmp\protocjar.webcache\com\google\protobuf\protoc\maven-metadata.xml
protoc-jar: downloading: http://central.maven.org/maven2/com/github/os72/protoc/maven-metadata.xml
protoc-jar: saved: C:\cygwin64\tmp\protocjar.webcache\com\github\os72\protoc\maven-metadata.xml
protoc-jar: cached: C:\cygwin64\tmp\protocjar.webcache\com\google\protobuf\protoc\maven-metadata.xml
protoc-jar: downloading: http://central.maven.org/maven2/com/google/protobuf/protoc/3.1.0-build2/protoc-3.1.0-build2-windows-x86_64.exe
protoc-jar: saved: C:\cygwin64\tmp\protocjar.webcache\com\google\protobuf\protoc\3.1.0-build2\protoc-3.1.0-build2-windows-x86_64.exe
protoc-jar: executing: [C:\cygwin64\tmp\protocjar1755669222845599671\bin\protoc.exe, --version]
libprotoc 3.1.0

Usage - executable, include google.protobuf standard types (option --include_std_types)

$ java -jar protoc-jar-3.6.0.1.jar --include_std_types -I. --java_out=out StdTypeExample.proto
protoc-jar: protoc version: 3.6.0, detected platform: windows-x86_64 (windows 8.1/amd64)
protoc-jar: embedded: bin/3.6.0/protoc-3.6.0-windows-x86_64.exe
protoc-jar: executing: [C:\cygwin64\tmp\protocjar4162580735258750520\bin\protoc.exe, -IC:\cygwin64\tmp\protocjar4162580735258750520\include, -I., --java_out=out, StdTypeExample.proto]

Usage - executable, apply shading for use with protobuf-java-shaded-241 (option --java_shaded_out)

$ java -jar protoc-jar-3.6.0.1.jar -v2.4.1 --java_shaded_out=out PersonSchema.proto
protoc-jar: protoc version: 2.4.1, detected platform: windows-x86_64 (windows 8.1/amd64)
protoc-jar: embedded: bin/2.4.1/protoc-2.4.1-windows-x86_64.exe
protoc-jar: executing: [C:\cygwin64\tmp\protocjar139806143399660474\bin\protoc.exe, --java_out=out, PersonSchema.proto]
protoc-jar: shading (version 2.4.1): out

Usage - run platform detector (option -pp, print platform, usually for debugging)

$ java -jar protoc-jar-3.6.0.1.jar -pp
------------------------------------------------------------------------
Detecting the operating system and CPU architecture
------------------------------------------------------------------------
os.detected.name: windows
os.detected.arch: x86_64
os.detected.version: 6.3
os.detected.version.major: 6
os.detected.version.minor: 3
os.detected.classifier: windows-x86_64
Detected platform: windows-x86_64 (windows 8.1/amd64)

Usage - API

import com.github.os72.protocjar.Protoc;
...
String[] args = {"-v2.4.1", "--help"};
Protoc.runProtoc(args);

Maven dependency

<dependency>
  <groupId>com.github.os72</groupId>
  <artifactId>protoc-jar</artifactId>
  <version>3.6.0.1</version>
</dependency>