From b99cdc19591358a9557a6f2c096525d6ded291bb Mon Sep 17 00:00:00 2001 From: reynold Date: Thu, 28 Aug 2025 22:53:35 +0800 Subject: [PATCH] fix: update sf-logs-tail README to require target org parameter - Changed usage syntax to show -to as required parameter - Updated options description to mark -to as (required) - Modified examples to all include -to MYORG parameter - Removed example that didn't specify target org - Ensures consistency with script behavior when no default org exists --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9755927..28b8269 100644 --- a/README.md +++ b/README.md @@ -401,14 +401,14 @@ Real-time debug logs tail with filtering, levels, and Apex-only mode. **Usage:** ```bash -sf-logs-tail [-to ORG] [-ui USER] [-lv LEVEL] [-dr DURATION] [-ft PATTERN] [-ax] [-nc] [-ve] [-hp] +sf-logs-tail -to ORG [-ui USER] [-lv LEVEL] [-dr DURATION] [-ft PATTERN] [-ax] [-nc] [-ve] [-hp] ``` ```powershell sf-logs-tail.ps1 -TargetOrg sandbox -Level DEBUG -Duration 60 -ApexOnly -Filter "MyClass" ``` **Options:** -- `-to` - Target org username or alias +- `-to` - Target org username or alias (required) - `-ui` - Specific user ID to monitor (default: current user) - `-lv` - Log level: ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST - `-dr` - How long to tail logs in minutes (default: 30) @@ -420,14 +420,11 @@ sf-logs-tail.ps1 -TargetOrg sandbox -Level DEBUG -Duration 60 -ApexOnly -Filter **Examples:** ```bash -# Tail logs for default org -sf-logs-tail - -# Debug level for 1 hour -sf-logs-tail -lv DEBUG -dr 60 +# Tail logs with debug level for 1 hour +sf-logs-tail -to MYORG -lv DEBUG -dr 60 # Filter Apex logs for specific class -sf-logs-tail -ft "MyClass" -ax +sf-logs-tail -to MYORG -ft "MyClass" -ax # Specific org and user sf-logs-tail -to sandbox -ui USER123