Skip to content

Commit

Permalink
Adds config file information on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zlotny authored May 27, 2019
1 parent b80e38d commit 9f80704
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,16 @@ Flags:
--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:
```yaml
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.

0 comments on commit 9f80704

Please sign in to comment.