Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions messages/deploy.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# summary

Deploy a Data Code Extension %s package to a Salesforce org
Deploy a Data Code Extension %s package to a Salesforce org.

# description

Deploys an initialized and packaged Data Cloud code extension to a Salesforce org. The package must be initialized and zipped before deployment. Supports both script and function packages with configurable CPU resources and network settings.

# examples

- Deploy a %s package to the default org:
- Deploy a %s package to the org with alias "myorg":

<%= config.bin %> data-code-extension %s deploy --name "my-package" --version "1.0.0" --description "My package" --package-dir ./package --target-org myorg
<%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg

- Deploy with specific CPU size:
- Deploy with specific a CPU size:

<%= config.bin %> data-code-extension %s deploy --name "my-package" --version "1.0.0" --description "My package" --package-dir ./package --target-org myorg --cpu-size CPU_4XL
<%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --cpu-size CPU_4XL

- Deploy with network configuration for Jupyter notebooks:

<%= config.bin %> data-code-extension %s deploy --name "my-package" --version "1.0.0" --description "My package" --package-dir ./package --target-org myorg --network "host"
<%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --network host

# info.checkingPython

Expand Down Expand Up @@ -86,15 +86,15 @@ Name of the package to deploy.

# flags.name.description

The unique name identifier for your Data Cloud custom code package. This name will be used to identify the deployment in your Salesforce org.
The unique name identifier for your Data Cloud custom code package. This name is used to identify the deployment in your Salesforce org.

# flags.version.summary

Version of the package to deploy.

# flags.version.description

The version string for your package deployment. Use semantic versioning (e.g., 1.0.0) to track different releases of your code.
The version string for your package deployment. Use semantic versioning (such as 1.0.0) to track different releases of your code.

# flags.description.summary

Expand All @@ -118,7 +118,7 @@ Directory containing the packaged code.

# flags.packageDir.description

The path to the directory containing your initialized and zipped Data Cloud custom code package. This directory should contain the package files created by the 'zip' command.
The path to the directory containing your initialized and zipped Data Cloud custom code package. This directory contains the package files created by the 'zip' command.

# flags.cpuSize.summary

Expand All @@ -134,7 +134,7 @@ Target Salesforce org for deployment.

# flags.targetOrg.description

The alias of the Salesforce org where you want to deploy the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions.
The alias or username of the Salesforce org where you want to deploy the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions.

# flags.functionInvokeOpt.summary

Expand Down
7 changes: 3 additions & 4 deletions messages/init.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# summary

Initialize the Data Code Extension %s package
Initialize the Data Code Extension %s package.

# description

Expand Down Expand Up @@ -46,7 +46,7 @@ Package initialized successfully at '%s'

# info.fileCreated

Created: %s
Created: %s

# info.initCompleted

Expand All @@ -66,5 +66,4 @@ Directory path where the package will be created.

# flags.packageDir.description

The directory path where the new package will be initialized.
The directory will be created if it does not exist.
The directory path where the new package will be initialized. The directory will be created if it doesn't exist.
6 changes: 3 additions & 3 deletions messages/run.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# summary

Run a Data Code Extension %s package locally using data from your Salesforce Org
Run a Data Code Extension %s package locally using data from your Salesforce Org.

# description

Executes an initialized Data Cloud custom code package against a Salesforce org. The package must be initialized before running. Supports both script and function packages with optional config file and dependencies overrides.

# examples

- Run a %s package against the default org:
- Run a %s package against the org with alias "myorg":

<%= config.bin %> data-code-extension %s run --entrypoint ./my-package --target-org myorg

Expand Down Expand Up @@ -90,7 +90,7 @@ Target Salesforce org to run against.

# flags.targetOrg.description

The alias of the Salesforce org where you want to run the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions.
The alias or username of the Salesforce org where you want to run the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions.

# flags.configFile.summary

Expand Down
12 changes: 6 additions & 6 deletions messages/scan.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# summary

Scan the Data Code Extension %s package for permissions and dependencies
Scan the Data Code Extension %s package for permissions and dependencies.

# description

Expand All @@ -24,7 +24,7 @@ Scans Python files in an initialized Data Code Extension package directory to id

<%= config.bin %> data-code-extension %s scan --dry-run

- Scan without updating requirements.txt:
- Scan without updating the requirements.txt file:

<%= config.bin %> data-code-extension %s scan --no-requirements

Expand Down Expand Up @@ -62,15 +62,15 @@ Package scanned successfully in '%s'

# info.permissionFound

Permission required: %s
Permission required: %s

# info.requirementFound

Dependency found: %s
Dependency found: %s

# info.fileScanned

Scanned: %s
Scanned: %s

# info.scanCompleted

Expand Down Expand Up @@ -160,4 +160,4 @@ Skip updating the requirements.txt file.

# flags.noRequirements.description

When set, only scans for permissions and updates config.json, but does not update the requirements.txt file with discovered dependencies.
When set, only scans for permissions and updates config.json, but doesn't update the requirements.txt file with discovered dependencies.
2 changes: 1 addition & 1 deletion messages/zip.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# summary

Create a compressed archive of the Data Code Extension %s package
Create a compressed archive of the Data Code Extension %s package.

# description

Expand Down
16 changes: 9 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,15 @@
],
"topics": {
"data-code-extension": {
"description": "Commands for Data Cloud Code Extension."
},
"data-code-extension script": {
"description": "Initialize and manage script-based Data Cloud packages."
},
"data-code-extension function": {
"description": "Initialize and manage function-based Data Cloud packages."
"description": "Commands for Data Cloud Code Extension.",
"subtopics": {
"script": {
"description": "Commands to initialize and manage script-based Data Cloud packages."
},
"function": {
"description": "Commands to initialize and manage function-based Data Cloud packages."
}
}
}
},
"flexibleTaxonomy": true
Expand Down
Loading