q3rcon-tui/README.md

q3rcon tui

---

Table of Contents

• Installation
• License

Installation

with uv

uv tool install q3rcon-tui

with pipx

pipx install q3rcon-tui

The TUI should now be discoverable as q3rcon-tui.

Configuration

Flags

Pass --host, --port and --password as flags:

q3rcon-tui --host=localhost --port=28960 --password=rconpassword

Additional flags:

• --raw: Boolean flag, if set the RichLog will print raw responses without rendering tables.
• --append: Boolean flag, if set the RichLog output with append each response continuously.

Environment Variables

Store and load from dotenv files located at:

• .env in the cwd
• user home directory / .config / q3rcon-tui / config.env

example .env:

Q3RCON_TUI_HOST=localhost
Q3RCON_TUI_PORT=28960
Q3RCON_TUI_PASSWORD=rconpassword
Q3RCON_TUI_RAW=false
Q3RCON_TUI_APPEND=false

Special Thanks

• lapetus-11 for writing the aio-q3-rcon package.
• The developers at Textualize for writing the textual package.

License

q3rcon-tui is distributed under the terms of the MIT license.