Getting Started

Installation And Running

To install Protip:

Connect your GitHub repository containing Protocol Buffers to our GitHub App,
Add a .protip.toml file to the root of your repository.

Running Protip:

After adding a .protip.toml file to the root of your repository, commits pushed to your repository on any branch will be automatically checked by Protip.
Generating new code is as easy as pressing the Generate button on your commit!

Check out our example repository for a fully functioning Go backend and React Typescript gRPC-Web demo!

Configuration Format

A .protip.toml file must be present in the root of your repository for Protip to understand where your Protocol Buffer files live.

A .protip.toml file at its core contains multiple proto sections that each describe a set of directories to compile with a set of options.

Refer to languages section for language-specifc configuration.

Here is a sample .protip.toml for reference:

# First set of input and configuration.
[[proto]]
  # All .proto files found recursively will be compiled.
  #
  # Paths are relative to the root of the repository.
  #
  # Type: string array
  # Required.
  input_paths = [
    "proto/foo/",
    "proto/bar/",
  ]

  [proto.go]
    output_path = "golang/src/"

# Second set of input and configuration.
[[proto]]
  input_paths = [
    "proto/baz/",
  ]

  [proto.go]
    output_path = "golang/src/"
    grpc = true

  [proto.js]
    output_path = "js/src/"

  [proto.grpcweb]
    output_path = "js/src/"
    typescript = true