@W-21421698 Update SDK documentation for SF CLI integration#120
Merged
Conversation
|
Thanks for the contribution! It looks like @deepti-sf is an internal user so signing the CLA is not required. However, we need to confirm this. |
Fixed two documentation gaps in README.md: 1. Added missing --sf-cli-org flag to datacustomcode deploy example - The CLI supports this flag but the Quick Start example didn't show it - Added to both the example usage and CLI reference section 2. Clarified sf org login web command usage - Production login now shows --instance-url <your-instance-url> placeholder - Makes it explicit that instance-url should be provided These changes align the documentation with the actual CLI implementation and help users properly authenticate with Salesforce CLI.
joroscoSF
approved these changes
Jun 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixed two documentation gaps in README.md related to Salesforce CLI integration.
Changes
Added missing
--sf-cli-orgflag todatacustomcode deployexampleClarified
sf org login webcommand usage--instance-url <your-instance-url>placeholderTesting
datacustomcode deploy --helpshows the--sf-cli-orgflag existssf org login web --helpconfirms--instance-urlis a valid optionThese changes align the documentation with the actual CLI implementation and help users properly authenticate with Salesforce CLI.
Fixes: W-21421698