-
Notifications
You must be signed in to change notification settings - Fork 0
hyp new_en.md
maoxiaoyue edited this page May 14, 2026
·
1 revision
Create a new HypGo project. Supports four project types.
hyp new <name> # Full-stack web project (default) hyp new web <name> # Same (explicit) hyp new cli <name> # CLI tool project (Cobra) hyp new desktop <name> # Desktop application (Fyne GUI) hyp new grpc <name> # gRPC microservice
hyp new myapp
Generated structure:
myapp/
├── app/
│ ├── controllers/home.go
│ ├── models/
│ └── services/
├── config/config.yaml
├── static/css/ js/ images/
├── templates/welcome.html
├── main.go
└── go.mod
v0.8.5+CLI, Desktop, and gRPC project types are new in v0.8.5. v0.8.1 supports Web projects only.
hyp new cli mytool
Generated structure:
mytool/
├── app/
│ ├── commands/root.go
│ ├── models/
│ ├── services/
│ └── config/config.yaml
├── main.go
└── go.mod
Next: hyp generate command process
v0.8.5+Desktop (Fyne GUI) project is new in v0.8.5.
hyp new desktop myapp
Generated structure:
myapp/
├── app/
│ ├── views/main_view.go
│ ├── models/
│ ├── services/
│ └── config/config.yaml
├── main.go
└── go.mod
Next: hyp generate view settings
Note: Fyne requires a C compiler (gcc).
v0.8.5+gRPC project type is new in v0.8.5.
hyp new grpc userservice
Generated structure:
userservice/
├── app/
│ ├── proto/userservicepb/userservice.proto
│ ├── rpc/userservice_server.go
│ ├── models/
│ ├── services/
│ └── config/config.yaml
├── main.go
├── Makefile
└── go.mod
Next: hyp generate proto order
Requires: protoc + protoc-gen-go + protoc-gen-go-grpc
cd myapp && go mod tidy hyp ai-rules # Essential: generate AI tool config files
- hyp api — API-only project
- hyp generate — Generate code
- hyp ai-rules — Generate AI config files
設計文件
套件
- config — 設定
- context — 請求上下文
- router — 路由器
- server — 伺服器
- middleware — 中介層
- websocket — WebSocket
- hidb — 資料庫 ORM
- hidb/cassandra — Cassandra
- logger — 日誌
- json — JSON 處理
- grpc — gRPC
AI 協作工具鏈
- schema — Schema-first 路由
- manifest — 專案 Manifest
- contract — Contract Testing
- errors — Typed Error Catalog
- migrate — Migration Diff
- scaffold — 智慧 Scaffold
- airules — AI Rules
CLI 命令
- hyp 總覽
- hyp new
- hyp api
- hyp run
- hyp restart
- hyp generate
- hyp migrate
- hyp context
- hyp ai-rules
- hyp chkcomment
- hyp impact
- hyp docker
- hyp health
- hyp version
- hyp difflog
Design Docs
Packages
- config — Configuration
- context — Request Context
- router — Router
- server — Server
- middleware — Middleware
- websocket — WebSocket
- hidb — Database ORM
- hidb/cassandra - Cassandra 5.0
- logger — Logger
- json — JSON
- grpc — gRPC
AI Collaboration Toolchain
- schema — Schema-first Routing
- manifest — Project Manifest
- contract — Contract Testing
- errors — Typed Error Catalog
- migrate — Migration Diff
- scaffold — Smart Scaffold
- airules — AI Rules
CLI Commands