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

Remove non-existent long-form options from README documentation

Browse Source 
- Remove --target-org, --help, --verbose and other long-form options that don't exist in wrapper scripts
- Wrapper scripts only support two-character options (-to, -hp, -ve, etc.)
- Fix Benefits section to remove reference to 'long options' that don't exist
- Ensure documentation accurately reflects actual script functionality
- All examples now correctly show only two-character options as implemented
This commit is contained in:
reynold
2025-08-28 22:40:57 +08:00
parent 067693beb2
commit c029b53ff7
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -33,24 +33,24 @@ Data and logs:
All scripts use an innovative **two-character option scheme** based on syllables, making options more memorable and self-documenting than traditional single-character flags: All scripts use an innovative **two-character option scheme** based on syllables, making options more memorable and self-documenting than traditional single-character flags:
### Core Options (consistent across scripts) ### Core Options (consistent across scripts)
- `-to, --target-org` - **T**arget **O**rg - `-to` - **T**arget **O**rg
- `-hp, --help` - **H**el**P** - `-hp` - **H**el**P**
- `-ve, --verbose` - **V**er**B**ose - `-ve` - **V**er**B**ose
### File & I/O Options ### File & I/O Options
- `-fl, --file` - **F**i**L**e - `-fl` - **F**i**L**e
- `-ot, --output` - **O**u**T**put - `-ot` - **O**u**T**put
- `-fm, --format` - **F**or**M**at - `-fm` - **F**or**M**at
### Data & Query Options ### Data & Query Options
- `-qy, --query` - **Q**uer**Y** - `-qy` - **Q**uer**Y**
- `-so, --sobject` - **S**-**O**bject - `-so` - **S**-**O**bject
- `-bk, --bulk` - **B**ul**K** - `-bk` - **B**ul**K**
### Operation & Control Options ### Operation & Control Options
- `-op, --operation` - **Op**eration - `-op` - **Op**eration
- `-wt, --wait` - **W**ai**T** - `-wt` - **W**ai**T**
- `-lv, --level` - **L**e**V**el - `-lv` - **L**e**V**el
- `-lm` - **L**i**M**its (show org limits) - `-lm` - **L**i**M**its (show org limits)
- `-ls` - **L**i**S**t (list orgs) - `-ls` - **L**i**S**t (list orgs)
@@ -58,7 +58,7 @@ All scripts use an innovative **two-character option scheme** based on syllables
- **More Memorable**: `-to` for target-org is intuitive vs cryptic `-o` - **More Memorable**: `-to` for target-org is intuitive vs cryptic `-o`
- **Self-Documenting**: Users can often guess what `-fm` means (format) - **Self-Documenting**: Users can often guess what `-fm` means (format)
- **No Conflicts**: Two characters eliminates option conflicts between scripts - **No Conflicts**: Two characters eliminates option conflicts between scripts
- **Consistent**: Same long option always maps to same short option across all scripts - **Consistent**: Same two-character option always has the same meaning across all scripts
- **Scalable**: Room for many more options without running out of meaningful combinations - **Scalable**: Room for many more options without running out of meaningful combinations
### Example Usage ### Example Usage