jake/mctl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 9 Wiki Activity

adding version into command

Browse Source
This commit is contained in:
jake 2025-04-16 16:43:58 -04:00
parent 2a6090bd67
commit 8068b090ed
2 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -4,7 +4,7 @@ mctl is a terminal-friendly remote connection client
## Installation ## Installation
Install mctl using golang Install mctl using golang
```bash ```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 ## Setup
@ -23,6 +23,13 @@ mctl login #makes auth request to server with saved password
### Sending commands ### 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 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 ## Documentation
### Commands ### Commands
@ -42,7 +49,10 @@ If login is successful the app will enter the command loop, which allows command
no flags no flags
### Configuration file ### 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 ## Development
this repo is currently in heavy development and may encounter breaking changes this repo is currently in heavy development and may encounter breaking changes, use a tag to prevent any surprises

1
cmd/root.go
View File

@ -14,6 +14,7 @@ var rootCmd = &cobra.Command{
Use: "mctl", Use: "mctl",
Short: "A remote console client", Short: "A remote console client",
Long: `mctl is a terminal-friendly remote console client made to manage game servers.`, 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) { }, // Run: func(cmd *cobra.Command, args []string) { },
} }