Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zekroTJA committed Mar 20, 2024
1 parent 07193a5 commit 89e26ae
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# rconcli

A little CLI to issue RCON commands to a Minecraft server.
A little CLI to issue RCON commands to a Minecraft server.

![WindowsTerminal_ClQRborIho](https://github.com/zekroTJA/rconcli/assets/16734205/7a0ee0e5-0627-4f35-bcc6-1c34dbd07722)

## Usage

```
$ rconcli --help
A simple RCON CLI for Minecraft servers.
Usage: rconcli.exe [OPTIONS] [COMMAND]...
Arguments:
[COMMAND]... Command to execute
Options:
--properties <PROPERTIES> Location of a server.proterties file to read credentials from
-a, --address <ADDRESS> The address and port of the target server
-p, --password <PASSWORD> The password of the target server
--no-color Supress colored output
-h, --help Print help
-V, --version Print version
```

0 comments on commit 89e26ae

Please sign in to comment.