Expand the documentation of -max-time to clarify this sets the RPC timeout

fullstorydev / grpcurl

Like cURL, but for gRPC: Command-line tool for interacting with gRPC servers

MIT License

10.35k stars 497 forks source link

Expand the documentation of -max-time to clarify this sets the RPC timeout #435

Closed dimo414 closed 5 months ago

dimo414 commented 6 months ago

I was looking for how to specify a RPC timeout or deadline via grpcurl and tried grepping the --help output, but only matched -connect-timeout. I found -max-time by browsing the codebase looking for .WithTimeout() calls. So the motivation of this PR is both to generally clarify the behavior of this flag and also add the words "timeout" and "deadline" specifically to this help text to aid discovery.