From 8068b090ed11477bf57314a0db65a8718345bc6d Mon Sep 17 00:00:00 2001 From: jake Date: Wed, 16 Apr 2025 16:43:58 -0400 Subject: [PATCH] adding version into command --- README.md | 16 +++++++++++++--- cmd/root.go | 7 ++++--- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d189e44..4f88f4d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ mctl is a terminal-friendly remote connection client ## Installation Install mctl using golang ```bash -go install code.jakeyoungdev.com/jake/mctl@main #it is recommended to use a tagged version to prevent pulling unwanted changes +go install code.jakeyoungdev.com/jake/mctl@main #it is recommended to use a tagged version ``` ## Setup @@ -23,6 +23,13 @@ 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 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 +RCON@X.X.X.X /> list + +There are 0 of a max of 20 players online: +``` ## Documentation ### Commands @@ -42,7 +49,10 @@ If login is successful the app will enter the command loop, which allows command no flags ### Configuration file -All configuration data will be kept in /home/.mctl.yaml, passwords are encrypted for an added layer of 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 ## Development -this repo is currently in heavy development and may encounter breaking changes \ No newline at end of file +this repo is currently in heavy development and may encounter breaking changes, use a tag to prevent any surprises \ No newline at end of file diff --git a/cmd/root.go b/cmd/root.go index c15f32e..4e1173c 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -11,9 +11,10 @@ import ( // rootCmd represents the base command when called without any subcommands 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.`, + Use: "mctl", + Short: "A remote console client", + Long: `mctl is a terminal-friendly remote console client made to manage game servers.`, + Version: "v0.1.1", // Run: func(cmd *cobra.Command, args []string) { }, }