10 Commits

Author SHA1 Message Date
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
d7ea4d9fad patch bump 2026-03-23 14:45:50 +00:00
d0519bb8e9 add spinners for all commands (including interactive mode).
pass send_command(interpret=True) for commands that return long responses.
note, it strips the first `"` from cvar responses which causes CVAR_REGEX to fail.
2026-03-23 14:45:35 +00:00
13 changed files with 114 additions and 72 deletions

View File

@@ -73,6 +73,7 @@ Usage: q3rcon-cli [OPTIONS] COMMAND
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ -i, --interactive Whether to start in interactive mode (defaults to false) ┃ ┃ -i, --interactive Whether to start in interactive mode (defaults to false) ┃
┃ -v, --version Show the version and exit ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Connection options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┏━ Connection options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓

View File

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

View File

@@ -1,9 +1,10 @@
import clypi import clypi
from aioq3rcon import Client, IncorrectPasswordError from aioq3rcon import Client, IncorrectPasswordError
from clypi import Command, arg from clypi import Command, Spinner, arg
from typing_extensions import override from typing_extensions import override
from . import console from . import console
from .__about__ import __version__
from .commands import ( from .commands import (
Fastrestart, Fastrestart,
Gametype, Gametype,
@@ -57,9 +58,18 @@ class Q3rconCli(Command):
short='i', short='i',
help='Whether to start in interactive mode (defaults to false)', help='Whether to start in interactive mode (defaults to false)',
) )
version: bool = arg(
False,
short='v',
help='Show the version and exit',
)
@override @override
async def run(self): async def run(self):
if self.version:
print(f'q3rcon-cli version: {clypi.style(__version__, fg="green")}')
return
if self.interactive: if self.interactive:
await self.run_interactive() await self.run_interactive()
else: else:
@@ -68,40 +78,47 @@ class Q3rconCli(Command):
async def run_interactive(self): async def run_interactive(self):
print( print(
clypi.style('Entering interactive mode. Type', fg='blue'), clypi.style('Entering interactive mode. Type', fg='blue'),
clypi.style("'Q'", fg='red'), clypi.style("'Q'", fg='yellow'),
clypi.style('to quit.', fg='blue'), clypi.style('to quit.', fg='blue'),
) )
DEFAULT_TIMEOUT = 2
DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25 DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25
while command := input(clypi.style('cmd: ', fg='green')): while command := input(clypi.style('cmd: ', fg='green')):
if command.lower() == 'q': if command.lower() == 'q':
break 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 Spinner(f"Sending command: '{command}'", suffix='...'):
async with Client( async with Client(
self.host, self.host,
self.port, self.port,
self.password, self.password,
fragment_read_timeout=fragment_read_timeout timeout=timeout,
or DEFAULT_FRAGMENT_READ_TIMEOUT, fragment_read_timeout=fragment_read_timeout,
) as client: ) as client:
try: try:
if response := await client.send_command(command): response = await client.send_command(
console.out.print_response(response) command, interpret=interpret
)
except TimeoutError: except TimeoutError:
console.err.print( console.err.print(
f"Timeout waiting for response for command: '{command}'" f"Timeout waiting for response for command: '{command}'"
) )
console.out.print_response(response)
def main(): def main():
try: try:

View File

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

View File

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

View File

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

View File

@@ -1,5 +1,5 @@
from aioq3rcon import Client from aioq3rcon import Client
from clypi import Command, Positional, Spinner, arg, cprint from clypi import Command, Positional, Spinner, arg
from typing_extensions import override from typing_extensions import override
from q3rcon_cli import console from q3rcon_cli import console
@@ -19,8 +19,9 @@ class Map(Command):
@override @override
async def run(self): async def run(self):
if not self.new_map: if not self.new_map:
async with Spinner('Getting current map', suffix='...'):
async with Client(self.host, self.port, self.password) as client: async with Client(self.host, self.port, self.password) as client:
if response := await client.send_command('mapname'): response = await client.send_command('mapname')
console.out.print_cvar(response) console.out.print_cvar(response)
return return
@@ -30,4 +31,6 @@ class Map(Command):
) as client: ) as client:
await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}') await client.send_command(f'map mp_{self.new_map.removeprefix("mp_")}')
cprint(f'Map changed to {self.new_map.removeprefix("mp_")}', fg='green') console.out.print(
f'Map changed to {self.new_map.removeprefix("mp_")}', style='green'
)

View File

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

View File

@@ -16,7 +16,8 @@ class Maprestart(Command):
async def run(self): async def run(self):
async with Spinner('Restarting map', suffix='...'): async with Spinner('Restarting map', suffix='...'):
async with Client( 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: ) as client:
if response := await client.send_command('map_restart'): response = await client.send_command('map_restart', interpret=True)
console.out.print_response(response) console.out.print_response(response)

View File

@@ -16,7 +16,12 @@ class Maprotate(Command):
async def run(self): async def run(self):
async with Spinner('Rotating map', suffix='...'): async with Spinner('Rotating map', suffix='...'):
async with Client( 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: ) as client:
if response := await client.send_command('map_rotate'): response = await client.send_command('map_rotate', interpret=True)
console.out.print_response(response) console.out.print_response(response)

View File

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

View File

@@ -16,7 +16,8 @@ class Status(Command):
async def run(self): async def run(self):
async with Spinner('Fetching status', suffix='...'): async with Spinner('Fetching status', suffix='...'):
async with Client( 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: ) as client:
if response := await client.send_command('status'): response = await client.send_command('status')
console.out.print_status(response) console.out.print_status(response)

View File

@@ -50,9 +50,8 @@ class OutConsole(Console):
return OutConsole.COLOUR_CODE_REGEX.sub('', s) return OutConsole.COLOUR_CODE_REGEX.sub('', s)
def print_response(self, response: str): def print_response(self, response: str):
response = self._remove_colour_codes(response).removeprefix('print\n') if response := self._remove_colour_codes(response).removeprefix('print\n'):
cprint(response, fg=self.style)
cprint(f'\n{response}\n', fg=self.style)
def print_status(self, response: str): def print_status(self, response: str):
_slots = [] _slots = []
@@ -72,7 +71,7 @@ class OutConsole(Console):
_names.append(self._remove_colour_codes(m.group('name'))) _names.append(self._remove_colour_codes(m.group('name')))
_ips.append(m.group('ip')) _ips.append(m.group('ip'))
elif m := OutConsole.STATUS_MAP_REGEX.match(line): elif m := OutConsole.STATUS_MAP_REGEX.match(line):
cprint(f'\nCurrent map: {m.group("mapname")}', fg=self.style) cprint(f'Current map: {m.group("mapname")}', fg=self.style)
if not _slots: if not _slots:
cprint('No players connected.', fg='red') cprint('No players connected.', fg='red')