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
This commit is contained in:
reynold
2025-08-28 22:53:35 +08:00
parent 1b553c9d2d
commit b99cdc1959

View File

@@ -401,14 +401,14 @@ Real-time debug logs tail with filtering, levels, and Apex-only mode.
**Usage:** **Usage:**
```bash ```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 ```powershell
sf-logs-tail.ps1 -TargetOrg sandbox -Level DEBUG -Duration 60 -ApexOnly -Filter "MyClass" sf-logs-tail.ps1 -TargetOrg sandbox -Level DEBUG -Duration 60 -ApexOnly -Filter "MyClass"
``` ```
**Options:** **Options:**
- `-to` - Target org username or alias - `-to` - Target org username or alias (required)
- `-ui` - Specific user ID to monitor (default: current user) - `-ui` - Specific user ID to monitor (default: current user)
- `-lv` - Log level: ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST - `-lv` - Log level: ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST
- `-dr` - How long to tail logs in minutes (default: 30) - `-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:** **Examples:**
```bash ```bash
# Tail logs for default org # Tail logs with debug level for 1 hour
sf-logs-tail sf-logs-tail -to MYORG -lv DEBUG -dr 60
# Debug level for 1 hour
sf-logs-tail -lv DEBUG -dr 60
# Filter Apex logs for specific class # Filter Apex logs for specific class
sf-logs-tail -ft "MyClass" -ax sf-logs-tail -to MYORG -ft "MyClass" -ax
# Specific org and user # Specific org and user
sf-logs-tail -to sandbox -ui USER123 sf-logs-tail -to sandbox -ui USER123