Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

hyp cli_en.md

maoxiaoyue edited this page May 14, 2026 · 1 revision

HypGo CLI (cmd/hyp)

HypGo CLI (hyp) is the command-line tool for the HypGo framework, used for quickly creating, managing, and running HypGo applications.

Installation

go install github.com/maoxiaoyue/hypgo/cmd/hyp@latest

Ensure $GOPATH/bin is in your system's PATH.

Available Commands

hyp new [type] [project-name]

Create a new HypGo project. Supports multiple project types:

  • hyp new <name> — Full-stack web project (default, with frontend templates)
  • hyp new web <name> — Same (explicit web type)
  • hyp new cli <name> — CLI tool project (Cobra command-line)
  • hyp new desktop <name> — Desktop application (Fyne native GUI)
  • hyp new grpc <name> — gRPC microservice (Protobuf)

hyp api [project-name]

Create an API-only project without static files or templates.

hyp run

Start the HypGo application with hot reload in development mode.

hyp restart

Hot restart for zero-downtime deployment. Uses SIGUSR2 on Unix. Not supported on Windows.

hyp docker

Build a Docker image based on config.yaml settings.

hyp generate [type] [name]

Generate boilerplate code following HypGo conventions.

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

hyp context

Generate project manifest (YAML/JSON) for AI collaboration.

hyp migrate

Database migration tools. Subcommands: diff, snapshot.

hyp chkcomment [file.go]

Annotation Protocol checker. Scans exported blocks for standard comments.

hyp impact [file.go]

Change Impact Analysis. Shows affected packages, routes, and tests.

hyp ai-rules

Generate AI tool config files (AGENTS.md, GEMINI.md, Copilot, Cursor, Windsurf).

hyp diff-log

AI change tracking. Toggle on/off to save tokens. See hyp-difflog.md.

hyp health

Check running application health status.

hyp version

Print version and build information.

Verify Installation

hyp --version

HypGo

繁體中文 | English


中文文件

設計文件

套件

AI 協作工具鏈

CLI 命令


English Docs

Design Docs

Packages

AI Collaboration Toolchain

CLI Commands

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /