Compare commits
4 Commits
v0.3.3
...
8daa621528
Author | SHA1 | Date | |
---|---|---|---|
8daa621528 | |||
7f090dbce7 | |||
f943639a88 | |||
bef3521770 |
@@ -10,7 +10,7 @@ go install code.jakeyoungdev.com/jake/mctl@main #it is recommended to use a tagg
|
||||
|
||||
## Setup
|
||||
### Configuring mctl
|
||||
mctl requires a one-time setup via the 'config' command before interacting with any servers, password is entered securely from the terminal and encrypted
|
||||
mctl requires a one-time setup via the 'config' command before interacting with any servers, password is entered securely from the terminal
|
||||
```bash
|
||||
mctl config -s <serveraddress> -p <rconport>
|
||||
```
|
||||
@@ -23,7 +23,7 @@ mctl login #makes auth request to server with saved password
|
||||
```
|
||||
|
||||
### Sending commands
|
||||
If login is successful the app will enter the command loop, which allows commands to be sent directly to the server. Commands are sent as-is to the server, there is no validation of command syntax within mctl
|
||||
If login is successful the app will enter the command loop, which allows commands to be sent directly to the server until 'mctl' is sent. Commands are sent as-is to the server, there is no validation of command syntax within mctl
|
||||
```
|
||||
Logging into X.X.X.X on port 61695
|
||||
Connected! Type 'mctl' to close
|
||||
@@ -33,7 +33,7 @@ There are 0 of a max of 20 players online:
|
||||
```
|
||||
|
||||
### Saving commands
|
||||
Commands can be saved under an alias for quick execution later, saved commands can contain placeholders '%s' that can be populated at runtime to allow for commands with unique runtime args to still be saved, see [example](#saving-and-running-example) for more:
|
||||
Commands can be saved under an alias for quick execution later, saved commands can contain placeholders '%s' that can be populated at runtime to allow for commands with unique runtime args to still be saved:
|
||||
```bash
|
||||
mctl save <name>
|
||||
```
|
||||
@@ -90,7 +90,7 @@ mctl delete <name>
|
||||
|server|s|yes|RCon address|
|
||||
|
||||
### Configuration file
|
||||
All configuration data will be kept in the home directory and any sensitive data is encrypted for added security
|
||||
All configuration data will be kept in /home/.mctl.yaml or C:\\Users\\username\\.mctl.yaml, passwords are encrypted for an added layer of security
|
||||
|
||||
## Security
|
||||
RCon is an inherently insecure protocol, passwords are sent in plaintext and, if possible, the port should not be exposed to the internet. It is best to keep these connections local or over a VPN
|
||||
|
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
Copyright © 2025 Jake jake.young.dev@gmail.com
|
||||
Copyright © 2025 NAME HERE <EMAIL ADDRESS>
|
||||
*/
|
||||
package cmd
|
||||
|
||||
@@ -17,12 +17,16 @@ var deleteCmd = &cobra.Command{
|
||||
Short: "Delete a saved command",
|
||||
Long: `Deletes a command stored using the save command`,
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
if viper.IsSet("customcmd") {
|
||||
cmdMap := viper.Get("customcmd").(map[string]any)
|
||||
delete(cmdMap, args[0])
|
||||
var cm map[string]any
|
||||
cmdMap := viper.Get("customcmd")
|
||||
if cmdMap == nil {
|
||||
cm = make(map[string]any, 0)
|
||||
} else {
|
||||
cm = cmdMap.(map[string]any)
|
||||
}
|
||||
delete(cm, args[0])
|
||||
viper.Set("customcmd", cmdMap)
|
||||
viper.WriteConfig()
|
||||
}
|
||||
},
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
if len(args) == 0 {
|
||||
|
@@ -58,10 +58,9 @@ var loginCmd = &cobra.Command{
|
||||
},
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
//ensure config command has been run
|
||||
if !viper.IsSet("server") || !viper.IsSet("password") || !viper.IsSet("port") {
|
||||
if viper.Get("server") == "" || viper.Get("password") == "" || viper.Get("port") == 0 {
|
||||
return errors.New("the 'config' command must be run before you can interact with servers")
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
@@ -14,7 +14,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.3.3",
|
||||
Version: "v0.2.0",
|
||||
// Run: func(cmd *cobra.Command, args []string) { },
|
||||
}
|
||||
|
||||
|
17
cmd/run.go
17
cmd/run.go
@@ -22,7 +22,14 @@ var runCmd = &cobra.Command{
|
||||
Long: `Loads a saved command, injects the supplied arguments into the command, and sends the command to the remove server
|
||||
printing the response`,
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
cm := viper.Get("customcmd").(map[string]any)
|
||||
//check for command map
|
||||
var cm map[string]any
|
||||
cmdMap := viper.Get("customcmd")
|
||||
if cmdMap == nil {
|
||||
cm = make(map[string]any, 0)
|
||||
} else {
|
||||
cm = cmdMap.(map[string]any)
|
||||
}
|
||||
//is this an existing command
|
||||
cmdRun, ok := cm[args[0]]
|
||||
if !ok {
|
||||
@@ -51,15 +58,11 @@ var runCmd = &cobra.Command{
|
||||
fmt.Println(res)
|
||||
},
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
//ensure config command has been run
|
||||
if !viper.IsSet("server") || !viper.IsSet("password") || !viper.IsSet("port") {
|
||||
//ensure configuration has been setup
|
||||
if viper.Get("server") == "" || viper.Get("password") == "" || viper.Get("port") == 0 {
|
||||
return errors.New("the 'config' command must be run before you can interact with servers")
|
||||
}
|
||||
|
||||
if !viper.IsSet("customcmd") {
|
||||
return errors.New("no saved commands to run")
|
||||
}
|
||||
|
||||
//ensure we have a command name
|
||||
al := len(args)
|
||||
if al == 0 {
|
||||
|
@@ -32,7 +32,7 @@ var viewCmd = &cobra.Command{
|
||||
return
|
||||
}
|
||||
|
||||
fmt.Printf("Command: %s\n", custom.(string))
|
||||
fmt.Printf("Command: %s", custom.(string))
|
||||
},
|
||||
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
if len(args) == 0 {
|
||||
|
Reference in New Issue
Block a user