kitex

Generate service code

$ kitex -module [module] [idl_file.thrift]

$ kitex -module [module] -client [idl_file.thrift]

$ kitex -module [module] -service [svc] [idl.thrift]

$ kitex -module [module] [idl.proto]

$ kitex -module [module] -template [dir] [idl.thrift]

kitex [options] idlfile_

kitex is a code generation tool for the Kitex high-performance RPC framework, part of ByteDance's open-source CloudWeGo ecosystem. It reads Thrift or Protocol Buffers interface definition language (IDL) files and generates Go scaffolding code for both servers and clients, including service interfaces, request/response types, serialization logic, and a runnable project skeleton.
The generated code is designed for building Go microservices with features like connection pooling, load balancing, and circuit breaking built into the Kitex framework. By default, kitex produces both server and client code, but the `-client` flag restricts output to client stubs only. Custom code templates can be provided via the `-template` option to control the structure and style of the generated project.

IDLFILE_

Thrift or Protobuf IDL file.

Go module name.

Service name.

Generate client code only.

Custom template directory.

Display help information.

Part of CloudWeGo. Go-specific. Thrift or Protobuf IDL required.

kitex is the code generator for Kitex, a high-performance RPC framework created by ByteDance.

thrift(1), protoc(1), go(1)