Skip to main content

Installation

Prerequisites​

  • Go 1.22+
  • PostgreSQL 14+
  • protoc (Protocol Buffers compiler) — if using proto-first approach

Install Ratel CLI​

go install github.com/yaroher/ratel/cmd/ratel@latest

Install Protoc Plugin​

If you define your schema using Protocol Buffers:

go install github.com/yaroher/ratel/cmd/protoc-gen-ratel@latest

You also need the plain Go message generator (generates Go structs without protobuf runtime dependency):

go install github.com/yaroher/protoc-gen-go-plain/cmd/protoc-gen-plain@latest

And the standard Go protobuf generator:

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest

Add Ratel as a Dependency​

go get github.com/yaroher/ratel

Verify Installation​

ratel --help
protoc-gen-ratel --version

What's Next​

Choose your workflow: