mirror of
https://github.com/onyx-and-iris/vban-cli.git
synced 2026-04-16 02:23:30 +00:00
initial commit
CLI skeletal structure implemented --version flag implemented configuration via flag+env vars implemented strip command group implemented + some subcommands custom help formatter implemented.
This commit is contained in:
56
README.md
Normal file
56
README.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# vmr-cli
|
||||
|
||||
[](https://github.com/astral-sh/uv)
|
||||
[](https://github.com/astral-sh/ruff)
|
||||
|
||||
---
|
||||
|
||||
## Install
|
||||
|
||||
#### With uv
|
||||
|
||||
```console
|
||||
uv tool install vmr-cli
|
||||
```
|
||||
|
||||
#### With pipx
|
||||
|
||||
```console
|
||||
pipx install vmr-cli
|
||||
```
|
||||
|
||||
The CLI should now be discoverable as `vmr-cli`
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
### Flags
|
||||
|
||||
```console
|
||||
vmr-cli --host=localhost --port=6980 --streamname=Command1
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
example .envrc:
|
||||
|
||||
```env
|
||||
#!/usr/bin/env bash
|
||||
|
||||
export VMR_CLI_HOST="localhost"
|
||||
export VMR_CLI_PORT=6980
|
||||
export VMR_CLI_STREAMNAME=Command1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Use
|
||||
|
||||
*To be completed*
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
`vmr-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||
Reference in New Issue
Block a user