doc(kitexcall): add include path for idl & add -e option

cloudwego · Oct 24, 2024 · 0537c81 · 0537c81
1 parent d3919b5
commit 0537c81
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/content/en/docs/kitex/Tutorials/tool/kitexcall.md b/content/en/docs/kitex/Tutorials/tool/kitexcall.md
@@ -112,6 +112,7 @@ Output:
 - `-help` or `-h`: Outputs the usage instructions.
 - `-type` or `-t`: Specifies the IDL type: thrift or protobuf. It supports inference based on the IDL file type. The default is thrift..
 - `-idl-path` or `-p`: Specifies the path to the IDL file.
+- `-include-path`: Add a search path for the IDL. Multiple paths can be added and will be searched in the order they are added.
 - `-method` or `-m`: Required, specifies the method name in the format IDLServiceName/MethodName or just MethodName. When the server side has MultiService mode enabled, IDLServiceName must be specified, and the transport protocol must be TTHeader or TTHeaderFramed.
 - `-file` or `-f`: Specifies the input file path, which must be in JSON format.
 - `-data` or `-d`: Specifies the data to be sent, in JSON string format.
@@ -121,6 +122,7 @@ Output:
 - `-meta`: Specifies one-way metadata passed to the server. Multiple can be specified, in the format key=value.
 - `-meta-persistent`: Specifies persistent metadata passed to the server. Multiple can be specified, in the format key=value.
 - `-meta-backward`: Enables receiving backward metadata (Backward) returned by the server.
+- `-q`: Only output JSON response, no other information.
 - `-verbose` or `-v`: Enables verbose mode for more detailed output information.
 
 ### Detailed Description

diff --git a/content/zh/docs/kitex/Tutorials/tool/kitexcall.md b/content/zh/docs/kitex/Tutorials/tool/kitexcall.md
@@ -114,6 +114,7 @@ kitexcall -idl-path echo.thrift -m echo -d '{"message": "hello"}' -e 127.0.0.1:9
 - `-help` 或 `-h`：输出使用说明。
 - `-type` 或 `-t`：指定 IDL 类型：`thrift` 或 `protobuf`，支持通过 IDL 文件类型推测，默认是 `thrift`。
 - `-idl-path` 或 `-p`：指定 IDL 文件的路径。
+- `-include-path`：添加一个 IDL 里 include 的其他文件的搜索路径。支持添加多个，会按照添加的路径顺序搜索。
 - `-method` 或 `-m`：必选，指定方法名，格式为 `IDLServiceName/MethodName` 或仅为 `MethodName`。当 server 端开启了 MultiService 模式时，必须指定 `IDLServiceName`，同时指定传输协议为 TTHeader 或 TTHeaderFramed 。
 - `-file` 或 `-f`：指定输入文件路径，必须是 JSON 格式。
 - `-data` 或 `-d`：指定要发送的数据，格式为 JSON 字符串。
@@ -123,6 +124,7 @@ kitexcall -idl-path echo.thrift -m echo -d '{"message": "hello"}' -e 127.0.0.1:9
 - `-meta`：指定传递给 server 的单跳透传元信息。可以指定多个，格式为 key=value。
 - `-meta-persistent`：指定传递给 server 的持续透传元信息。可以指定多个，格式为 key=value。
 - `-meta-backward`：启用从服务器接收反向透传元信息。
+- `-q`: 只输出Json响应，不输出其他提示信息。
 - `-verbose` 或 `-v`：启用详细模式。
 
 ### 详细描述