astelm
/
grpcurl
mirror of https://github.com/fullstorydev/grpcurl.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

be consistent about capitalization of gRPC

This commit is contained in:
Joshua Humphries 2017-11-20 13:18:09 -05:00 committed by GitHub
parent 9dfaded6cf
commit a8483857e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,16 +1,16 @@
# GRPCurl # gRPCurl
`grpcurl` is a command-line tool that lets you interact with GRPC servers. It's `grpcurl` is a command-line tool that lets you interact with gRPC servers. It's
basically `curl` for GRPC servers. basically `curl` for gRPC servers.
The main purpose for this tool is to invoke RPC methods on a GRPC server from the The main purpose for this tool is to invoke RPC methods on a gRPC server from the
command-line. GRPC servers use a binary encoding on the wire command-line. gRPC servers use a binary encoding on the wire
([protocol buffers](https://developers.google.com/protocol-buffers/), or "protobufs" ([protocol buffers](https://developers.google.com/protocol-buffers/), or "protobufs"
for short). So they are basically impossible to interact with using regular `curl` for short). So they are basically impossible to interact with using regular `curl`
(and older versions of `curl` that do not support HTTP/2 are of course non-starters). (and older versions of `curl` that do not support HTTP/2 are of course non-starters).
This program accepts messages using JSON encoding, which is much more friendly for both This program accepts messages using JSON encoding, which is much more friendly for both
humans and scripts. humans and scripts.
With this tool you can also browse the schema for GRPC services, either by querying With this tool you can also browse the schema for gRPC services, either by querying
a server that supports [service reflection](https://github.com/grpc/grpc/blob/master/src/proto/grpc/reflection/v1alpha/reflection.proto) a server that supports [service reflection](https://github.com/grpc/grpc/blob/master/src/proto/grpc/reflection/v1alpha/reflection.proto)
or by loading in "protoset" files (files that contain encoded file or by loading in "protoset" files (files that contain encoded file
[descriptor protos](https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto)). [descriptor protos](https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto)).
@ -84,4 +84,4 @@ protoc --proto_path=. \
The `--descriptor_set_out` argument is what tells `protoc` to produce a protoset, The `--descriptor_set_out` argument is what tells `protoc` to produce a protoset,
and the `--include_imports` arguments is necessary for the protoset to contain and the `--include_imports` arguments is necessary for the protoset to contain
everything that `grpcurl` needs to process and understand the schema. everything that `grpcurl` needs to process and understand the schema.