namely/grpc-cli

grpc_cli Docker镜像文档

镜像概述和主要用途

本镜像捆绑了来自https://github.com/grpc/grpc/blob/master/doc/command_line_tool.md的标准`grpc_cli`工具。`grpc_cli`是一个命令行工具，用于与gRPC服务进行交互，可发送请求、查看服务定义并调试gRPC接口。本镜像无需在本地安装`grpc_cli`，通过Docker容器即可快速使用该工具。

核心功能和特性

• 包含官方标准grpc_cli工具，支持所有grpc_cli命令（如call、ls、describe等）
• 支持挂载本地目录到容器内/defs路径，便于读取本地.proto文件
• 轻量级设计，简化gRPC服务调试流程
• 跨平台兼容，支持通过特定主机名访问宿主机服务

使用场景和适用范围

• 开发环境中快速测试gRPC服务接口功能
• 调试gRPC服务端与客户端之间的通信问题
• 验证.proto文件定义与服务实现的一致性
• 在没有本地安装grpc_cli的环境中临时使用该工具

详细使用方法和配置说明

基本使用方法

1. 挂载本地目录：将当前工作目录挂载到容器内/defs路径，以便grpc_cli读取本地.proto文件：

bash
docker run -v `pwd`:/defs --rm -it docker.xuanyuan.run/namely/grpc-cli [命令]

2. 访问宿主机服务：由于命令在容器内运行，需使用以下主机名访问宿主机的gRPC服务：
   • macOS：docker.for.mac.localhost
   • Windows：docker.for.win.localhost

示例：调用gRPC服务

以下示例演示如何调用LinkShortener服务的ResolveShortLink方法：

bash
docker run -v `pwd`:/defs --rm -it docker.xuanyuan.run/namely/grpc-cli call docker.for.mac.localhost:50051 \
  LinkShortener.ResolveShortLink "short_link:'asdf'" --protofiles=link_shortener.proto

创建命令别名（推荐）

为简化重复使用，可定义别名：

bash
alias grpc_cli='docker run -v `pwd`:/defs --rm -it namely/grpc-cli'

注意：使用单引号避免pwd参数在定义别名时被提前展开

定义别名后，可直接使用：

bash
grpc_cli call docker.for.mac.localhost:50051 LinkShortener.ResolveShortLink "short_link:'asdf'" --protofiles=link_shortener.proto