[noci] README update

Reviewed-on: #11

README.md

@@ -82,7 +82,7 @@ Command: kill %s
 ```
 ```bash
 #runs the 'kill' command on 'player'
-mctl command run placeholder player
+mctl run placeholder player
 ```
 Running the placeholder command with the arg 'player' will run 'kill player' on the server
 

cmd/command/add.go

@@ -8,12 +8,14 @@ import (
 	"fmt"
 	"os"
 
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
 
 var addCmd = &cobra.Command{
 	Use:          "add",
+	Aliases:      []string{"a"},
 	Example:      "mctl command add",
 	Short:        "Saves a new command to the database",
 	SilenceUsage: true,
@@ -42,8 +44,8 @@ var addCmd = &cobra.Command{
 
 		err = db.SaveCmd(cfgname, cfgcmd)
 		if err != nil {
-			if err.Error() == ErrInit {
-				fmt.Println(ErrInitRsp)
+			if err.Error() == constants.ErrInit {
+				fmt.Println(constants.ErrInitRsp)
 				return
 			}
 		}

cmd/command/command.go

@@ -7,16 +7,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
-const (
-	//sqlite doesn't have an error type for this error, but we want to catch when this error is thrown
-	//and provide the proper response. It should not be treated as an error if the db isn't setup.
-	ErrInit    = "sqlite3: SQL logic error: no such table: commands"
-	ErrInitRsp = "The 'init' command must be run before mctl can be used"
-)
-
 // CommandCmd is such a cool name lol
 var CommandCmd = &cobra.Command{
 	Use:     "command",
+	Aliases: []string{"c"},
 	Example: "mctl command <subcommand>",
 }
 

cmd/command/delete.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -23,8 +24,8 @@ var deleteCmd = &cobra.Command{
 
 		err = db.DeleteCmd(args[0])
 		if err != nil {
-			if err.Error() == ErrInit {
-				fmt.Println(ErrInitRsp)
+			if err.Error() == constants.ErrInit {
+				fmt.Println(constants.ErrInitRsp)
 				return
 			}
 		}

cmd/command/view.go

@@ -6,12 +6,14 @@ package command
 import (
 	"fmt"
 
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
 
 var viewCmd = &cobra.Command{
 	Use:          "view",
+	Aliases:      []string{"v"},
 	Example:      "mctl command view",
 	Short:        "view all saved commands",
 	SilenceUsage: true,
@@ -22,8 +24,8 @@ var viewCmd = &cobra.Command{
 
 		ts, err := db.AllCmds()
 		if err != nil {
-			if err.Error() == ErrInit {
-				fmt.Println(ErrInitRsp)
+			if err.Error() == constants.ErrInit {
+				fmt.Println(constants.ErrInitRsp)
 				return
 			}
 		}

cmd/destroy.go

@@ -9,7 +9,7 @@ import (
 	"os"
 	"strings"
 
-	"code.jakeyoungdev.com/jake/mctl/cmd/command"
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -32,8 +32,8 @@ var destroyCmd = &cobra.Command{
 
 				err = db.Destroy()
 				if err != nil {
-					if err.Error() == command.ErrInit {
-						fmt.Println(command.ErrInitRsp)
+					if err.Error() == constants.ErrInit {
+						fmt.Println(constants.ErrInitRsp)
 						return
 					}
 				}

cmd/root.go

@@ -16,7 +16,7 @@ var rootCmd = &cobra.Command{
 	Use:     "mctl",
 	Short:   "A remote console client",
 	Long:    `mctl is a terminal-friendly remote console client made to manage game servers.`,
-	Version: "v0.5.1",
+	Version: "v0.7.1",
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.

cmd/run.go

@@ -1,7 +1,7 @@
 /*
 Copyright © 2025 Jake jake.young.dev@gmail.com
 */
-package command
+package cmd
 
 import (
 	"errors"
@@ -9,6 +9,7 @@ import (
 	"strings"
 
 	"code.jakeyoungdev.com/jake/mctl/client"
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -19,7 +20,8 @@ var (
 
 var runCmd = &cobra.Command{
 	Use:          "run",
-	Example:      "mctl command run -s <server> <command> args...",
+	Aliases:      []string{"r"},
+	Example:      "mctl run -s <server> <command> args...",
 	Short:        "Runs a saved command on a server",
 	Long:         `Runs the named command with the provided args on the default/active server unless -s is specified`,
 	SilenceUsage: true,
@@ -34,8 +36,8 @@ var runCmd = &cobra.Command{
 
 		crun, err := db.Cmd(cname)
 		if err != nil {
-			if err.Error() == ErrInit {
-				fmt.Println(ErrInitRsp)
+			if err.Error() == constants.ErrInit {
+				fmt.Println(constants.ErrInitRsp)
 				return nil
 			}
 			return err
@@ -76,5 +78,5 @@ var runCmd = &cobra.Command{
 
 func init() {
 	runCmd.Flags().StringVarP(&cfgserver, "server", "s", "", "server name")
-	CommandCmd.AddCommand(runCmd)
+	rootCmd.AddCommand(runCmd)
 }

cmd/server/add.go

@@ -18,6 +18,7 @@ import (
 
 var addCmd = &cobra.Command{
 	Use:          "add",
+	Aliases:      []string{"a"},
 	Example:      "mctl server add",
 	Short:        "Saves a new server configuration",
 	Long:         `Saves server address, alias, port, and password to the database.`,

cmd/server/server.go

@@ -16,6 +16,7 @@ const (
 
 var ServerCmd = &cobra.Command{
 	Use:     "server",
+	Aliases: []string{"s"},
 	Example: "mctl server <subcommand>",
 }
 

cmd/server/update.go

@@ -16,6 +16,7 @@ import (
 
 var updateCmd = &cobra.Command{
 	Use:          "update",
+	Aliases:      []string{"u"},
 	Example:      "mctl server update <name>",
 	Short:        "updates a saved servers password in the database",
 	SilenceUsage: true,

cmd/server/view.go

@@ -15,6 +15,7 @@ var decode bool
 
 var viewCmd = &cobra.Command{
 	Use:          "view",
+	Aliases:      []string{"v"},
 	Example:      "mctl server view",
 	Short:        "view all saved servers",
 	SilenceUsage: true,

constants/error.go

@@ -0,0 +1,8 @@
+package constants
+
+const (
+	//sqlite doesn't have an error type for this error, but we want to catch when this error is thrown
+	//and provide the proper response. It should not be treated as an error if the db isn't setup.
+	ErrInit    = "sqlite3: SQL logic error: no such table: commands"
+	ErrInitRsp = "The 'init' command must be run before mctl can be used"
+)