Skip to content

Commit 9ccd44a

Browse files
committed
docs: clarify SF CLI prerequisite requirement in README
- Added Prerequisites section stating SF CLI must be installed - Provides installation link and verification command - Clarifies difference between user prerequisites and dev dependencies - Removed @salesforce/cli from devDependencies (now user prerequisite) - Updated yarn.lock to reflect dependency changes
1 parent 9742468 commit 9ccd44a

File tree

3 files changed

+1100
-6006
lines changed

3 files changed

+1100
-6006
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.co
66

77
We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
88

9+
## Prerequisites
10+
11+
**Salesforce CLI Required**
12+
This plugin requires the Salesforce CLI to be installed and configured on your system. The SF CLI must be installed before using this plugin.
13+
14+
- Install the Salesforce CLI: https://developer.salesforce.com/tools/sfdxcli
15+
- Verify installation: `sf --version`
16+
917
## Install
1018

1119
```bash

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
},
2626
"devDependencies": {
2727
"@oclif/plugin-command-snapshot": "^5.3.3",
28-
"@salesforce/cli": "^2.96.4",
2928
"@salesforce/cli-plugins-testkit": "^5.3.39",
3029
"@salesforce/dev-scripts": "^11.0.2",
3130
"@salesforce/plugin-command-reference": "^3.1.58",

0 commit comments

Comments
 (0)