new/clear-command (#8)
Reviewed-on: #8 Co-authored-by: jake <jake.young.dev@gmail.com> Co-committed-by: jake <jake.young.dev@gmail.com>
This commit was merged in pull request #8.
This commit is contained in:
18
README.md
18
README.md
@@ -1,12 +1,18 @@
|
||||
# mctl
|
||||
mctl is a terminal-friendly remote console client
|
||||
|
||||
## Index
|
||||
1. [Installation](#installation)
|
||||
2. [Setup](#setup)
|
||||
3. [Documentation](#documentation)
|
||||
4. [Security](#security)
|
||||
5. [Development](#development)
|
||||
|
||||
## Installation
|
||||
Install mctl using golang
|
||||
```bash
|
||||
go install code.jakeyoungdev.com/jake/mctl@main #it is recommended to use a tagged version
|
||||
```
|
||||
<br />
|
||||
|
||||
## Setup
|
||||
### Configuring mctl
|
||||
@@ -75,6 +81,13 @@ Commands can be deleted with:
|
||||
mctl delete <name>
|
||||
```
|
||||
|
||||
### Clear configuration file
|
||||
To clear all fields from the configuration file use:
|
||||
```bash
|
||||
#CAUTION: If the config file is cleared all data previously saved will be lost forever
|
||||
mctl clear
|
||||
```
|
||||
|
||||
## Documentation
|
||||
### Commands
|
||||
|Command|Description|
|
||||
@@ -85,6 +98,7 @@ mctl delete <name>
|
||||
|view \<name>|displays saved command|
|
||||
|delete \<name>|deletes saved command|
|
||||
|run \<name> args...|runs saved command filling placeholders with supplied args|
|
||||
|clear|clears config file|
|
||||
|
||||
### Flags
|
||||
#### config
|
||||
@@ -102,4 +116,4 @@ RCon is an inherently insecure protocol, passwords are sent in plaintext and, if
|
||||
mctl utilizes [govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck) and [gosec](https://github.com/securego/gosec) in workflows to ensure quality, secure code is being pushed. These workflow steps must pass before a PR will be accepted
|
||||
|
||||
## Development
|
||||
this repo is currently in heavy development and may encounter breaking changes, use a tag to prevent any surprises
|
||||
this repo is currently in development and may encounter breaking changes, use a tag to prevent any surprises
|
||||
Reference in New Issue
Block a user