RCON(1)

πŸ“¦ version 0.6, in alpine 3.24, nixos 26.05, nixpkgs unstable

πŸ’… RCON(1) β€” like, the rcon page, bestie ✨

okay so real talk: this is rcon, from the USER COMMANDS section of your manual, and it's literally the command line source rcon client you've been looking for. no cap. let's get into it πŸŽ€


✨ NAME ✨

rcon β€” command line source rcon client πŸ¦‹


🌸 SYNOPSIS 🌸

rcon [options] command

πŸ’– DESCRIPTION πŸ’–

so rcon is your girl for being a command line remote console client for source game servers. iconic behavior honestly. πŸ‘‘

she supports a configuration file so you can safely store your rcon passwords β€” yes bestie, safely, we love that for us πŸ”βœ¨

she'll execute the command you give her, or β€” plot twist β€” if you give her no command at all, she'll read a whole list of commands from standard input. main character energy fr fr πŸ’…


🌈 OPTIONS 🌈

  • -c, --config filename β€” point her at a different path for the configuration file. the default is $HOME/.rconrc 🏠
  • -d, --debug β€” turns on debug mode. the packages she sends and receives get shown right there on your terminal. she's being transparent with you 🫢
  • -h, --help β€” usage. the classic. the legend. πŸ’«
  • -H, --host hostname β€” hostname or IP address of the server 🌐
  • -m, --minecraft β€” Minecraft compatibility mode 🟩 (yes, that Minecraft)
  • -n, --nowait β€” don't wait for a reply from the server, just send and quit. in and out, no strings πŸ’¨
  • -p, --port port β€” port or service name πŸ”Œ
  • -P, --password password β€” the remote console password of the server πŸ”‘
  • -s, --server name β€” use this server from the configuration file πŸ“–

πŸŽ€ FILES πŸŽ€

  • ~/.rconrc β€” the default configuration filename for rcon. that's her home πŸ’–

🧚 CONFIGURATION FILE 🧚

the configuration file has to be in the key file format (which everyone commonly calls an INI file) and it must follow this schema exactly:

[myserver]
hostname = 173.43.63.111
port = 27003
password = somepass
# remove the line below if it the server is not minecraft
minecraft = true

once you've got that, you can use this server straight from the command line with the -s parameter:

rcon -s myserver status

and here's the slay part: the command line still trumps the configuration file. so this next one would override the port to 27010:

rcon -s myserver -p 27010 status

πŸ¦‹ INTERPRETER πŸ¦‹

okay this is lowkey the coolest part β€” rcon can also be used as a script interpreter πŸ§šβ€β™€οΈ just specify the rcon binary in the she bang. lines that start with a hash sign get ignored, and every other non-empty line gets treated as a command. this script right here runs two commands:

#!/usr/bin/rcon -s myserver

# Query status
status

# List plugins
sm plugins list

⭐ EXAMPLES ⭐

send status to a server with a given IP, port and password:

rcon -H 173.43.63.11 -p 27003 -P somepass status

send a patch of commands to a server:

echo -e "status\nsm plugins list" | rcon -s myserver

πŸ’€ BUGS πŸ’€

report bugs at https://github.com/n0la/rcon β€” she wants to hear from you bestie πŸ™ˆ


πŸ‘‘ AUTHOR πŸ‘‘

Copyright (c) 2016 Florian Stinglmayr <fstinglmayr@gmail.com> πŸ’œ


ngl, copyright and version stuff is the boring bit but we keep it because respect: this is version 0.5, dated September 19, 2016, living in the USER COMMANDS section, and that's the whole page πŸ“

periodt. you're gonna do great. mwah πŸ’‹

πŸ“¦ where this page comes from