14 Commits

Author SHA1 Message Date
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
3a7cc3eacb patch bump 2026-03-23 13:31:09 +00:00
fce5858a93 print success messages instead boxed output on cvar change 2026-03-23 13:31:03 +00:00
a9aff25c4e include map in status output
uses rounded boxes
2026-03-23 13:21:38 +00:00
7af5caad89 fix spinner suffix 2026-03-23 13:17:45 +00:00
ac5b117e2c bump aio-q3-rcon dep version
patch bump
2026-03-23 12:16:35 +00:00
4f5272ac32 patch bump 2026-03-22 10:35:41 +00:00
04c4e40063 rescale the boxed outputs 2026-03-22 10:35:23 +00:00
2233f5eda1 use workspace to add path dep 2026-03-22 05:29:40 +00:00
14 changed files with 161 additions and 93 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

@@ -20,7 +20,7 @@ classifiers = [
"Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy", "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] [project.scripts]
q3rcon-cli = "q3rcon_cli.cli:main" q3rcon-cli = "q3rcon_cli.cli:main"
@@ -34,7 +34,7 @@ Source = "https://github.com/onyx-and-iris/q3rcon-cli"
path = "src/q3rcon_cli/__about__.py" path = "src/q3rcon_cli/__about__.py"
[tool.hatch.envs.default] [tool.hatch.envs.default]
dependencies = ["aio-q3-rcon @ {root:parent:uri}/aio-q3-rcon"] workspace.members = [{ path = "../aio-q3-rcon" }]
[tool.hatch.envs.types] [tool.hatch.envs.types]
extra-dependencies = ["mypy>=1.0.0"] extra-dependencies = ["mypy>=1.0.0"]

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.1' __version__ = '0.3.0'

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,39 +78,45 @@ 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():

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

@@ -23,21 +23,24 @@ class Gametype(Command):
@override @override
async def run(self): async def run(self):
if not Gametype.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:
DEFAULT_FRAGMENT_READ_TIMEOUT = client.fragment_read_timeout
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...'): 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')
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.out.print_cvar(response) )

View File

@@ -1,5 +1,5 @@
from aioq3rcon import Client from aioq3rcon import Client
from clypi import Command, Positional, arg 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}')
if response := await client.send_command('sv_hostname'):
console.out.print_cvar(response) console.out.print(f'Hostname changed to: {self.new_hostname}', style='green')

View File

@@ -19,15 +19,18 @@ 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
async with Spinner('Changing map...'): async with Spinner('Changing map', suffix='...'):
async with Client( async with Client(
self.host, self.port, self.password, fragment_read_timeout=1 self.host, self.port, self.password, fragment_read_timeout=1
) 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_")}')
if response := await client.send_command('mapname'):
console.out.print_cvar(response) 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

@@ -14,9 +14,10 @@ class Maprestart(Command):
@override @override
async def run(self): async def run(self):
async with Spinner('Restarting map...'): 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

@@ -14,9 +14,14 @@ class Maprotate(Command):
@override @override
async def run(self): async def run(self):
async with Spinner('Rotating map...'): 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

@@ -14,9 +14,10 @@ class Status(Command):
@override @override
async def run(self): async def run(self):
async with Spinner('Fetching status...'): 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

@@ -1,7 +1,7 @@
import re import re
import clypi import clypi
from clypi import cprint from clypi import Boxes, cprint
class Console: class Console:
@@ -33,6 +33,8 @@ class OutConsole(Console):
r'(?P<rate>[0-9]+)$', r'(?P<rate>[0-9]+)$',
re.IGNORECASE | re.VERBOSE, re.IGNORECASE | re.VERBOSE,
) )
STATUS_MAP_REGEX = re.compile(r'^map: (?P<mapname>mp_[a-z_]+)$')
CVAR_REGEX = re.compile( CVAR_REGEX = re.compile(
r'^["](?P<name>[a-z_]+)["]\sis[:]\s' r'^["](?P<name>[a-z_]+)["]\sis[:]\s'
r'["](?P<value>.*?)["]\s' r'["](?P<value>.*?)["]\s'
@@ -50,7 +52,7 @@ class OutConsole(Console):
def print_response(self, response: str): def print_response(self, response: str):
response = self._remove_colour_codes(response).removeprefix('print\n') response = self._remove_colour_codes(response).removeprefix('print\n')
cprint(f'\n{response}\n', fg=self.style) cprint(response, fg=self.style)
def print_status(self, response: str): def print_status(self, response: str):
_slots = [] _slots = []
@@ -69,40 +71,68 @@ class OutConsole(Console):
_guids.append(m.group('guid')) _guids.append(m.group('guid'))
_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):
cprint(f'Current map: {m.group("mapname")}', fg=self.style)
if not _slots: if not _slots:
cprint('\nNo players connected.\n', fg=self.style) cprint('No players connected.', fg='red')
return 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)}')
def print_cvar(self, response: str): def print_cvar(self, response: str):
response = self._remove_colour_codes(response).removeprefix('print\n') response = self._remove_colour_codes(response).removeprefix('print\n')
if m := self.CVAR_REGEX.match(response): if m := self.CVAR_REGEX.match(response):
name = clypi.boxed( 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( value = clypi.boxed(
[m.group('value')], [m.group('value')],
title='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( default = clypi.boxed(
[m.group('default')], [m.group('default')],
title='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( 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() out = OutConsole()