hamburghammer-mirrors/rcon-cli
1
0
Fork 0
mirror of https://github.com/hamburghammer/rcon-cli.git synced 2024-05-15 01:34:35 +02:00
Code Issues Projects Releases Wiki Activity
25 commits 2 branches 17 tags 106 KiB
Go 95.9%
Dockerfile 4.1%
Go to file
Geoff Bourne 31d6d63079 docs: added release and build badges
2020-05-16 12:42:53 -05:00
.circleci Add 386 build and upgrade to Go 1.13 2019-09-17 21:37:09 -05:00
cli Allow for one-shot command executions 2017-04-09 08:18:37 -05:00
cmd Don't use config file searching when explicitly passed 2019-01-09 22:21:15 -06:00
.gitignore Add arm64 support 2019-05-05 09:21:06 -05:00
.goreleaser.yml docs: added release and build badges 2020-05-16 12:42:53 -05:00
DEVELOPMENT.md ci: allow extended version tags 2019-01-10 20:25:23 -06:00
Dockerfile Use ENTRYPOINT exec form instead of shell form (#6) 2020-05-16 12:16:29 -05:00
go.mod ci: go mod tidy 2019-09-17 21:41:27 -05:00
go.sum ci: allow extended version tags 2019-01-10 20:25:23 -06:00
LICENSE Initial commit 2017-04-05 15:12:15 -05:00
main.go Initial commit 2017-04-05 15:12:15 -05:00
README.md docs: added release and build badges 2020-05-16 12:42:53 -05:00

README.md

GitHub release (latest SemVer) CircleCI

A little RCON cli based on james4k's RCON library for golang.

Installation

  1. Download the appropriate binary for your platform from the latest releases

  2. On UNIX-y platforms, set the binary to be executable

Done.

Usage

rcon-cli is a CLI for attaching to an RCON enabled game server, such as Minecraft.
Without any additional arguments, the CLI will start an interactive session with
the RCON server.

If arguments are passed into the CLI, then the arguments are sent
as a single command (joined by spaces), the response is displayed,
and the CLI will exit.

Usage:
  rcon-cli [flags] [RCON command ...]

Examples:

rcon-cli --host mc1 --port 25575
rcon-cli --port 25575 stop
RCON_PORT=25575 rcon-cli stop


Flags:
      --config string     config file (default is $HOME/.rcon-cli.yaml)
      --host string       RCON server's hostname (default "localhost")
      --password string   RCON server's password
      --port int          Server's RCON port (default 27015)

Configuration

You can preconfigure rcon-cli to use the arguments you want by default by modifying the file .rcon-cli.yaml in your home folder. If you want to use any other file use the argument --config /path/to/the/config.yaml.

Example of a .rcon-cli.yaml file:

host: mydomain.com
port: 12345
password: mycustompassword

That way executing rcon-cli without arguments would connect to mydomain.com:12345 with the password mycustompassword by default.