feat: add about command (#270)

INSTALL.md

@@ -68,6 +68,12 @@ Now, you can interact with Pagu:
 calculate reward --stake=1000 --days=1
 ```
 
+Check the verson of Pagu:
+
+```bash
+about 
+```
+
 ## Contributing
 
 We are excited to welcome contributions to Pagu! To get started, follow these steps:

cmd/cli/main.go

@@ -5,11 +5,11 @@ import (
 	"os"
 	"strings"
 
-	"github.com/pagu-project/pagu"
 	pagucmd "github.com/pagu-project/pagu/cmd"
 	"github.com/pagu-project/pagu/config"
 	"github.com/pagu-project/pagu/internal/engine"
 	"github.com/pagu-project/pagu/internal/entity"
+	"github.com/pagu-project/pagu/internal/version"
 	"github.com/pagu-project/pagu/pkg/log"
 	"github.com/spf13/cobra"
 )
@@ -52,7 +52,7 @@ func run(cmd *cobra.Command, _ []string) {
 func main() {
 	rootCmd := &cobra.Command{
 		Use:     "pagu-cli",
-		Version: pagu.StringVersion(),
+		Version: version.StringVersion(),
 		Run:     run,
 	}
 

cmd/discord/main.go

@@ -1,8 +1,8 @@
 package main
 
 import (
-	"github.com/pagu-project/pagu"
 	"github.com/pagu-project/pagu/cmd"
+	"github.com/pagu-project/pagu/internal/version"
 	"github.com/spf13/cobra"
 )
 
@@ -11,7 +11,7 @@ var configPath string
 func main() {
 	rootCmd := &cobra.Command{
 		Use:     "pagu-discord",
-		Version: pagu.StringVersion(),
+		Version: version.StringVersion(),
 	}
 
 	rootCmd.PersistentFlags().StringVarP(&configPath, "config", "c", "./config.yml", "config path ./config.yml")

cmd/grpc/main.go

@@ -1,15 +1,15 @@
 package main
 
 import (
-	"github.com/pagu-project/pagu"
 	"github.com/pagu-project/pagu/cmd"
+	"github.com/pagu-project/pagu/internal/version"
 	"github.com/spf13/cobra"
 )
 
 func main() {
 	rootCmd := &cobra.Command{
 		Use:     "pagu-grpc",
-		Version: pagu.StringVersion(),
+		Version: version.StringVersion(),
 	}
 
 	runCommand(rootCmd)

cmd/http/main.go

@@ -1,15 +1,15 @@
 package main
 
 import (
-	"github.com/pagu-project/pagu"
 	"github.com/pagu-project/pagu/cmd"
+	"github.com/pagu-project/pagu/internal/version"
 	"github.com/spf13/cobra"
 )
 
 func main() {
 	rootCmd := &cobra.Command{
 		Use:     "pagu-http",
-		Version: pagu.StringVersion(),
+		Version: version.StringVersion(),
 	}
 
 	runCommand(rootCmd)

cmd/telegram/main.go

@@ -1,8 +1,8 @@
 package main
 
 import (
-	"github.com/pagu-project/pagu"
 	"github.com/pagu-project/pagu/cmd"
+	"github.com/pagu-project/pagu/internal/version"
 	"github.com/spf13/cobra"
 )
 
@@ -11,7 +11,7 @@ var configPath string
 func main() {
 	rootCmd := &cobra.Command{
 		Use:     "pagu-telegram",
-		Version: pagu.StringVersion(),
+		Version: version.StringVersion(),
 	}
 
 	rootCmd.PersistentFlags().StringVarP(&configPath, "config", "c", "./config.yml", "config path ./config.yml")

deployment/README.md

@@ -33,6 +33,7 @@ Use the following command to create the network:
 docker network create pagu_network
 ```
 
+
 ### Deployment Overview
 
 The deployment system operates as follows:

internal/engine/command/command.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/pagu-project/pagu/internal/entity"
+	"github.com/pagu-project/pagu/internal/version"
 	"github.com/pagu-project/pagu/pkg/utils"
 )
 
@@ -20,6 +21,11 @@ const errorTemplate = `
 {{.err}}
 `
 
+const aboutTemplate = `
+**About pagu**
+version : {{.version}}
+`
+
 var (
 	TargetMaskMainnet   = 1
 	TargetMaskTestnet   = 2
@@ -260,3 +266,19 @@ func (cmd *Command) AddHelpSubCommand() {
 
 	cmd.AddSubCommand(helpCmd)
 }
+
+func (cmd *Command) AddAboutSubCommand() {
+	cmd.ResultTemplate = aboutTemplate
+	aboutCmd := &Command{
+		Name:           "about",
+		Help:           "About Pagu",
+		AppIDs:         entity.AllAppIDs(),
+		TargetFlag:     TargetMaskAll,
+		ResultTemplate: aboutTemplate,
+		Handler: func(_ *entity.User, _ *Command, _ map[string]string) CommandResult {
+			return cmd.RenderResultTemplate("version", version.StringVersion())
+		},
+	}
+
+	cmd.AddSubCommand(aboutCmd)
+}

internal/engine/engine.go

@@ -148,6 +148,7 @@ func newBotEngine(ctx context.Context,
 	rootCmd.AddSubCommand(marketCmd.GetCommand())
 	rootCmd.AddSubCommand(phoenixCmd.GetCommand())
 
+	rootCmd.AddAboutSubCommand()
 	rootCmd.AddHelpSubCommand()
 
 	return &BotEngine{

version.go → internal/version/version.go

@@ -1,4 +1,4 @@
-package pagu
+package version
 
 import "fmt"