mirror of
https://github.com/onyx-and-iris/q3rcon-cli.git
synced 2026-03-23 18:29:18 +00:00
upd README
This commit is contained in:
parent
8a4b0f64b6
commit
83f5fd1cd1
49
README.md
49
README.md
@ -1,7 +1,9 @@
|
|||||||
# q3rcon-cli
|
# q3rcon-cli
|
||||||
|
|
||||||
[](https://pypi.org/project/q3rcon-cli)
|
[](https://github.com/pypa/hatch)
|
||||||
[](https://pypi.org/project/q3rcon-cli)
|
[](https://github.com/astral-sh/ruff)
|
||||||
|
[](https://pypi.org/project/q3rcon-tui)
|
||||||
|
[](https://pypi.org/project/q3rcon-tui)
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@ -12,10 +14,51 @@
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
*with uv*
|
||||||
|
|
||||||
```console
|
```console
|
||||||
pip install q3rcon-cli
|
uv tool install q3rcon-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
|
*with pipx*
|
||||||
|
|
||||||
|
```console
|
||||||
|
pipx install q3rcon-cli
|
||||||
|
```
|
||||||
|
|
||||||
|
The CLI should now be discoverable as q3rcon-cli.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
#### Flags
|
||||||
|
|
||||||
|
Pass `--host`, `--port` and `--password` as flags:
|
||||||
|
|
||||||
|
```console
|
||||||
|
q3rcon-cli --host=localhost --port=28960 --password=rconpassword
|
||||||
|
```
|
||||||
|
|
||||||
|
Additional Flags:
|
||||||
|
|
||||||
|
- `--interactive`: Boolean flag, enable REPL mode.
|
||||||
|
|
||||||
|
#### Environment Variables
|
||||||
|
|
||||||
|
example .envrc:
|
||||||
|
|
||||||
|
```env
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
export Q3RCON_CLI_HOST="localhost"
|
||||||
|
export Q3RCON_CLI_PORT="28960"
|
||||||
|
export Q3RCON_CLI_PASSWORD="<rcon password>"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Special Thanks
|
||||||
|
|
||||||
|
- [lapetus-11](https://github.com/Iapetus-11) for writing the [aio-q3-rcon](https://github.com/Iapetus-11/aio-q3-rcon) package.
|
||||||
|
- [Daniel Melchor](https://github.com/danimelchor) for creating the wonderful [clypi](https://github.com/danimelchor/clypi) library.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
`q3rcon-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
`q3rcon-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user