From 07989c87886cc07609c5087e099e0d2a5cf8dbbd Mon Sep 17 00:00:00 2001 From: Jared Vititoe Date: Thu, 5 Feb 2026 10:45:46 -0500 Subject: [PATCH] Add examples section to help documentation Expand the help output to include practical usage examples for common operations like full diagnostics, quick health checks, service monitoring, and Ceph health checks. https://code.lotusguild.org/LotusGuild/proxDoc/issues/15 Co-Authored-By: Claude Opus 4.5 --- proxDoc.sh | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/proxDoc.sh b/proxDoc.sh index 18bf2cc..2ac0178 100755 --- a/proxDoc.sh +++ b/proxDoc.sh @@ -585,6 +585,24 @@ help() { echo " --vm-list Check VM vitals" echo " --ct-list Check container vitals" echo " --backup Review backup health" + echo " --checks=LIST Run only specific checks (comma-separated)" + echo "" + echo "Examples:" + echo " Run full diagnostics:" + echo " curl -sL \"http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh\" | bash -s -- --diags" + echo "" + echo " Quick health check:" + echo " curl -sL \"http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh\" | bash -s -- --quick" + echo "" + echo " Check only services and VMs:" + echo " curl -sL \"http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh\" | bash -s -- --services" + echo " curl -sL \"http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh\" | bash -s -- --vm-list" + echo "" + echo " View drive bay mapping:" + echo " curl -sL \"http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh\" | bash -s -- --drives" + echo "" + echo " Check Ceph cluster health:" + echo " curl -sL \"http://10.10.10.63:3000/LotusGuild/proxDoc/raw/branch/main/proxDoc.sh\" | bash -s -- --ceph" exit 0 }