feat(config): update rabbit config path and improve command descriptions

- Change default rabbit config path from `~/.rabbit` to `./.rabbit/`
- Update Dockerfile to use absolute paths for volume mounts and CMD arguments
- Enhance CLI command help texts with detailed descriptions and usage scenarios
- Refactor config loading logic in send commands to use kratos config sources
- Improve path normalization in client config generation
- Remove obsolete config fields and consolidate configuration handling
- Add metadata fields to server config including repository, author and email
- Update dependencies and clean up unused imports and code sections

Author: aide-cloud

.gitignore

@@ -39,4 +39,5 @@ go.work.sum
 
 # deploy
 deploy/*/data
-description.txt
+description.txt
+.rabbit/

Dockerfile

@@ -49,11 +49,11 @@ USER appuser
 
 # 设置卷
 VOLUME /moon/config
-VOLUME ~/.rabbit
+VOLUME /moon/.rabbit
 
 # 暴露端口
 EXPOSE 8080
 EXPOSE 9090
 
 # 运行应用
-CMD ["rabbit", "run", "-c", "/moon/config", "-o", "~/.rabbit"]
+CMD ["rabbit", "run", "-c", "/moon/config/", "--rabbit-config", "/moon/.rabbit/"]

cmd/cmd.go

@@ -25,10 +25,32 @@ func NewCmd() *cobra.Command {
 	rootCmd := &cobra.Command{
 		Use:   "rabbit",
 		Short: "Moon messaging platform - Rabbit service",
-		Long: `Rabbit is a messaging service for the Moon platform.
-
-This service provides message handling capabilities for the Moon ecosystem,
-including message routing, delivery, and management features.`,
+		Long: `Rabbit（玉兔）是 Moon 平台的消息服务工具，提供统一的消息发送和管理能力。
+
+Rabbit 是一个基于 Kratos 框架构建的分布式消息服务平台，支持多种消息通道
+（邮件、Webhook、短信、飞书等）的统一管理和发送。通过命名空间（Namespace）
+实现多租户隔离，支持配置文件和数据库两种存储模式，满足不同场景的部署需求。
+
+核心能力：
+  • 多通道消息发送：支持邮件、Webhook、短信、飞书等多种消息通道的统一管理
+  • 模板化发送：支持消息模板配置，实现消息内容的动态渲染和复用
+  • 异步消息处理：基于消息队列实现异步发送，提升系统吞吐量和可靠性
+  • 配置管理：支持邮件服务器、Webhook 端点等通道配置的集中管理
+  • 多租户隔离：通过命名空间实现不同业务或租户的配置和数据隔离
+  • 命令行工具：提供丰富的 CLI 命令，支持服务管理、消息发送、配置生成等
+
+命令分类：
+  • Basic Commands（基础命令）：config、version 等基础操作
+  • Message Commands（消息命令）：send、apply、get、delete 等消息相关操作
+  • Service Commands（服务命令）：run 等服务管理操作
+
+使用场景：
+  • 企业级通知系统：统一管理各类业务通知（订单、告警、系统消息等）
+  • 微服务消息中心：为微服务架构提供统一的消息发送能力
+  • 多渠道推送平台：集成多种消息通道，实现消息的统一发送和管理
+  • 开发测试工具：通过命令行快速测试消息通道配置和发送功能
+
+使用 "rabbit [command] --help" 查看具体命令的详细说明。`,
 		Run: func(cmd *cobra.Command, args []string) {
 			cmd.Help()
 		},

cmd/config/config.go

@@ -19,11 +19,24 @@ func NewCmd(configContent []byte) *cobra.Command {
 	configCmd := &cobra.Command{
 		Use:   "config",
 		Short: "Generate default server.yaml configuration file",
-		Long: `Generate a default server.yaml configuration file in the specified path.
+		Long: `生成 Rabbit 服务的默认配置文件，用于快速初始化和部署。
 
-This command will create a server.yaml file with default configuration values.
-If the target file already exists and --force is not set, it will be renamed with a timestamp suffix.
-If --force is set, the existing file will be overwritten.`,
+config 命令会在指定路径生成 server.yaml 配置文件，包含服务运行所需
+的默认配置项，如服务器端口、数据库连接、日志级别等。
+
+主要功能：
+  • 默认配置生成：自动生成包含所有必需配置项的配置文件
+  • 安全备份：如果目标文件已存在，自动备份为带时间戳的文件
+  • 强制覆盖：支持 --force 参数强制覆盖已存在的配置文件
+  • 路径自定义：支持指定配置文件的生成路径和文件名
+
+使用场景：
+  • 快速初始化：新部署环境时快速生成配置文件
+  • 配置模板：作为配置模板参考，了解所有可配置项
+  • 配置迁移：在不同环境间迁移配置时作为起点
+
+生成的配置文件包含服务器、数据库、日志、消息通道等各个模块的配置
+项，可根据实际环境进行修改和调整。`,
 		Annotations: map[string]string{
 			"group": cmd.BasicCommands,
 		},

cmd/global.go

@@ -27,7 +27,7 @@ type GlobalFlags struct {
 
 func (g *GlobalFlags) addFlags(cmd *cobra.Command) {
 	cmd.PersistentFlags().StringVarP(&g.Namespace, "namespace", "n", "", "The namespace of the service")
-	cmd.PersistentFlags().StringVar(&g.RabbitConfigPath, "rabbit-config", "~/.rabbit", "The config file of the rabbit")
+	cmd.PersistentFlags().StringVar(&g.RabbitConfigPath, "rabbit-config", "./.rabbit/", "The config file of the rabbit")
 }
 
 type GlobalOption func(*GlobalFlags)

cmd/gorm/flags.go

@@ -43,7 +43,7 @@ func (f *Flags) addFlags(c *cobra.Command) {
 
 // containsNamespace 检查 namespace 是否在逗号分隔的 namespaces 字符串中
 func containsNamespace(namespaces, target string) bool {
-	for _, ns := range strings.Split(namespaces, ",") {
+	for _, ns := range strutil.SplitSkipEmpty(namespaces, ",") {
 		if strings.TrimSpace(ns) == target {
 			return true
 		}

cmd/run/client.go

@@ -82,6 +82,7 @@ func generateClientConfig(
 			endpoint = strings.Join([]string{"discovery://", serverName}, "/")
 			protocol = config.ClusterConfig_GRPC
 		} else {
+			protocol = config.ClusterConfig_GRPC
 			endpoint = normalizeAddress(grpcEndpoint)
 			if endpoint == "" {
 				endpoint = normalizeAddress(httpEndpoint)
@@ -110,13 +111,13 @@ func generateClientConfig(
 		}
 	}
 
-	// 写入配置文件到当前目录的 .rabbit/config.yaml
-	configDir := filepath.Dir(load.ExpandHomeDir(flags.clientConfigOutputPath))
+	// 写入配置文件到当前目录的 .rabbit/client_config.yaml
+	configDir := filepath.Dir(load.ExpandHomeDir(flags.RabbitConfigPath))
 	if err := os.MkdirAll(configDir, 0o755); err != nil {
 		return fmt.Errorf("create config directory failed: %w", err)
 	}
 
-	configFile := filepath.Join(configDir, "config.yaml")
+	configFile := filepath.Join(configDir, "client_config.yaml")
 
 	// 转换为 YAML 格式
 	yamlData, err := clientConfigToYAML(clientConfig)
@@ -133,10 +134,22 @@ func generateClientConfig(
 	return nil
 }
 
-// normalizeAddress 将地址中的 0.0.0.0 转换为 localhost
+// normalizeAddress 将地址中的 0.0.0.0 转换为 localhost，并移除协议前缀
 func normalizeAddress(addr string) string {
+	if addr == "" {
+		return addr
+	}
+	// 移除协议前缀
+	protocols := []string{"https://", "http://", "grpcs://", "grpc://"}
+	for _, protocol := range protocols {
+		if strings.HasPrefix(addr, protocol) {
+			addr = strings.TrimPrefix(addr, protocol)
+			break
+		}
+	}
+	// 将 0.0.0.0 转换为 localhost
 	if strings.HasPrefix(addr, "0.0.0.0:") {
-		return strings.Replace(addr, "0.0.0.0:", "localhost:", 1)
+		addr = strings.Replace(addr, "0.0.0.0:", "localhost:", 1)
 	}
 	return addr
 }

cmd/run/flags.go

@@ -16,8 +16,7 @@ import (
 
 type Flags struct {
 	cmd.GlobalFlags
-	configPath             string
-	clientConfigOutputPath string
+	configPath string
 
 	*conf.Bootstrap
 	environment     string
@@ -33,7 +32,6 @@ var flags Flags
 func (f *Flags) addFlags(c *cobra.Command, bc *conf.Bootstrap) {
 	f.Bootstrap = bc
 	c.Flags().StringVarP(&f.configPath, "config", "c", "", `Example: -c=./config/, --config="./config/"`)
-	c.Flags().StringVarP(&f.clientConfigOutputPath, "client-config-output", "o", "~/.rabbit/", `Example: -o=./client/, --client-config-output="~/.rabbit/"`)
 
 	c.Flags().StringVar(&f.environment, "environment", f.Environment.String(), `Example: --environment="DEV", --environment="TEST", --environment="PREVIEW", --environment="PROD"`)
 	c.Flags().StringVar(&f.Server.Http.Address, "http-address", f.Server.Http.Address, `Example: --http-address="0.0.0.0:8080", --http-address=":8080"`)

cmd/run/run.go

@@ -22,7 +22,25 @@ func NewCmd(defaultServerConfigBytes []byte) *cobra.Command {
 	runCmd := &cobra.Command{
 		Use:   "run",
 		Short: "Run the Rabbit service",
-		Long:  `A longer description that spans multiple lines and likely contains examples and usage of using your command.`,
+		Long: `启动 Rabbit 消息服务，提供统一的消息发送和管理能力。
+
+Rabbit 是一个基于 Kratos 框架构建的分布式消息服务平台，支持多种消息通道
+（邮件、Webhook、短信等）的统一管理和发送。通过命名空间（Namespace）实现
+多租户隔离，支持配置文件和数据库两种存储模式，满足不同场景的部署需求。
+
+主要功能：
+  • 多通道消息发送：支持邮件、Webhook、短信等多种消息通道的统一管理
+  • 模板化发送：支持消息模板配置，实现消息内容的动态渲染和复用
+  • 异步消息处理：基于消息队列实现异步发送，提升系统吞吐量和可靠性
+  • 配置管理：支持邮件服务器、Webhook 端点等通道配置的集中管理
+  • 多租户隔离：通过命名空间实现不同业务或租户的配置和数据隔离
+
+使用场景：
+  • 企业级通知系统：统一管理各类业务通知（订单、告警、系统消息等）
+  • 微服务消息中心：为微服务架构提供统一的消息发送能力
+  • 多渠道推送平台：集成多种消息通道，实现消息的统一发送和管理
+
+启动服务后，Rabbit 将监听配置的端口，提供 HTTP/gRPC API 接口供客户端调用。`,
 		Annotations: map[string]string{
 			"group": cmd.ServiceCommands,
 		},
@@ -49,6 +67,7 @@ func NewCmd(defaultServerConfigBytes []byte) *cobra.Command {
 
 func runServer(_ *cobra.Command, _ []string) {
 	flags.GlobalFlags = cmd.GetGlobalFlags()
+	flags.applyToBootstrap()
 	var bc conf.Bootstrap
 	if strutil.IsNotEmpty(flags.configPath) {
 		c := config.New(config.WithSource(
@@ -67,7 +86,6 @@ func runServer(_ *cobra.Command, _ []string) {
 		flags.Bootstrap = &bc
 	}
 
-	flags.applyToBootstrap()
 	serverConf := flags.GetServer()
 	envOpts := []hello.Option{
 		hello.WithVersion(flags.Version),

cmd/send/email/email.go

@@ -11,8 +11,25 @@ func NewCmd() *cobra.Command {
 	emailCmd := &cobra.Command{
 		Use:   "email",
 		Short: "Send an email message",
-		Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command.`,
+		Long: `发送邮件消息，支持 HTML 和纯文本格式，可配置邮件服务器。
+
+email 命令用于直接发送邮件消息，支持指定邮件配置 ID、收件人、主题、
+内容等参数，可以快速发送单封邮件或使用模板发送。
+
+主要功能：
+  • 邮件发送：通过配置的邮件服务器发送邮件消息
+  • 格式支持：支持 HTML 和纯文本两种邮件格式
+  • 模板发送：支持使用预配置的邮件模板进行发送
+  • 附件支持：支持添加邮件附件（如需要）
+  • 抄送密送：支持设置收件人、抄送、密送等邮件头
+
+使用场景：
+  • 测试邮件：测试邮件服务器配置是否正确
+  • 紧急通知：需要立即发送的重要邮件通知
+  • 单封发送：发送单封邮件，无需通过队列
+
+邮件发送需要先配置邮件服务器（SMTP），可通过配置文件或 API 进行
+配置。发送的邮件会立即处理，适合测试和紧急场景。`,
 		Annotations: map[string]string{
 			"group": cmd.MessageCommands,
 		},