-
Notifications
You must be signed in to change notification settings - Fork 0
hyp ai rules.md
maoxiaoyue edited this page Apr 14, 2026
·
1 revision
v0.8.5+此命令為 HypGo v0.8.5 新增功能,v0.8.1 版本不包含。
一鍵生成所有主流 AI 編碼工具的配置檔,讓任何 AI 工具開啟專案就知道 HypGo 慣例。
hyp ai-rules # 生成所有配置檔 hyp ai-rules --only agents,gemini # 只生成特定工具 hyp ai-rules --dry-run # 預覽不寫入 hyp ai-rules --dir ./myproject # 指定專案根目錄
| Flag | 說明 | 預設值 |
|---|---|---|
--only |
逗號分隔的目標清單 | 全部(5 個) |
--dir |
專案根目錄 |
.(當前目錄) |
--dry-run |
預覽不寫入 | false |
| 檔案 | AI 工具 |
|---|---|
AGENTS.md |
Codex CLI, Cursor, Continue.dev, Aider, OpenHands |
GEMINI.md |
Google Gemini CLI / AI Studio |
.github/copilot-instructions.md |
GitHub Copilot |
.cursor/rules/hypgo.mdc |
Cursor(含 frontmatter) |
.windsurf/rules/hypgo.md |
Windsurf(限 6,000 字元) |
每個檔案都包含:
- 框架名稱、版本、Go 版本
- 專案結構說明(
pkg/、cmd/hyp/、.hyp/) - 關鍵慣例:Schema-first 路由、Typed Error、Contract Testing
- Build/Test 指令
- AI 協作提示(先讀
.hyp/context.yaml、用hyp impact) - 路由表(如果
.hyp/context.yaml存在)
每個自動生成的檔案開頭有標記 <!-- auto-generated by hyp ai-rules -->。
| 狀態 | 行為 |
|---|---|
| 檔案不存在 | 建立 |
| 有標記 | 覆蓋 |
| 無標記(手動建立) | 跳過 |
hyp context -o .hyp/context.yaml # 1. 先生成 manifest hyp ai-rules # 2. 再生成配置檔(含路由表)
沒有這些檔案,AI 工具每次開啟專案都從零開始理解,浪費數千 tokens。有了配置檔,AI 立刻知道你的慣例和路由結構。
- hyp context — 生成 manifest(ai-rules 會讀取)
設計文件
套件
- 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