From 69efafec655767fea1ae0bcbef4b394b8eb893f8 Mon Sep 17 00:00:00 2001
From: Damien Arnodo <damien@noreply.localhost>
Date: Wed, 1 Apr 2026 10:05:45 +0000
Subject: [PATCH] docs: add shell alias section

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

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: