rcon-cli 0.1.2

A RCON client library and CLI for game server administration
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

# rcon-cli

A command-line RCON client for remote server administration.

This client was developed with Factorio in mind, but may work with other RCON-compatible games.

## Installation

### Homebrew (macOS/Linux)

```bash
brew tap connor-hanson/rcon-cli
brew install rcon-cli
```

### Cargo (crates.io)

```bash
cargo install rcon-cli
```

### From Source

```bash
cargo install --path .
```

## Features

- **Interactive Mode** - Connect once and run multiple commands in a persistent session
- **One-Shot Mode** - Execute single commands and exit
- **Config File Support** - Store server credentials in a JSON file for easy access
- **Lightweight** - Minimal dependencies and fast execution
- **Cross-Platform** - Works on macOS, Linux, and Windows
- **Auto-Reconnection** - Automatically attempt server reconnection if server connection dies

## Usage

### Configuration File

Store server credentials in a JSON config file to avoid typing them repeatedly.

#### Example Config File

Create a file (e.g., `~/.rcon-config.json`):

```json
{
  "configs": {
    "production": {
      "host": "192.168.1.100",
      "port": 27015,
      "password": "prod_password"
    },
    "staging": {
      "host": "192.168.1.101",
      "port": 27015,
      "password": "staging_password"
    },
    "local": {
      "host": "127.0.0.1",
      "port": 27015,
      "password": "dev_password"
    }
  }
}
```

#### Set Environment Variable

Point to your config file:

```bash
export RCON_CONFIG_PATH=~/.rcon-config.json
```

#### Using Configs
```bash
rcon-cli --config-name custom_config_profile
```

This loads the host and password from your config file, so you don't need to pass `--address` or `--password` flags.

### Interactive Mode

Connect to a server and run commands interactively:

```bach
> rcon-cli
Enter address: <your_server_address>
Enter port: <your_server_port>
Enter password: <your_server_password>
[2026-02-14T01:13:27Z INFO  rcon_cli] Connected!
> <enter command>
```

```bash
rcon-cli --address <ip_addr> --port <port> --password <password> --show-responses --auto-reconnect
```

Example:
```bash
rcon-cli --address 127.0.0.1 --port 27015 --password mypassword
```

### One-Shot Mode

Execute a single command and exit:

```bash
rcon-cli --address <ip_addr> --port <port> --password <password> -c <command>
```

Example:
```bash
rcon-cli --address 127.0.0.1 --port 27015 --password mypassword -c "/players"
```