mirror of
https://github.com/onyx-and-iris/q3rcon-cli.git
synced 2026-03-23 18:29:18 +00:00
1.6 KiB
1.6 KiB
q3rcon-cli
Table of Contents
Installation
with uv
uv tool install q3rcon-cli
with pipx
pipx install q3rcon-cli
The CLI should now be discoverable as q3rcon-cli.
Configuration
Flags
Pass --host, --port and --password as flags:
q3rcon-cli --host=localhost --port=28960 --password=rconpassword
Additional Flags:
--interactive: Boolean flag, enable REPL mode.
Environment Variables
example .envrc:
#!/usr/bin/env bash
export Q3RCON_CLI_HOST="localhost"
export Q3RCON_CLI_PORT="28960"
export Q3RCON_CLI_PASSWORD="<rcon password>"
Special Thanks
- lapetus-11 for writing the aio-q3-rcon package.
- Daniel Melchor for creating the wonderful clypi library.
License
q3rcon-cli is distributed under the terms of the MIT license.