minor bump

pre_run_hook added, it runs before all subcommands.

gametype command now calls maprestart command directly if the -f flag is passed.

README.md

@@ -10,6 +10,9 @@
 ## Table of Contents
 
 - [Installation](#installation)
+- [Configuration](#configuration)
+- [Use](#use)
+- [Shell Completion](#shell-completion)
 - [License](#license)
 
 ## Installation
@@ -60,7 +63,7 @@ export Q3RCON_CLI_PASSWORD="<rcon password>"
 Usage: q3rcon-cli [OPTIONS] COMMAND
 
 ┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-┃ fastrestart  Executes a fast restart of the server                                               ┃
+┃ fastrestart  Executes a fast restart of the map                                                  ┃
 ┃ 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                                          ┃
@@ -73,6 +76,7 @@ Usage: q3rcon-cli [OPTIONS] COMMAND
 
 ┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 ┃ -i, --interactive   Whether to start in interactive mode (defaults to false)                     ┃
+┃ -v, --version       Show the version and exit                                                    ┃
 ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
 ┏━ Connection options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
@@ -82,6 +86,14 @@ Usage: q3rcon-cli [OPTIONS] COMMAND
 ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 ```
 
+## Shell Completion
+
+Shell completion scripts are available for *bash*, *zsh*, and *fish*.
+
+```console
+q3rcon-cli --install-autocomplete
+```
+
 ## Special Thanks
 
 - [lapetus-11](https://github.com/Iapetus-11) for writing the [aio-q3-rcon](https://github.com/Iapetus-11/aio-q3-rcon) package.

src/q3rcon_cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2026-present onyx-and-iris <code@onyxandiris.online>
 #
 # SPDX-License-Identifier: MIT
-__version__ = '0.2.3'
+__version__ = '0.4.0'

src/q3rcon_cli/cli.py

@@ -1,9 +1,11 @@
 import clypi
 from aioq3rcon import Client, IncorrectPasswordError
-from clypi import Command, arg
+from clypi import Command, Spinner, arg
+from clypi import parsers as cp
 from typing_extensions import override
 
-from . import console
+from . import config, console
+from .__about__ import __version__
 from .commands import (
     Fastrestart,
     Gametype,
@@ -37,6 +39,7 @@ class Q3rconCli(Command):
         help='The host to connect to',
         env='Q3RCON_CLI_HOST',
         group='Connection',
+        parser=cp.Str(min=1),
     )
     port: int = arg(
         28960,
@@ -44,6 +47,7 @@ class Q3rconCli(Command):
         help='The port to connect to',
         env='Q3RCON_CLI_PORT',
         group='Connection',
+        parser=cp.Int(min=1, max=65535),
     )
     password: str = arg(
         '',
@@ -51,56 +55,84 @@ class Q3rconCli(Command):
         help='The password for authentication',
         env='Q3RCON_CLI_PASSWORD',
         group='Connection',
+        parser=cp.Str(min=8),
     )
     interactive: bool = arg(
         False,
         short='i',
         help='Whether to start in interactive mode (defaults to false)',
     )
+    version: bool = arg(
+        False,
+        short='v',
+        help='Show the version and exit',
+    )
+
+    @override
+    async def pre_run_hook(self):
+        if self.subcommand is not None and self.interactive:
+            console.err.print(
+                'Cannot use subcommands in interactive mode.',
+                style='yellow',
+            )
+            self.print_help()
+            raise SystemExit(1)
+
+        if self.subcommand:
+            (
+                self.subcommand.timeout,
+                self.subcommand.fragment_read_timeout,
+                self.subcommand.interpret,
+            ) = config.get(self.subcommand.prog().split()[0].lower())
 
     @override
     async def run(self):
+        if self.version:
+            print(f'q3rcon-cli version: {clypi.style(__version__, fg="green")}')
+            return
+
         if self.interactive:
             await self.run_interactive()
-        else:
+            return
+
+        if self.subcommand is None:
             await Status(self.host, self.port, self.password).run()
+            return
+
+        self.print_help()
 
     async def run_interactive(self):
         print(
             clypi.style('Entering interactive mode. Type', fg='blue'),
-            clypi.style("'Q'", fg='red'),
+            clypi.style("'Q'", fg='yellow'),
             clypi.style('to quit.', fg='blue'),
         )
-
-        DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25
         while command := input(clypi.style('cmd: ', fg='green')):
             if command.lower() == 'q':
                 break
 
-            fragment_read_timeout = None
-            if command in (
-                'status',
-                'fast_restart',
-                'map_restart',
-                'map',
-                'map_rotate',
-            ):
-                fragment_read_timeout = 1
+            timeout, fragment_read_timeout, interpret = config.get(
+                command.split()[0].lower()
+            )
 
-            async with Client(
-                self.host,
-                self.port,
-                self.password,
-                fragment_read_timeout=fragment_read_timeout
-                or DEFAULT_FRAGMENT_READ_TIMEOUT,
-            ) as client:
-                try:
-                    if response := await client.send_command(command):
-                        console.out.print_response(response)
-                except TimeoutError:
-                    console.err.print(
-                        f"Timeout waiting for response for command: '{command}'"
-                    )
+            async with Spinner(f"Sending command: '{command}'", suffix='...'):
+                async with Client(
+                    self.host,
+                    self.port,
+                    self.password,
+                    timeout=timeout,
+                    fragment_read_timeout=fragment_read_timeout,
+                ) as client:
+                    try:
+                        response = await client.send_command(
+                            command, interpret=interpret
+                        )
+                    except TimeoutError:
+                        console.err.print(
+                            f"Timeout waiting for response for command: '{command}'"
+                        )
+
+            console.out.print_response(response)
 
 
 def main():

src/q3rcon_cli/commands/fastrestart.py

@@ -1,12 +1,12 @@
 from aioq3rcon import Client
-from clypi import Command, arg
+from clypi import Command, Spinner, arg
 from typing_extensions import override
 
 from q3rcon_cli import console
 
 
 class Fastrestart(Command):
-    """Executes a fast restart of the server."""
+    """Executes a fast restart of the map."""
 
     host: str = arg(inherited=True)
     port: int = arg(inherited=True)
@@ -14,6 +14,16 @@ class Fastrestart(Command):
 
     @override
     async def run(self):
-        async with Client(self.host, self.port, self.password) as client:
-            if response := await client.send_command('fast_restart'):
-                console.out.print_response(response)
+        async with Spinner('Executing fast restart', suffix='...'):
+            async with Client(
+                self.host,
+                self.port,
+                self.password,
+                timeout=self.timeout,
+                fragment_read_timeout=self.fragment_read_timeout,
+            ) as client:
+                response = await client.send_command(
+                    'fast_restart', interpret=self.interpret
+                )
+
+        console.out.print_response(response)

src/q3rcon_cli/commands/gametype.py

@@ -4,6 +4,8 @@ from typing_extensions import override
 
 from q3rcon_cli import console
 
+from .maprestart import Maprestart
+
 
 class Gametype(Command):
     """Get or set the current gametype of the server."""
@@ -23,21 +25,20 @@ class Gametype(Command):
 
     @override
     async def run(self):
-        if not Gametype.new_gametype:
-            async with Client(self.host, self.port, self.password) as client:
-                if response := await client.send_command('g_gametype'):
-                    console.out.print_cvar(response)
+        if not self.new_gametype:
+            async with Spinner('Fetching current gametype', suffix='...'):
+                async with Client(self.host, self.port, self.password) as client:
+                    response = await client.send_command('g_gametype')
+            console.out.print_cvar(response)
             return
 
-        async with Client(self.host, self.port, self.password) as client:
-            DEFAULT_FRAGMENT_READ_TIMEOUT = client.fragment_read_timeout
+        async with Spinner(f'Changing gametype to {self.new_gametype}', suffix='...'):
+            async with Client(self.host, self.port, self.password) as client:
+                await client.send_command(f'g_gametype {self.new_gametype}')
 
-            await client.send_command(f'g_gametype {self.new_gametype}')
-            if self.force:
-                async with Spinner('Forcing gametype change...'):
-                    client.fragment_read_timeout = 1
-                    await client.send_command('map_restart')
+        if self.force:
+            await Maprestart(self.host, self.port, self.password).configure_and_run()
 
-                client.fragment_read_timeout = DEFAULT_FRAGMENT_READ_TIMEOUT
-                if response := await client.send_command('g_gametype'):
-                    console.out.print_cvar(response)
+        console.out.print(
+            f'Gametype changed successfully to {self.new_gametype}.', style='green'
+        )

src/q3rcon_cli/commands/hostname.py

@@ -1,5 +1,5 @@
 from aioq3rcon import Client
-from clypi import Command, Positional, arg
+from clypi import Command, Positional, Spinner, arg
 from typing_extensions import override
 
 from q3rcon_cli import console
@@ -19,12 +19,14 @@ class Hostname(Command):
     @override
     async def run(self):
         if not self.new_hostname:
-            async with Client(self.host, self.port, self.password) as client:
-                if response := await client.send_command('sv_hostname'):
-                    console.out.print_cvar(response)
+            async with Spinner('Fetching current hostname', suffix='...'):
+                async with Client(self.host, self.port, self.password) as client:
+                    response = await client.send_command('sv_hostname')
+            console.out.print_cvar(response)
             return
 
-        async with Client(self.host, self.port, self.password) as client:
-            await client.send_command(f'sv_hostname {self.new_hostname}')
-            if response := await client.send_command('sv_hostname'):
-                console.out.print_cvar(response)
+        async with Spinner(f'Changing hostname to {self.new_hostname}', suffix='...'):
+            async with Client(self.host, self.port, self.password) as client:
+                await client.send_command(f'sv_hostname {self.new_hostname}')
+
+        console.out.print(f'Hostname changed to: {self.new_hostname}', style='green')

src/q3rcon_cli/commands/map.py

@@ -19,15 +19,25 @@ class Map(Command):
     @override
     async def run(self):
         if not self.new_map:
-            async with Client(self.host, self.port, self.password) as client:
-                if response := await client.send_command('mapname'):
-                    console.out.print_cvar(response)
+            async with Spinner('Getting current map', suffix='...'):
+                async with Client(self.host, self.port, self.password) as client:
+                    response = await client.send_command('mapname')
+            console.out.print_cvar(response)
             return
 
-        async with Spinner('Changing map...'):
+        async with Spinner('Changing map', suffix='...'):
             async with Client(
-                self.host, self.port, self.password, fragment_read_timeout=1
+                self.host,
+                self.port,
+                self.password,
+                timeout=self.timeout,
+                fragment_read_timeout=self.fragment_read_timeout,
             ) as client:
-                await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}')
-                if response := await client.send_command('mapname'):
-                    console.out.print_cvar(response)
+                await client.send_command(
+                    f'map mp_{self.new_map.removeprefix("mp_")}',
+                    interpret=self.interpret,
+                )
+
+        console.out.print(
+            f'Map changed to {self.new_map.removeprefix("mp_")}', style='green'
+        )

src/q3rcon_cli/commands/mapname.py

@@ -1,5 +1,5 @@
 from aioq3rcon import Client
-from clypi import Command, arg
+from clypi import Command, Spinner, arg
 from typing_extensions import override
 
 from q3rcon_cli import console
@@ -14,6 +14,8 @@ class Mapname(Command):
 
     @override
     async def run(self):
-        async with Client(self.host, self.port, self.password) as client:
-            if response := await client.send_command('mapname'):
-                console.out.print_cvar(response)
+        async with Spinner('Getting map name...'):
+            async with Client(self.host, self.port, self.password) as client:
+                response = await client.send_command('mapname')
+
+        console.out.print_cvar(response)

src/q3rcon_cli/commands/maprestart.py

@@ -2,7 +2,7 @@ from aioq3rcon import Client
 from clypi import Command, Spinner, arg
 from typing_extensions import override
 
-from q3rcon_cli import console
+from q3rcon_cli import config, console
 
 
 class Maprestart(Command):
@@ -12,11 +12,32 @@ class Maprestart(Command):
     port: int = arg(inherited=True)
     password: str = arg(inherited=True)
 
+    async def configure_and_run(self):
+        """Configures the command with the appropriate configuration and runs it.
+
+
+        This method is used if we invoke the maprestart command from another command (e.g. gametype),
+        since the pre_run_hook is not called in that case.
+        """
+        (
+            self.timeout,
+            self.fragment_read_timeout,
+            self.interpret,
+        ) = config.get(self.prog().split()[0].lower())
+        await self.run()
+
     @override
     async def run(self):
-        async with Spinner('Restarting map...'):
+        async with Spinner('Restarting map', suffix='...'):
             async with Client(
-                self.host, self.port, self.password, fragment_read_timeout=1
+                self.host,
+                self.port,
+                self.password,
+                timeout=self.timeout,
+                fragment_read_timeout=self.fragment_read_timeout,
             ) as client:
-                if response := await client.send_command('map_restart'):
-                    console.out.print_response(response)
+                response = await client.send_command(
+                    'map_restart', interpret=self.interpret
+                )
+
+        console.out.print_response(response)

src/q3rcon_cli/commands/maprotate.py

@@ -14,9 +14,16 @@ class Maprotate(Command):
 
     @override
     async def run(self):
-        async with Spinner('Rotating map...'):
+        async with Spinner('Rotating map', suffix='...'):
             async with Client(
-                self.host, self.port, self.password, fragment_read_timeout=1
+                self.host,
+                self.port,
+                self.password,
+                timeout=self.timeout,
+                fragment_read_timeout=self.fragment_read_timeout,
             ) as client:
-                if response := await client.send_command('map_rotate'):
-                    console.out.print_response(response)
+                response = await client.send_command(
+                    'map_rotate', interpret=self.interpret
+                )
+
+        console.out.print_response(response)

src/q3rcon_cli/commands/plugins.py

@@ -1,5 +1,5 @@
 from aioq3rcon import Client
-from clypi import Command, arg
+from clypi import Command, Spinner, arg
 from typing_extensions import override
 
 from q3rcon_cli import console
@@ -14,6 +14,8 @@ class Plugins(Command):
 
     @override
     async def run(self):
-        async with Client(self.host, self.port, self.password) as client:
-            if response := await client.send_command('plugins'):
-                console.out.print_response(response)
+        async with Spinner('Fetching plugins...'):
+            async with Client(self.host, self.port, self.password) as client:
+                response = await client.send_command('plugins')
+
+        console.out.print_response(response)

src/q3rcon_cli/commands/status.py

@@ -14,9 +14,8 @@ class Status(Command):
 
     @override
     async def run(self):
-        async with Spinner('Fetching status...'):
-            async with Client(
-                self.host, self.port, self.password, fragment_read_timeout=0.5
-            ) as client:
-                if response := await client.send_command('status'):
-                    console.out.print_status(response)
+        async with Spinner('Fetching status', suffix='...'):
+            async with Client(self.host, self.port, self.password) as client:
+                response = await client.send_command('status')
+
+        console.out.print_status(response)

src/q3rcon_cli/config.py

@@ -0,0 +1,35 @@
+from collections import UserDict
+
+
+class Config(UserDict):
+    DEFAULT_TIMEOUT: int = 2
+    DEFAULT_FRAGMENT_READ_TIMEOUT: float = 0.25
+
+    def __init__(self):
+        self.data = {
+            'status': (2, 0.25, False),
+            'fast_restart': (3, 1, True),
+            'map_restart': (3, 1, True),
+            'map': (3, 1, True),
+            'map_rotate': (3, 1, True),
+        }
+
+    def __getitem__(self, key):
+        return self.data.get(
+            key, (self.DEFAULT_TIMEOUT, self.DEFAULT_FRAGMENT_READ_TIMEOUT, False)
+        )
+
+
+_config = Config()
+
+
+def get(key: str):
+    match key:
+        case 'fast_restart' | 'fastrestart':
+            return _config['fast_restart']
+        case 'map_restart' | 'maprestart':
+            return _config['map_restart']
+        case 'map_rotate' | 'maprotate':
+            return _config['map_rotate']
+        case _:
+            return _config[key]

src/q3rcon_cli/console.py

@@ -1,7 +1,7 @@
 import re
 
 import clypi
-from clypi import cprint
+from clypi import Boxes, cprint
 
 
 class Console:
@@ -33,6 +33,8 @@ class OutConsole(Console):
         r'(?P<rate>[0-9]+)$',
         re.IGNORECASE | re.VERBOSE,
     )
+    STATUS_MAP_REGEX = re.compile(r'^map: (?P<mapname>mp_[a-z_]+)$')
+
     CVAR_REGEX = re.compile(
         r'^["](?P<name>[a-z_]+)["]\sis[:]\s'
         r'["](?P<value>.*?)["]\s'
@@ -48,9 +50,8 @@ class OutConsole(Console):
         return OutConsole.COLOUR_CODE_REGEX.sub('', s)
 
     def print_response(self, response: str):
-        response = self._remove_colour_codes(response).removeprefix('print\n')
-
-        cprint(f'\n{response}\n', fg=self.style)
+        if response := self._remove_colour_codes(response).removeprefix('print\n'):
+            cprint(response, fg=self.style)
 
     def print_status(self, response: str):
         _slots = []
@@ -69,40 +70,68 @@ class OutConsole(Console):
                 _guids.append(m.group('guid'))
                 _names.append(self._remove_colour_codes(m.group('name')))
                 _ips.append(m.group('ip'))
+            elif m := OutConsole.STATUS_MAP_REGEX.match(line):
+                cprint(f'Current map: {m.group("mapname")}', fg=self.style)
 
         if not _slots:
-            cprint('\nNo players connected.\n', fg=self.style)
+            cprint('No players connected.', fg='red')
             return
 
-        slots = clypi.boxed(_slots, title='Slot', width=10, align='center')
-        scores = clypi.boxed(_scores, title='Score', width=10, align='center')
-        pings = clypi.boxed(_pings, title='Ping', width=10, align='center')
-        guids = clypi.boxed(_guids, title='GUID', width=len(max(_guids, key=len)) + 4)
-        names = clypi.boxed(_names, title='Name', width=len(max(_names, key=len)) + 4)
-        ips = clypi.boxed(_ips, title='IP', width=len(max(_ips, key=len)) + 4)
-        print(f'\n{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}')
+        slots = clypi.boxed(
+            _slots, title='Slot', width=10, align='center', style=Boxes.ROUNDED
+        )
+        scores = clypi.boxed(
+            _scores, title='Score', width=10, align='center', style=Boxes.ROUNDED
+        )
+        pings = clypi.boxed(
+            _pings, title='Ping', width=10, align='center', style=Boxes.ROUNDED
+        )
+        guids = clypi.boxed(
+            _guids,
+            title='GUID',
+            width=len(max(_guids, key=len)) + 4,
+            style=Boxes.ROUNDED,
+        )
+        names = clypi.boxed(
+            _names,
+            title='Name',
+            width=len(max(_names, key=len)) + 4,
+            style=Boxes.ROUNDED,
+        )
+        ips = clypi.boxed(
+            _ips, title='IP', width=len(max(_ips, key=len)) + 4, style=Boxes.ROUNDED
+        )
+        print(f'{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}')
 
     def print_cvar(self, response: str):
         response = self._remove_colour_codes(response).removeprefix('print\n')
 
         if m := self.CVAR_REGEX.match(response):
             name = clypi.boxed(
-                [m.group('name')], title='Name', width=max(len(m.group('name')) + 4, 15)
+                [m.group('name')],
+                title='Name',
+                width=max(len(m.group('name')) + 4, 15),
+                style=Boxes.ROUNDED,
             )
             value = clypi.boxed(
                 [m.group('value')],
                 title='Value',
                 width=max(len(m.group('value')) + 4, 15),
+                style=Boxes.ROUNDED,
             )
             default = clypi.boxed(
                 [m.group('default')],
                 title='Default',
                 width=max(len(m.group('default')) + 4, 15),
+                style=Boxes.ROUNDED,
             )
             info = clypi.boxed(
-                [m.group('info')], title='Info', width=max(len(m.group('info')) + 4, 15)
+                [m.group('info')],
+                title='Info',
+                width=max(len(m.group('info')) + 4, 15),
+                style=Boxes.ROUNDED,
             )
-            print(f'\n{clypi.stack(name, value, default, info, padding=0)}')
+            print(f'{clypi.stack(name, value, default, info, padding=0)}')
 
 
 out = OutConsole()