Skip to content

hyp generate_en.md

maoxiaoyue edited this page May 14, 2026 · 1 revision

hyp generate — Code Generation

Generate boilerplate code that follows HypGo conventions.

Usage

hyp generate [type] [name]
hyp generate [type] [name] -m <module-name>

Supported Types

Type Description Output Location For
controller Controller + Schema Router + Middleware app/controllers/ + app/routers/ Web
model Bun ORM Model + Req/Resp structs app/models/ All
service Business logic + Error Catalog app/services/ All
command Cobra subcommand app/commands/ CLI
view Fyne GUI view app/views/ Desktop
proto Protobuf service + gRPC server app/proto/ + app/rpc/ gRPC

Flags

Flag Description Default
-m, --module Go module name Auto-detected from go.mod

Examples

Web

hyp generate controller user    # Controller + Router (with Schema Input/Output)
hyp generate model order        # Model + CreateOrderReq + OrderResp + OrderListResp
hyp generate service payment    # Service + Error Catalog

CLI

v0.8.5+ command (CLI) and view (Desktop) generation types are new in v0.8.5.

hyp generate command process    # Cobra subcommand

Desktop

hyp generate view settings      # Fyne GUI view

gRPC

hyp generate proto order        # .proto + gRPC server implementation

Recommended Order

# Web
hyp generate model user          # 1. Define data structures
hyp generate controller user     # 2. Generate handler + router
hyp generate service user        # 3. Generate business logic

# CLI
hyp generate command process     # Generate subcommand directly

# Desktop
hyp generate view settings       # Generate view directly

# gRPC
hyp generate proto order         # Generate .proto + server

Safety

  • Name validation: only [a-zA-Z][a-zA-Z0-9_]* allowed
  • Never overwrites existing files
  • Module name auto-detected from go.mod

Related Commands

Detailed Documentation

HypGo

繁體中文 | English


中文文件

設計文件

套件

AI 協作工具鏈

CLI 命令


English Docs

Design Docs

Packages

AI Collaboration Toolchain

CLI Commands

Clone this wiki locally