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
48 changes: 20 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,18 +109,18 @@ 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.
settings. Run this command from within the package directory (e.g. cd ./my-script-package).

EXAMPLES
Deploy a function package to the org with alias "myorg":

$ sf data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" \
--package-dir ./my-function-package --target-org myorg --function-invoke-opt UnstructuredChunking
--package-dir ./payload --target-org myorg --function-invoke-opt UnstructuredChunking

Deploy with a specific CPU size:

$ sf data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" \
--package-dir ./my-function-package --target-org myorg --cpu-size CPU_4XL --function-invoke-opt \
--package-dir ./payload --target-org myorg --cpu-size CPU_4XL --function-invoke-opt \
UnstructuredChunking

FLAG DESCRIPTIONS
Expand Down Expand Up @@ -188,7 +188,7 @@ DESCRIPTION
EXAMPLES
Initialize a function-based Data Cloud package:

$ sf data-code-extension function init --package-dir ./my-function-package
$ sf data-code-extension function init --package-dir ./payload

FLAG DESCRIPTIONS
-p, --package-dir=<value> Directory path where the package will be created.
Expand Down Expand Up @@ -225,11 +225,11 @@ DESCRIPTION
EXAMPLES
Run a function package against the org with alias "myorg":

$ sf data-code-extension function run --entrypoint ./my-function-package/entrypoint.py --target-org myorg
$ sf data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --target-org myorg

Run with a custom config file:

$ sf data-code-extension function run --entrypoint ./my-function-package/entrypoint.py --target-org myorg \
$ sf data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --target-org myorg \
--config-file ./my-function-package/payload/config.json

FLAG DESCRIPTIONS
Expand Down Expand Up @@ -279,21 +279,17 @@ DESCRIPTION
dependencies. Updates the config.json and requirements.txt files based on the code analysis.

EXAMPLES
Scan a function package in the current directory:

$ sf data-code-extension function scan

Scan with a custom entrypoint file:

$ sf data-code-extension function scan --entrypoint ./payload/entrypoint.py
$ sf data-code-extension function scan --entrypoint ./my-function-package/payload/entrypoint.py

Perform a dry run to see what would be changed:

$ sf data-code-extension function scan --dry-run
$ sf data-code-extension function scan --entrypoint ./my-function-package/payload/entrypoint.py --dry-run

Scan without updating the requirements.txt file:

$ sf data-code-extension function scan --no-requirements
$ sf data-code-extension function scan --entrypoint ./my-function-package/payload/entrypoint.py --no-requirements

FLAG DESCRIPTIONS
-d, --dry-run Preview changes without modifying any files.
Expand Down Expand Up @@ -343,7 +339,7 @@ DESCRIPTION
EXAMPLES
Create an archive of a function package:

$ sf data-code-extension function zip --package-dir ./my-function-package
$ sf data-code-extension function zip --package-dir ./payload/payload

FLAG DESCRIPTIONS
-n, --network=<value> Network configuration, typically used for Jupyter notebook packages.
Expand Down Expand Up @@ -386,18 +382,18 @@ 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.
settings. Run this command from within the package directory (e.g. cd ./my-script-package).

EXAMPLES
Deploy a script package to the org with alias "myorg":

$ sf data-code-extension script deploy --name my-package --package-version 1.0.0 --description "My package" \
--package-dir ./my-script-package --target-org myorg
--package-dir ./payload --target-org myorg

Deploy with a specific CPU size:

$ sf data-code-extension script deploy --name my-package --package-version 1.0.0 --description "My package" \
--package-dir ./my-script-package --target-org myorg --cpu-size CPU_4XL
--package-dir ./payload --target-org myorg --cpu-size CPU_4XL

FLAG DESCRIPTIONS
-d, --description=<value> Description of the package.
Expand Down Expand Up @@ -460,7 +456,7 @@ DESCRIPTION
EXAMPLES
Initialize a script-based Data Cloud package:

$ sf data-code-extension script init --package-dir ./my-script-package
$ sf data-code-extension script init --package-dir ./payload

FLAG DESCRIPTIONS
-p, --package-dir=<value> Directory path where the package will be created.
Expand Down Expand Up @@ -497,11 +493,11 @@ DESCRIPTION
EXAMPLES
Run a script package against the org with alias "myorg":

$ sf data-code-extension script run --entrypoint ./my-script-package/entrypoint.py --target-org myorg
$ sf data-code-extension script run --entrypoint ./my-script-package/payload/entrypoint.py --target-org myorg

Run with a custom config file:

$ sf data-code-extension script run --entrypoint ./my-script-package/entrypoint.py --target-org myorg \
$ sf data-code-extension script run --entrypoint ./my-script-package/payload/entrypoint.py --target-org myorg \
--config-file ./my-script-package/payload/config.json

