docs: add shell alias section

This commit is contained in:
2026-04-01 10:05:45 +00:00
parent 20f47d6069
commit 69efafec65

View File

@@ -20,6 +20,28 @@ uvx --from git+https://gitea.arnodo.fr/Damien/gnmi-eos gnmi-eos --help
uv tool install git+https://gitea.arnodo.fr/Damien/gnmi-eos
```
## Shell Alias
To use `gnmi-eos` directly without installing it, add this alias to your shell config (`~/.bashrc`, `~/.zshrc`, etc.):
```bash
alias gnmi-eos='uvx --from git+https://gitea.arnodo.fr/Damien/gnmi-eos gnmi-eos'
```
Then reload your shell:
```bash
source ~/.zshrc # or ~/.bashrc
```
You can now use `gnmi-eos` as if it were installed:
```bash
gnmi-eos --help
gnmi-eos capabilities --target leaf1:6030
gnmi-eos subscribe --target leaf1:6030 --path "/interfaces/interface/state/counters" --mode sample
```
## CLI Usage
Credentials can be passed as options or via environment variables: