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

fix: update sf-web-open README to recommend target org usage

Browse Source 
- Changed -to option description from 'optional' to 'recommended'
- Removed example that assumes default org exists
- Added new example showing custom path usage
- Maintains consistency with environment where default org may not be configured
- Aligns documentation with script behavior
This commit is contained in:
reynold
2025-08-28 23:11:55 +08:00
parent ffc933604e
commit ae7db8a851
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -508,16 +508,13 @@ sf-web-open [-to ORG] [-pt PATH] [-ur] [-hp]
``` ```
**Options:** **Options:**
- `-to` - Target org alias or username (optional, uses default if not specified) - `-to` - Target org alias or username (recommended)
- `-pt` - Relative path to open inside the org (e.g., "/lightning/setup/SetupOneHome/home") - `-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 - `-ur` - URL-only: print the URL instead of opening a browser
- `-hp` - Show help - `-hp` - Show help
**Examples:** **Examples:**
```bash ```bash
# Open the current default org
sf-web-open
# Open a specific org (default home) # Open a specific org (default home)
sf-web-open -to DEMO-ORG sf-web-open -to DEMO-ORG
@@ -526,6 +523,9 @@ sf-web-open -to NUSHUB-DR2 -pt "/lightning/setup/SetupOneHome/home"
# Get just the URL for scripting # Get just the URL for scripting
sf-web-open -to NUSHUB-DR2 -ur sf-web-open -to NUSHUB-DR2 -ur
# Open org with custom path
sf-web-open -to MYORG -pt "/lightning/setup/ObjectManager/home"
``` ```
--- ---