FLAG DESCRIPTIONS
Expand Down Expand Up @@ -551,21 +547,17 @@ DESCRIPTION
dependencies. Updates the config.json and requirements.txt files based on the code analysis.

EXAMPLES
Scan a script package in the current directory:

$ sf data-code-extension script scan

Scan with a custom entrypoint file:

$ sf data-code-extension script scan --entrypoint ./payload/entrypoint.py
$ sf data-code-extension script scan --entrypoint ./my-script-package/payload/entrypoint.py

Perform a dry run to see what would be changed:

$ sf data-code-extension script scan --dry-run
$ sf data-code-extension script scan --entrypoint ./my-script-package/payload/entrypoint.py --dry-run

Scan without updating the requirements.txt file:

$ sf data-code-extension script scan --no-requirements
$ sf data-code-extension script scan --entrypoint ./my-script-package/payload/entrypoint.py --no-requirements

FLAG DESCRIPTIONS
-d, --dry-run Preview changes without modifying any files.
Expand Down Expand Up @@ -615,7 +607,7 @@ DESCRIPTION
EXAMPLES
Create an archive of a script package:

$ sf data-code-extension script zip --package-dir ./my-script-package
$ sf data-code-extension script zip --package-dir ./payload/payload

FLAG DESCRIPTIONS
-n, --network=<value> Network configuration, typically used for Jupyter notebook packages.
Expand Down
14 changes: 7 additions & 7 deletions messages/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,37 @@ 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.
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. Run this command from within the package directory (e.g. cd ./my-script-package).

# examples

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

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

- Deploy with a specific CPU size:

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

# examples.script

- Deploy a script package to the org with alias "myorg":

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

- Deploy with a specific CPU size:

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

# examples.function

- Deploy a function package to the org with alias "myorg":

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

- Deploy with a specific CPU size:

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

# info.checkingPython

Expand Down
8 changes: 4 additions & 4 deletions messages/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ Executes an initialized Data Cloud custom code package against a Salesforce org.

- Run a script package against the org with alias "myorg":

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

- Run with a custom config file:

<%= config.bin %> data-code-extension script run --entrypoint ./my-script-package/entrypoint.py --target-org myorg --config-file ./my-script-package/payload/config.json
<%= config.bin %> data-code-extension script run --entrypoint ./my-script-package/payload/entrypoint.py --target-org myorg --config-file ./my-script-package/payload/config.json

# examples.function

- Run a function package against the org with alias "myorg":

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

- Run with a custom config file:

<%= config.bin %> data-code-extension function run --entrypoint ./my-function-package/entrypoint.py --target-org myorg --config-file ./my-function-package/payload/config.json
<%= config.bin %> data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --target-org myorg --config-file ./my-function-package/payload/config.json

# info.checkingPython

Expand Down
20 changes: 6 additions & 14 deletions messages/scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,31 @@ Scans Python files in an initialized Data Code Extension package directory to id

# examples.script

- Scan a script package in the current directory:

<%= config.bin %> data-code-extension script scan

- Scan with a custom entrypoint file:

<%= config.bin %> data-code-extension script scan --entrypoint ./payload/entrypoint.py
<%= config.bin %> data-code-extension script scan --entrypoint ./my-script-package/payload/entrypoint.py

- Perform a dry run to see what would be changed:

<%= config.bin %> data-code-extension script scan --dry-run
<%= config.bin %> data-code-extension script scan --entrypoint ./my-script-package/payload/entrypoint.py --dry-run

- Scan without updating the requirements.txt file:

<%= config.bin %> data-code-extension script scan --no-requirements
<%= config.bin %> data-code-extension script scan --entrypoint ./my-script-package/payload/entrypoint.py --no-requirements

# examples.function

- Scan a function package in the current directory:

<%= config.bin %> data-code-extension function scan

- Scan with a custom entrypoint file:

<%= config.bin %> data-code-extension function scan --entrypoint ./payload/entrypoint.py
<%= config.bin %> data-code-extension function scan --entrypoint ./my-function-package/payload/entrypoint.py

- Perform a dry run to see what would be changed:

<%= config.bin %> data-code-extension function scan --dry-run
<%= config.bin %> data-code-extension function scan --entrypoint ./my-function-package/payload/entrypoint.py --dry-run

- Scan without updating the requirements.txt file:

<%= config.bin %> data-code-extension function scan --no-requirements
<%= config.bin %> data-code-extension function scan --entrypoint ./my-function-package/payload/entrypoint.py --no-requirements

# info.checkingPython

Expand Down
2 changes: 1 addition & 1 deletion messages/zip.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Creates a ZIP archive of an initialized Data Code Extension package for deployme

- Create an archive of a %s package:

<%= config.bin %> data-code-extension %s zip --package-dir ./my-%s-package
<%= config.bin %> data-code-extension %s zip --package-dir ./my-%s-package/payload

# info.checkingPython

Expand Down
Loading