rcon-cli

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 27, 2019 License: MIT Imports: 8 Imported by: 0

README

rcon-cli

Go Report Card GitHub All Releases

CLI for executing queries on a remote server

Supported Games

Open pull request if you have successfully used a package with another game with rcon support and add it to the list.

Installation

Download the binary for your platform from the releases

Usage

Rcon CLI can be run in two modes - in the mode of a single query and in the mode of reading the input stream

Single mode

Server address, password and command to server must be specified in flags at startup. Example:

./rcon -a address -p password -c command

If flags are passed into the CLI, then the flags are sent as a single command. The response is displayed, and the CLI will exit.

Input stream mode

To run CLI in input stream mode add command cli. Example:

./rcon -a address -p password cli

Use ^C to terminate or type command :q in CLI.

Configuration file

For more convenient use, the ability to create the rcon.yaml configuration file is provided. You can save the address of the remote server and its password. If the configuration file exists, then at startup the -a and -p flags can be omitted. Example:

./rcon -a address -c command
./rcon -a address cli

Default configuration file name is rcon.yaml. File must be saved in yaml format. Example:

default:
  address: "127.0.0.1:16260"
  password: "password"

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL