diff --git a/README.md b/README.md index f67c1ac..7fceea5 100644 --- a/README.md +++ b/README.md @@ -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: