mirror of
https://github.com/onyx-and-iris/q3rcon-cli.git
synced 2026-03-24 02:39:18 +00:00
Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 305af813b8 | |||
| 80638762d3 | |||
| 68f917286f | |||
| 3062cfa4d8 | |||
| 03597b580f | |||
| 296b1eff3e | |||
| 26a00bff42 | |||
| 60afda97dc | |||
| 968cd2dc8a |
12
README.md
12
README.md
@ -10,6 +10,9 @@
|
|||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Use](#use)
|
||||||
|
- [Shell Completion](#shell-completion)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@ -73,6 +76,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 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
@ -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
|
## Special Thanks
|
||||||
|
|
||||||
- [lapetus-11](https://github.com/Iapetus-11) for writing the [aio-q3-rcon](https://github.com/Iapetus-11/aio-q3-rcon) package.
|
- [lapetus-11](https://github.com/Iapetus-11) for writing the [aio-q3-rcon](https://github.com/Iapetus-11/aio-q3-rcon) package.
|
||||||
|
|||||||
@ -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.5'
|
__version__ = '0.3.3'
|
||||||
|
|||||||
@ -1,9 +1,11 @@
|
|||||||
import clypi
|
import clypi
|
||||||
from aioq3rcon import Client, IncorrectPasswordError
|
from aioq3rcon import Client, IncorrectPasswordError
|
||||||
from clypi import Command, Spinner, arg
|
from clypi import Command, Spinner, arg
|
||||||
|
from clypi import parsers as cp
|
||||||
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,
|
||||||
@ -37,6 +39,7 @@ class Q3rconCli(Command):
|
|||||||
help='The host to connect to',
|
help='The host to connect to',
|
||||||
env='Q3RCON_CLI_HOST',
|
env='Q3RCON_CLI_HOST',
|
||||||
group='Connection',
|
group='Connection',
|
||||||
|
parser=cp.Str(min=1),
|
||||||
)
|
)
|
||||||
port: int = arg(
|
port: int = arg(
|
||||||
28960,
|
28960,
|
||||||
@ -44,6 +47,7 @@ class Q3rconCli(Command):
|
|||||||
help='The port to connect to',
|
help='The port to connect to',
|
||||||
env='Q3RCON_CLI_PORT',
|
env='Q3RCON_CLI_PORT',
|
||||||
group='Connection',
|
group='Connection',
|
||||||
|
parser=cp.Int(min=1, max=65535),
|
||||||
)
|
)
|
||||||
password: str = arg(
|
password: str = arg(
|
||||||
'',
|
'',
|
||||||
@ -51,15 +55,25 @@ class Q3rconCli(Command):
|
|||||||
help='The password for authentication',
|
help='The password for authentication',
|
||||||
env='Q3RCON_CLI_PASSWORD',
|
env='Q3RCON_CLI_PASSWORD',
|
||||||
group='Connection',
|
group='Connection',
|
||||||
|
parser=cp.Str(min=8),
|
||||||
)
|
)
|
||||||
interactive: bool = arg(
|
interactive: bool = arg(
|
||||||
False,
|
False,
|
||||||
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,7 +82,7 @@ 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'),
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -78,14 +92,14 @@ class Q3rconCli(Command):
|
|||||||
if command.lower() == 'q':
|
if command.lower() == 'q':
|
||||||
break
|
break
|
||||||
|
|
||||||
TIMEOUTS = {
|
CMD_CONFIG = {
|
||||||
'status': (2, 1, False),
|
'status': (2, 1, False),
|
||||||
'fast_restart': (3, 1, True),
|
'fast_restart': (3, 1, True),
|
||||||
'map_restart': (3, 1, True),
|
'map_restart': (3, 1, True),
|
||||||
'map': (3, 1, True),
|
'map': (3, 1, True),
|
||||||
'map_rotate': (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(),
|
command.split()[0].lower(),
|
||||||
(DEFAULT_TIMEOUT, DEFAULT_FRAGMENT_READ_TIMEOUT, False),
|
(DEFAULT_TIMEOUT, DEFAULT_FRAGMENT_READ_TIMEOUT, False),
|
||||||
)
|
)
|
||||||
@ -95,20 +109,20 @@ class Q3rconCli(Command):
|
|||||||
self.host,
|
self.host,
|
||||||
self.port,
|
self.port,
|
||||||
self.password,
|
self.password,
|
||||||
timeout=timeout or DEFAULT_TIMEOUT,
|
timeout=timeout,
|
||||||
fragment_read_timeout=fragment_read_timeout
|
fragment_read_timeout=fragment_read_timeout,
|
||||||
or DEFAULT_FRAGMENT_READ_TIMEOUT,
|
|
||||||
) as client:
|
) as client:
|
||||||
try:
|
try:
|
||||||
if response := await client.send_command(
|
response = await client.send_command(
|
||||||
command, interpret=interpret
|
command, interpret=interpret
|
||||||
):
|
)
|
||||||
console.out.print_response(response)
|
|
||||||
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:
|
||||||
|
|||||||
@ -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 = []
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user