implement Connection flag parsing

add Shell Completion section to README

patch bump
This commit is contained in:
onyx-and-iris 2026-03-23 23:30:29 +00:00
parent 80638762d3
commit 305af813b8
3 changed files with 16 additions and 1 deletions

View File

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

View File

@ -1,6 +1,7 @@
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
@ -38,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,
@ -45,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(
'',
@ -52,6 +55,7 @@ class Q3rconCli(Command):
help='The password for authentication',
env='Q3RCON_CLI_PASSWORD',
group='Connection',
parser=cp.Str(min=8),
)
interactive: bool = arg(
False,