goctl CLI Reference

Overview

goctl is go-zero’s code generation tool. It scaffolds HTTP services, gRPC services, models, Dockerfiles, Kubernetes manifests, and more.

Contents

• Overview — Introduction to goctl
• Quickstart — Get started fast
• API Generation — HTTP service from .api file
• RPC Generation — gRPC service from .proto file
• Model Generation — Database model code
• Docker — Generate Dockerfiles
• Kubernetes — Generate K8s manifests
• Environment — Check build environment
• Configuration — Manage goctl config
• Template — Customize templates
• Style — Configure naming style
• Swagger — Generate API docs
• Upgrade — Upgrade goctl
• Migrate — Migrate templates
• Shell Completion — Auto-completion setup
• Bug Report — Report a bug