https://github.com/pseusys/protogo

Automated "protoc" installer and runner for all your Go + Protobuf + gRPC projects!
https://github.com/pseusys/protogo

binaries go grpc installer prebuilt precompiled protobuf

Last synced: about 2 months ago
JSON representation

Automated "protoc" installer and runner for all your Go + Protobuf + gRPC projects!

• Host: GitHub
• URL: https://github.com/pseusys/protogo
• Owner: pseusys
• License: mit
• Created: 2024-12-17T19:14:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-28T03:52:12.000Z (over 1 year ago)
• Last Synced: 2025-02-12T14:53:40.390Z (over 1 year ago)
• Topics: binaries, go, grpc, installer, prebuilt, precompiled, protobuf
• Language: Go
• Homepage: https://pkg.go.dev/github.com/pseusys/protogo
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# protogo

> This package is not in any way related to the protobuf and flexbuffers developers and/or maintainers!

[![BUILD](https://github.com/pseusys/protogo/actions/workflows/build.yaml/badge.svg)](https://github.com/pseusys/protogo/actions/workflows/build.yaml)

[![Go Reference](https://pkg.go.dev/badge/github.com/pseusys/protogo.svg)](https://pkg.go.dev/github.com/pseusys/protogo)

`protogo` is an automatization tool for [`Go`](https://go.dev/) + [`protobuf`](https://github.com/protocolbuffers/protobuf)/[`flatbuffers`](https://github.com/google/flatbuffers) + [gRPC](https://grpc.io/) builds!

You can run it with the same arguments as `go` executable, followed by `--` flag and then compiler name (`protoc` or `flatc`) and its arguments.

Just like this:

```shell

protogo version -- protoc --version

```

Or like this:

```shell

protogo version -- flatc --version

```

Both parts are optional and can be skipped, thus can be used as `protoc` or `flatc` installer.

Compiler executable (denoted as `[COMPILER_NAME]`, either `protoc` or `flatc`) will be placed into `${PROTOGO_CACHE}/[COMPILER_NAME]-${PROTOGO_PROTOC_VERSION}/bin`, this directory can be added to `$PATH`.

Protogo will handle everything else, including `protoc`/`flatc` binaries installation, installing required packages, etc.

Use [official gRPC installation guide](https://grpc.io/docs/languages/go/quickstart/#prerequisites) as reference.

> Originally, a part of [`SeasideVPN`](https://github.com/pseusys/SeasideVPN) project.

Inspired by similar projects for other languages, including (but not limited to) [`protoc-exe`](https://pypi.org/project/protoc-exe/) and [`protoc-prebuilt`](https://crates.io/crates/protoc-prebuilt/).

You can additionally control it with the following environment variables:

  - `PROTOGO_GO_EXECUTABLE`: define `go` executable to use, default: `go`

  - `PROTOGO_PROTOC_VERSION`: define `protoc` version to use, should match protobuf release tags (with or without `v` prefix), default: `latest`  

      NB! If `local` is specified as `protoc` version, local installation will be used

  - `PROTOGO_FLATC_VERSION`: define `flatc` version to use, should match protobuf release tags (with or without `v` prefix), default: `latest`  

      NB! If `local` is specified as `flatc` version, local installation will be used

  - `PROTOGO_PROTOC_INCLUDE`: comma-separated list of "special" includes, can include `standard` (for standard types) and `googleapis` (for common [Google APIs types](https://github.com/googleapis/api-common-protos))

  - `PROTOGO_FLATC_DISTRO`: select distribution of `flatc` for linux (can be either `g++` or `clang`, default `g++`)

  - `PROTOGO_CACHE`: define cache directory, where `protoc` executables will be stored, default: `~/.cache/protogo`

  - `PROTOGO_GITHUB_BEARER_TOKEN`: GitHub authentication token for API requests (release assets retrieval)

  - `PROTOGO_LOG_LEVEL`: define logging level, the levels match [`logrus`](https://github.com/sirupsen/logrus) ones