implement Connection flag parsing

add Shell Completion section to README

patch bump

.gitignore

@@ -185,9 +185,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 
@@ -210,3 +210,5 @@ marimo/_lsp/
 __marimo__/
 
 # End of ignr
+
+test-*.py

.pre-commit-config.yaml

@@ -1,4 +1,11 @@
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
   - repo: local
     hooks:
       - id: update-readme

README.md

@@ -10,6 +10,9 @@
 ## Table of Contents
 
 - [Installation](#installation)
+- [Configuration](#configuration)
+- [Use](#use)
+- [Shell Completion](#shell-completion)
 - [License](#license)
 
 ## Installation
@@ -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.

pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dependencies = ["aio-q3-rcon>=1.0.0", "clypi>=1.8.2"]
+dependencies = ["aio-q3-rcon>=1.0.1", "clypi>=1.8.2"]
 
 [project.scripts]
 q3rcon-cli = "q3rcon_cli.cli:main"
@@ -33,6 +33,9 @@ Source = "https://github.com/onyx-and-iris/q3rcon-cli"
 [tool.hatch.version]
 path = "src/q3rcon_cli/__about__.py"
 
+[tool.hatch.envs.default]
+workspace.members = [{ path = "../aio-q3-rcon" }]
+
 [tool.hatch.envs.types]
 extra-dependencies = ["mypy>=1.0.0"]
 [tool.hatch.envs.types.scripts]

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.0'
+__version__ = '0.3.3'

src/q3rcon_cli/cli.py

@@ -1,8 +1,11 @@
 import clypi
-from aioq3rcon import Client
+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 .__about__ import __version__
 from .commands import (
     Fastrestart,
     Gametype,
@@ -14,7 +17,6 @@ from .commands import (
     Plugins,
     Status,
 )
-from .console import Console
 
 Subcommands = (
     Fastrestart
@@ -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,15 +55,25 @@ 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 run(self):
+        if self.version:
+            print(f'q3rcon-cli version: {clypi.style(__version__, fg="green")}')
+            return
+
         if self.interactive:
             await self.run_interactive()
         else:
@@ -68,44 +82,55 @@ class Q3rconCli(Command):
     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_TIMEOUT = 2
         DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25
         while command := input(clypi.style('cmd: ', fg='green')):
             if command.lower() == 'q':
                 break
 
-            fragment_read_timeout = None
+            CMD_CONFIG = {
-            if command in (
+                'status': (2, 1, False),
-                'status',
+                'fast_restart': (3, 1, True),
-                'fast_restart',
+                'map_restart': (3, 1, True),
-                'map_restart',
+                'map': (3, 1, True),
-                'map',
+                'map_rotate': (3, 1, True),
-                'map_rotate',
+            }
-            ):
+            timeout, fragment_read_timeout, interpret = CMD_CONFIG.get(
-                fragment_read_timeout = 1
+                command.split()[0].lower(),
+                (DEFAULT_TIMEOUT, DEFAULT_FRAGMENT_READ_TIMEOUT, False),
+            )
 
-            async with Client(
+            async with Spinner(f"Sending command: '{command}'", suffix='...'):
-                self.host,
+                async with Client(
-                self.port,
+                    self.host,
-                self.password,
+                    self.port,
-                fragment_read_timeout=fragment_read_timeout
+                    self.password,
-                or DEFAULT_FRAGMENT_READ_TIMEOUT,
+                    timeout=timeout,
-            ) as client:
+                    fragment_read_timeout=fragment_read_timeout,
-                try:
+                ) as client:
-                    if response := await client.send_command(command):
+                    try:
-                        Console.print_response(response)
+                        response = await client.send_command(
-                except TimeoutError:
+                            command, interpret=interpret
-                    print(
+                        )
-                        clypi.style(
+                    except TimeoutError:
-                            'Timeout waiting for response for command:', fg='red'
+                        console.err.print(
-                        ),
+                            f"Timeout waiting for response for command: '{command}'"
-                        clypi.style(command, fg='yellow'),
+                        )
-                    )
+
+            console.out.print_response(response)
 
 
 def main():
-    cli = Q3rconCli().parse()
+    try:
-    cli.start()
+        cli = Q3rconCli().parse()
+        cli.start()
+    except IncorrectPasswordError:
+        console.err.print('Incorrect password provided.')
+    except TimeoutError:
+        console.err.print(
+            f"Timeout waiting for response for command: '{type(cli.subcommand).__name__.lower()}'"
+        )

src/q3rcon_cli/commands/fastrestart.py

@@ -1,8 +1,8 @@
 from aioq3rcon import Client
-from clypi import Command, arg
+from clypi import Command, Spinner, arg
 from typing_extensions import override
 
-from q3rcon_cli.console import Console
+from q3rcon_cli import console
 
 
 class Fastrestart(Command):
@@ -14,6 +14,8 @@ class Fastrestart(Command):
 
     @override
     async def run(self):
-        async with Client(self.host, self.port, self.password) as client:
+        async with Spinner('Executing fast restart', suffix='...'):
-            if response := await client.send_command('fast_restart'):
+            async with Client(self.host, self.port, self.password) as client:
-                Console.print_response(response)
+                response = await client.send_command('fast_restart', interpret=True)
+
+        console.out.print_response(response)

src/q3rcon_cli/commands/gametype.py

@@ -2,7 +2,7 @@ from aioq3rcon import Client
 from clypi import Command, Positional, Spinner, arg
 from typing_extensions import override
 
-from q3rcon_cli.console import Console
+from q3rcon_cli import console
 
 
 class Gametype(Command):
@@ -23,21 +23,24 @@ class Gametype(Command):
 
     @override
     async def run(self):
-        if not Gametype.new_gametype:
+        if not self.new_gametype:
-            async with Client(self.host, self.port, self.password) as client:
+            async with Spinner('Fetching current gametype', suffix='...'):
-                if response := await client.send_command('g_gametype'):
+                async with Client(self.host, self.port, self.password) as client:
-                    Console.print_cvar(response)
+                    response = await client.send_command('g_gametype')
+            console.out.print_cvar(response)
             return
 
-        async with Client(self.host, self.port, self.password) as client:
+        async with Spinner(f'Changing gametype to {self.new_gametype}', suffix='...'):
-            DEFAULT_FRAGMENT_READ_TIMEOUT = client.fragment_read_timeout
+            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:
-            if self.force:
+            async with Spinner('Forcing gametype change', suffix='...'):
-                async with Spinner('Forcing gametype change...'):
+                async with Client(self.host, self.port, self.password) as client:
+                    client.timeout = 3
                     client.fragment_read_timeout = 1
                     await client.send_command('map_restart')
 
-                client.fragment_read_timeout = DEFAULT_FRAGMENT_READ_TIMEOUT
+        console.out.print(
-                if response := await client.send_command('g_gametype'):
+            f'Gametype changed successfully to {self.new_gametype}.', style='green'
-                    Console.print_cvar(response)
+        )

src/q3rcon_cli/commands/hostname.py

@@ -1,8 +1,8 @@
 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.console import Console
+from q3rcon_cli import console
 
 
 class Hostname(Command):
@@ -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:
+            async with Spinner('Fetching current hostname', suffix='...'):
-                if response := await client.send_command('sv_hostname'):
+                async with Client(self.host, self.port, self.password) as client:
-                    Console.print_cvar(response)
+                    response = await client.send_command('sv_hostname')
+            console.out.print_cvar(response)
             return
 
-        async with Client(self.host, self.port, self.password) as client:
+        async with Spinner(f'Changing hostname to {self.new_hostname}', suffix='...'):
-            await client.send_command(f'sv_hostname {self.new_hostname}')
+            async with Client(self.host, self.port, self.password) as client:
-            if response := await client.send_command('sv_hostname'):
+                await client.send_command(f'sv_hostname {self.new_hostname}')
-                Console.print_cvar(response)
+
+        console.out.print(f'Hostname changed to: {self.new_hostname}', style='green')

src/q3rcon_cli/commands/map.py

@@ -2,7 +2,7 @@ from aioq3rcon import Client
 from clypi import Command, Positional, Spinner, arg
 from typing_extensions import override
 
-from q3rcon_cli.console import Console
+from q3rcon_cli import console
 
 
 class Map(Command):
@@ -19,15 +19,18 @@ class Map(Command):
     @override
     async def run(self):
         if not self.new_map:
-            async with Client(self.host, self.port, self.password) as client:
+            async with Spinner('Getting current map', suffix='...'):
-                if response := await client.send_command('mapname'):
+                async with Client(self.host, self.port, self.password) as client:
-                    Console.print_cvar(response)
+                    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
             ) as client:
                 await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}')
-                if response := await client.send_command('mapname'):
+
-                    Console.print_cvar(response)
+        console.out.print(
+            f'Map changed to {self.new_map.removeprefix("mp_")}', style='green'
+        )

src/q3rcon_cli/commands/mapname.py

@@ -1,8 +1,8 @@
 from aioq3rcon import Client
-from clypi import Command, arg
+from clypi import Command, Spinner, arg
 from typing_extensions import override
 
-from q3rcon_cli.console import Console
+from q3rcon_cli import console
 
 
 class Mapname(Command):
@@ -14,6 +14,8 @@ class Mapname(Command):
 
     @override
     async def run(self):
-        async with Client(self.host, self.port, self.password) as client:
+        async with Spinner('Getting map name...'):
-            if response := await client.send_command('mapname'):
+            async with Client(self.host, self.port, self.password) as client:
-                Console.print_cvar(response)
+                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.console import Console
+from q3rcon_cli import console
 
 
 class Maprestart(Command):
@@ -14,9 +14,10 @@ class Maprestart(Command):
 
     @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=3, fragment_read_timeout=1
             ) as client:
-                if response := await client.send_command('map_restart'):
+                response = await client.send_command('map_restart', interpret=True)
-                    Console.print_response(response)
+
+        console.out.print_response(response)

src/q3rcon_cli/commands/maprotate.py

@@ -2,7 +2,7 @@ from aioq3rcon import Client
 from clypi import Command, Spinner, arg
 from typing_extensions import override
 
-from q3rcon_cli.console import Console
+from q3rcon_cli import console
 
 
 class Maprotate(Command):
@@ -14,9 +14,14 @@ 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=3,
+                fragment_read_timeout=1,
             ) as client:
-                if response := await client.send_command('map_rotate'):
+                response = await client.send_command('map_rotate', interpret=True)
-                    Console.print_response(response)
+
+        console.out.print_response(response)

src/q3rcon_cli/commands/plugins.py

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

src/q3rcon_cli/commands/status.py

@@ -2,7 +2,7 @@ from aioq3rcon import Client
 from clypi import Command, Spinner, arg
 from typing_extensions import override
 
-from q3rcon_cli.console import Console
+from q3rcon_cli import console
 
 
 class Status(Command):
@@ -14,9 +14,10 @@ class Status(Command):
 
     @override
     async def run(self):
-        async with Spinner('Fetching status...'):
+        async with Spinner('Fetching status', suffix='...'):
             async with Client(
-                self.host, self.port, self.password, fragment_read_timeout=0.5
+                self.host, self.port, self.password, fragment_read_timeout=1
             ) as client:
-                if response := await client.send_command('status'):
+                response = await client.send_command('status')
-                    Console.print_status(response)
+
+        console.out.print_status(response)

src/q3rcon_cli/console.py

@@ -1,10 +1,23 @@
 import re
 
 import clypi
-from clypi import cprint
+from clypi import Boxes, cprint
 
 
 class Console:
+    def __init__(self, style: str = 'yellow'):
+        self.style = style
+
+    def print(self, message: str, style: str | None = None):
+        cprint(message, fg=style or self.style)
+
+
+class ErrorConsole(Console):
+    def __init__(self):
+        super().__init__(style='red')
+
+
+class OutConsole(Console):
     COLOUR_CODE_REGEX = re.compile(r'\^[0-9]')
     STATUS_PLAYER_REGEX = re.compile(
         r'^\s*(?P<slot>[0-9]+)\s+'
@@ -20,6 +33,8 @@ class 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'
@@ -30,18 +45,15 @@ class Console:
     )
 
     @staticmethod
-    def remove_colour_codes(s: str) -> str:
+    def _remove_colour_codes(s: str) -> str:
         """Remove Quake 3 colour codes from a string."""
-        return Console.COLOUR_CODE_REGEX.sub('', s)
+        return OutConsole.COLOUR_CODE_REGEX.sub('', s)
 
-    @staticmethod
+    def print_response(self, response: str):
-    def print_response(response: str):
+        if response := self._remove_colour_codes(response).removeprefix('print\n'):
-        response = Console.remove_colour_codes(response).removeprefix('print\n')
+            cprint(response, fg=self.style)
 
-        cprint(f'\n{response}\n', fg='yellow')
+    def print_status(self, response: str):
-
-    @staticmethod
-    def print_status(response: str):
         _slots = []
         _scores = []
         _pings = []
@@ -51,45 +63,76 @@ class Console:
 
         lines = response.splitlines()
         for line in lines:
-            if m := Console.STATUS_PLAYER_REGEX.match(line):
+            if m := OutConsole.STATUS_PLAYER_REGEX.match(line):
                 _slots.append(m.group('slot'))
                 _scores.append(m.group('score'))
                 _pings.append(m.group('ping'))
                 _guids.append(m.group('guid'))
-                _names.append(m.group('name'))
+                _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='yellow')
+            cprint('No players connected.', fg='red')
             return
 
-        slots = clypi.boxed(_slots, title='Slot', width=15)
+        slots = clypi.boxed(
-        scores = clypi.boxed(_scores, title='Score', width=15)
+            _slots, title='Slot', width=10, align='center', style=Boxes.ROUNDED
-        pings = clypi.boxed(_pings, title='Ping', width=15)
+        )
-        guids = clypi.boxed(_guids, title='GUID', width=40)
+        scores = clypi.boxed(
-        names = clypi.boxed(_names, title='Name', width=30)
+            _scores, title='Score', width=10, align='center', style=Boxes.ROUNDED
-        ips = clypi.boxed(_ips, title='IP', width=30)
+        )
-        print(f'\n{clypi.stack(slots, scores, pings, guids, names, ips, padding=0)}')
+        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)}')
 
-    @staticmethod
+    def print_cvar(self, response: str):
-    def print_cvar(response: str):
+        response = self._remove_colour_codes(response).removeprefix('print\n')
-        response = Console.remove_colour_codes(response).removeprefix('print\n')
 
-        if m := Console.CVAR_REGEX.match(response):
+        if m := self.CVAR_REGEX.match(response):
             name = clypi.boxed(
-                [m.group('name')], title='Name', width=max(len(m.group('name')) + 4, 30)
+                [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, 30),
+                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, 30),
+                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, 30)
+                [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()
+err = ErrorConsole()