Compare commits

...

9 Commits
v0.2.5 ... main

Author SHA1 Message Date
305af813b8 implement Connection flag parsing
add Shell Completion section to README

patch bump
2026-03-23 23:30:29 +00:00
80638762d3 patch bump 2026-03-23 20:45:41 +00:00
68f917286f move empty response test into {OutConsole}.print_response() 2026-03-23 20:45:28 +00:00
3062cfa4d8 patch bump 2026-03-23 20:40:13 +00:00
03597b580f don't print empty response 2026-03-23 20:39:59 +00:00
296b1eff3e minor bump 2026-03-23 20:36:21 +00:00
26a00bff42 add --version flag 2026-03-23 20:35:59 +00:00
60afda97dc defaults are dealt with by CMD_CONFIG 2026-03-23 14:53:33 +00:00
968cd2dc8a rename TIMEOUTS to CMD_CONFIG 2026-03-23 14:48:09 +00:00
4 changed files with 38 additions and 13 deletions

View File

@ -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.

View File

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

View File

@ -1,9 +1,11 @@
import clypi
from aioq3rcon import Client, IncorrectPasswordError
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,
@ -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,7 +82,7 @@ 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'),
)
@ -78,14 +92,14 @@ class Q3rconCli(Command):
if command.lower() == 'q':
break
TIMEOUTS = {
CMD_CONFIG = {
'status': (2, 1, False),
'fast_restart': (3, 1, True),
'map_restart': (3, 1, True),
'map': (3, 1, True),
'map_rotate': (3, 1, True),
}
timeout, fragment_read_timeout, interpret = TIMEOUTS.get(
timeout, fragment_read_timeout, interpret = CMD_CONFIG.get(
command.split()[0].lower(),
(DEFAULT_TIMEOUT, DEFAULT_FRAGMENT_READ_TIMEOUT, False),
)
@ -95,20 +109,20 @@ class Q3rconCli(Command):
self.host,
self.port,
self.password,
timeout=timeout or DEFAULT_TIMEOUT,
fragment_read_timeout=fragment_read_timeout
or DEFAULT_FRAGMENT_READ_TIMEOUT,
timeout=timeout,
fragment_read_timeout=fragment_read_timeout,
) as client:
try:
if response := await client.send_command(
response = await client.send_command(
command, interpret=interpret
):
console.out.print_response(response)
)
except TimeoutError:
console.err.print(
f"Timeout waiting for response for command: '{command}'"
)
console.out.print_response(response)
def main():
try:

View File

@ -50,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 = []