Skip to content

@W-21421698 Update SDK documentation for SF CLI integration#120

Merged
deepti-sf merged 1 commit into
forcedotcom:mainfrom
deepti-sf:W-21421698
Jun 26, 2026
Merged

@W-21421698 Update SDK documentation for SF CLI integration#120
deepti-sf merged 1 commit into
forcedotcom:mainfrom
deepti-sf:W-21421698

Conversation

@deepti-sf

Copy link
Copy Markdown
Collaborator

Summary

Fixed two documentation gaps in README.md related to Salesforce CLI integration.

Changes

  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
    • Also added to the CLI reference section for completeness
  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

Testing

  • Verified datacustomcode deploy --help shows the --sf-cli-org flag exists
  • Verified sf org login web --help confirms --instance-url is a valid option

These changes align the documentation with the actual CLI implementation and help users properly authenticate with Salesforce CLI.

Fixes: W-21421698

@salesforce-cla

Copy link
Copy Markdown

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.
@deepti-sf deepti-sf merged commit d9c4e12 into forcedotcom:main Jun 26, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants