Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamazeem/proto-convert
a CLI tool to convert protobuf messages from binary to JSON and vice versa
https://github.com/iamazeem/proto-convert
binary cli-app command-line-tool converter hacktoberfest json protobuf protocol-buffers ruby-gem
Last synced: 20 days ago
JSON representation
a CLI tool to convert protobuf messages from binary to JSON and vice versa
- Host: GitHub
- URL: https://github.com/iamazeem/proto-convert
- Owner: iamazeem
- License: mit
- Created: 2020-07-07T07:57:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-05T17:02:59.000Z (11 months ago)
- Last Synced: 2024-08-09T20:45:56.642Z (5 months ago)
- Topics: binary, cli-app, command-line-tool, converter, hacktoberfest, json, protobuf, protocol-buffers, ruby-gem
- Language: Ruby
- Homepage: https://github.com/iamAzeem/proto-convert
- Size: 50.8 KB
- Stars: 31
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# proto-convert
[](https://github.com/iamazeem/proto-convert/actions/workflows/ci.yml)
[](https://github.com/iamAzeem/proto-convert/blob/master/LICENSE)
[](https://rubygems.org/gems/proto-convert)
[proto-convert](https://github.com/iamAzeem/proto-convert) is a CLI tool
to convert [protobuf](https://github.com/protocolbuffers/protobuf) messages
from binary to [JSON](https://www.json.org/json-en.html) and vice versa.
[Tested](./test/run_tests.sh) on Ubuntu, macOS and Windows runners.
For details, see [CI workflow](./.github/workflows/ci.yml).
## Installation
Make sure that the Protocol Buffers Compiler `protoc` is installed. Follow these
[instructions](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation)
to install it.
Install `proto-convert` with [RubyGems](https://rubygems.org/pages/download):
```shell
gem install proto-convert
```
Depending on your installed Ruby version, the latest `google-protobuf` may not
install due to compatibility issues. You need to install the older version
yourself or you may choose to upgrade to a later Ruby version.
It has also been observed that the installed `protoc` and `google-protobuf` gem
may be incompatible and may result into compilation failure of the `input`
file on runtime.
- For Ruby 2.6, `protoc` v3.17.3 and `google-protobuf` v3.12 work fine.
- For Ruby 2.7 and later, the latest versions of both should work fine.
## Usage
Run `proto-convert -h` for usage help.
```text
$ proto-convert -h
Usage: bin/proto-convert -m [mode] -p [proto] -t [msgtype] -i [input] -o [output]
OPTIONS:
-m, --mode [MODE] conversion mode ["binary2json", "b2j", "json2binary", "j2b"]
-p, --proto [FILENAME] protobuf schema (.proto)
-t, --msgtype [TYPE] fully-qualified message type
-i, --input [FILENAME] source file (JSON/binary)
-o, --output [FILENAME] destination file (binary/JSON)
-v, --verbose print verbose information
-h, --help print help
```
**NOTE**: Use `-v` / `--verbose` flag to print detailed intermediate steps.
## Test Run
Consider this simple .proto file ([`test.proto`](test/test.proto)):
```protobuf
syntax = "proto3";
package test;
message Message {
int32 id = 1;
string body = 2;
}
```
See [`test`](test) directory for test files.
### JSON to Binary Conversion
```text
$ proto-convert -m j2b -p test.proto -t test.Message -i test.json -o test.bin
>> [J] test.json (24 bytes)
<< [B] test.bin (8 bytes)
```
### Binary to JSON Conversion
```text
$ proto-convert -m b2j -p test.proto -t test.Message -i test.bin -o test.json
>> [B] test.bin (8 bytes)
<< [J] test.json (24 bytes)
```
Output:
```text
$ cat test.json
{"id":123,"body":"test"}
```
## Contribute
- [Fork](https://github.com/iamazeem/proto-convert/fork) the project.
- Check out the latest `main` branch.
- Create a `feature` or `bugfix` branch from `main`.
- Commit and push your changes.
- Make sure to add tests. See [CI](./.github/workflows/ci.yml).
- Run [Rubocop](https://github.com/rubocop/rubocop) and fix the lint errors.
- Submit the PR.
## License
[MIT](https://github.com/iamAzeem/proto-convert/blob/master/LICENSE)