leonardodino / rcon-shell

:pager: minimal rcon shell for classic hlds

rcon-shell

rcon interactive shell via µdp

features

🧠 autocompletion
  _{for commands, maps and cvars}

🗜️ lightweight + minimalist
  _{single self-contained file, under 5kb
  no 3^rd party dependencies}

🗿 compatible
  _{supports node v10+
  can be saved directly to PATH}

installation

curl
curl -sL https://unpkg.com/rcon-shell/bin/rcon-shell > /usr/local/bin/rcon-shell chmod +x /usr/local/bin/rcon-shell

yarn
yarn global add rcon-shell

npm
npm i -g rcon-shell

npx
npx rcon-shell

usage

RCON_HOST=example.org RCON_PASSWORD=your-password-here rcon-shell

the cli does not receive arguments. it is configured via 3 environment variables:

name	default	description
RCON_PASSWORD	(required)	rcon admin password
RCON_HOST	127.0.0.1	server to connect to (IP or DNS host)
RCON_PORT	27015	udp port to use for communication

to exit: ctrl + C or type exit

system requirements

node	hlds (or other rcon-compatible udp server)
any LTS version after v10	configured with rcon_password

license

MIT