q3rcon-cli 0.3.3

An async CLI for Q3 compatible RCON servers built with aio-q3-rcon and clypi.

q3rcon-cli

---

Table of Contents

• Installation
• Configuration
• Use
• Shell Completion
• License

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>"

Use

Usage: q3rcon-cli [OPTIONS] COMMAND

┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ fastrestart  Executes a fast restart of the server                                               ┃
┃ gametype     Get or set the current gametype of the server                                       ┃
┃ hostname     Get or set the current hostname of the server                                       ┃
┃ map          Get the current map or change to a new one                                          ┃
┃ mapname      Prints the current map name of the server                                           ┃
┃ maprestart   Restarts the current map                                                            ┃
┃ maprotate    Rotates the map to the next one in the map rotation list                            ┃
┃ plugins      Prints the currently loaded plugins of the server                                   ┃
┃ status       Prints the status of the server                                                     ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ -i, --interactive   Whether to start in interactive mode (defaults to false)                     ┃
┃ -v, --version       Show the version and exit                                                    ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

┏━ Connection options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ -h, --host <HOST>          The host to connect to                                                ┃
┃ -p, --port <PORT>          The port to connect to                                                ┃
┃ -P, --password <PASSWORD>  The password for authentication                                       ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

Shell Completion

Shell completion scripts are available for bash, zsh, and fish.

q3rcon-cli --install-autocomplete

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.