Skip to content

Commit afeea27

Browse files
committed
@W-21421698 Update SDK documentation for SF CLI integration
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.
1 parent 3adc717 commit afeea27

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ After modifying the `entrypoint.py` as needed, using any dependencies you add in
9191
```zsh
9292
cd my_package
9393
datacustomcode scan ./payload/entrypoint.py
94-
datacustomcode deploy --path ./payload --name my_custom_script --cpu-size CPU_L
94+
datacustomcode deploy --path ./payload --name my_custom_script --cpu-size CPU_L --sf-cli-org myorg
9595
```
9696
9797
> [!TIP]
@@ -320,6 +320,7 @@ Options:
320320
- `--description TEXT`: Description of the transformation job (default: "")
321321
- `--network TEXT`: docker network (default: "default")
322322
- `--cpu-size TEXT`: CPU size for the deployment (default: `CPU_2XL`). Available options: CPU_L(Large), CPU_XL(Extra Large), CPU_2XL(2X Large), CPU_4XL(4X Large)
323+
- `--sf-cli-org TEXT`: Salesforce CLI org alias or username (e.g. `myorg`). Fetches credentials via `sf org display` — no `datacustomcode configure` step needed. Takes precedence over `--profile` if both are supplied.
323324
- `--function-invoke-opt TEXT`: Currently we support only `UnstructuredChunking` for functions.
324325

325326

@@ -482,13 +483,13 @@ sf --version
482483

483484
**Browser-based (recommended for developer orgs and sandboxes):**
484485
```zsh
485-
# Production / Developer Edition
486-
sf org login web --alias myorg
486+
# Production org
487+
sf org login web --alias myorg --instance-url <your-instance-url>
487488

488489
# Sandbox
489490
sf org login web --alias mysandbox --instance-url https://test.salesforce.com
490491

491-
# Custom domain
492+
# Custom domain example
492493
sf org login web --alias myorg --instance-url https://mycompany.my.salesforce.com
493494
```
494495

0 commit comments

Comments
 (0)