Salesforce/sf-cli-wrapper
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enforce strict two-character option scheme across all wrapper scripts

Browse Source 
- Removed long options from input parsing in all bash scripts
- Updated all help texts to show only two-character options
- Fixed error messages to reference short options only
- All scripts now reject long options like --help, --verbose, --target-org
- Maintained internal use of long sf CLI commands (e.g., --target-org passed to sf)
- Updated README.md documentation to reflect two-character scheme only
- Scripts affected: sf-retrieve, sf-test-run, sf-data-import, sf-data-export
- PowerShell scripts already used correct two-character parameter scheme
- All wrapper scripts now have consistent user interface

This ensures strict consistency in the two-character option scheme
while maintaining backward compatibility for the sf CLI commands themselves.
This commit is contained in:
reynold
2025-08-28 22:07:34 +08:00
parent 7aa7a7a688
commit 1ae8df8561
9 changed files with 89 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -269,7 +269,7 @@ Real-time debug logs tail with filtering, levels, and Apex-only mode.
Usage:
```bash
sf-logs-tail [-to ORG] [--user-id USER] [--level DEBUG] [--duration 60] [--filter PATTERN] [--apex-only]
sf-logs-tail [-to ORG] [-ui USER] [-lv DEBUG] [-dr 60] [-ft PATTERN] [-ax]
```
```powershell
sf-logs-tail.ps1 -TargetOrg sandbox -Level DEBUG -Duration 60 -ApexOnly -Filter "MyClass"
@@ -285,11 +285,11 @@ sf-deploy -to <ORG_ALIAS_OR_USERNAME> (-sr "<src1>,<src2>[,...]" | -dr <DIRECTOR
```
**Options:**
- `-to, --target-org` - Org alias or username for --target-org
- `-sr, --sources` - Comma-separated list of --source-dir paths
- `-dr, --directory` - Single directory path to deploy (alternative to -sr)
- `-ts, --tests` - Comma-separated list of --tests (enables --test-level RunSpecifiedTests)
- `-hp, --help` - Show help
- `-to` - Org alias or username for --target-org
- `-sr` - Comma-separated list of --source-dir paths
- `-dr` - Single directory path to deploy (alternative to -sr)
- `-ts` - Comma-separated list of --tests (enables --test-level RunSpecifiedTests)
- `-hp` - Show help
**Examples:**
```bash
@@ -316,11 +316,11 @@ sf-dry-run -to <ORG_ALIAS_OR_USERNAME> (-sr "<src1>,<src2>[,...]" | -dr <DIRECTO
```
**Options:**
- `-to, --target-org` - Org alias or username for --target-org
- `-sr, --sources` - Comma-separated list of --source-dir paths
- `-dr, --directory` - Single directory path to validate (alternative to -sr)
- `-ts, --tests` - Comma-separated list of --tests (enables --test-level RunSpecifiedTests)
- `-hp, --help` - Show help
- `-to` - Org alias or username for --target-org
- `-sr` - Comma-separated list of --source-dir paths
- `-dr` - Single directory path to validate (alternative to -sr)
- `-ts` - Comma-separated list of --tests (enables --test-level RunSpecifiedTests)
- `-hp` - Show help
**Examples:**
```bash
@@ -347,10 +347,10 @@ sf-web-open [-to <ORG_ALIAS_OR_USERNAME>] [-pt <RELATIVE_PATH>] [-ur]
```
**Options:**
- `-to, --target-org` - Org alias or username to pass as --target-org
- `-pt, --path` - Relative path to open inside the org (e.g., "/lightning/setup/SetupOneHome/home")
- `-ur, --url-only` - URL-only: print the URL instead of opening a browser (passes --url-only)
- `-hp, --help` - Show help
- `-to` - Org alias or username to pass as --target-org
- `-pt` - Relative path to open inside the org (e.g., "/lightning/setup/SetupOneHome/home")
- `-ur` - URL-only: print the URL instead of opening a browser (passes --url-only)
- `-hp` - Show help
**Examples:**
```bash
@@ -377,8 +377,8 @@ sf-check [-ve] [-hp]
```
**Options:**
- `-ve, --verbose` - Verbose output (show detailed information)
- `-hp, --help` - Show help
- `-ve` - Verbose output (show detailed information)
- `-hp` - Show help
**Examples:**
```bash