@salesforce/plugin-data-code-extension

v0.1.4

Published

10 hours ago

Data Cloud Code Extension

plugin-data-code-extension

Description

This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.

We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.

Install

sf plugins install @salesforce/[email protected]

Issues

Please report any issues at https://github.com/forcedotcom/cli/issues

Contributing

Please read our Code of Conduct
Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
Fork this repository.
Build the plugin locally
Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
Edit the code in your fork.
Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
Sign CLA (see CLA below).
Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

CLA

External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone [email protected]:salesforcecli/data-code-extension

# Install the dependencies and compile
yarn && yarn build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file.
bin/dev.js data-code-extension --help

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins

Commands

`sf data-code-extension function deploy`

Deploy a Data Code Extension function package to a Salesforce org.

USAGE
  $ sf data-code-extension function deploy -n <value> --package-version <value> -d <value> -p <value> -o <value> --function-invoke-opt
    UnstructuredChunking [--flags-dir <value>] [--network <value>] [--cpu-size CPU_L|CPU_XL|CPU_2XL|CPU_4XL]

FLAGS
  -d, --description=<value>           (required) Description of the package.
  -n, --name=<value>                  (required) Name of the package to deploy.
  -o, --target-org=<value>            (required) Target Salesforce org for deployment.
  -p, --package-dir=<value>           (required) Directory containing the packaged code.
      --cpu-size=<option>             [default: CPU_2XL] CPU size for the deployment.
                                      <options: CPU_L|CPU_XL|CPU_2XL|CPU_4XL>
      --function-invoke-opt=<option>  (required) Function invocation option (function packages only).
                                      <options: UnstructuredChunking>
      --network=<value>               Network configuration for Jupyter notebooks.
      --package-version=<value>       (required) Version of the package to deploy.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Deploy a Data Code Extension function package to a Salesforce org.

  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 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 ./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 ./payload --target-org myorg --cpu-size CPU_4XL --function-invoke-opt UnstructuredChunking

FLAG DESCRIPTIONS
  -d, --description=<value>  Description of the package.

    A meaningful description of what your Data Cloud custom code package does. This helps identify the package purpose
    in your Salesforce org.

  -n, --name=<value>  Name of the package to deploy.

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

  -o, --target-org=<value>  Target Salesforce org for deployment.

    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.

  -p, --package-dir=<value>  Directory containing the packaged code.

    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.

  --cpu-size=CPU_L|CPU_XL|CPU_2XL|CPU_4XL  CPU size for the deployment.

    The CPU allocation size for your deployed package. Options are: CPU_L (small), CPU_XL (large), CPU_2XL (extra large,
    default), CPU_4XL (maximum). Higher CPU sizes provide more processing power but may have quota implications.

  --function-invoke-opt=UnstructuredChunking  Function invocation option (function packages only).

    Configuration for how functions should be invoked. UnstructuredChunking is only valid option at this point

  --network=<value>  Network configuration for Jupyter notebooks.

    Optional network configuration setting for packages that include Jupyter notebooks. Common values include 'host' for
    host network mode. Typically applies to packages with Jupyter notebook support.

  --package-version=<value>  Version of the package to deploy.

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

See code: src/commands/data-code-extension/function/deploy.ts

`sf data-code-extension function init`

Initialize the Data Code Extension function package.

USAGE
  $ sf data-code-extension function init -p <value> [--flags-dir <value>]

FLAGS
  -p, --package-dir=<value>  (required) Directory path where the package will be created.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Initialize the Data Code Extension function package.

  Initializes the Data Code Extension by checking system requirements and setting up the necessary environment.

EXAMPLES
  Initialize a function-based Data Cloud package:

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

FLAG DESCRIPTIONS
  -p, --package-dir=<value>  Directory path where the package will be created.

    The directory path where the new package will be initialized. The directory will be created if it doesn't exist.

See code: src/commands/data-code-extension/function/init.ts

`sf data-code-extension function run`

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

USAGE
  $ sf data-code-extension function run -e <value> -o <value> [--flags-dir <value>] [--config-file <value>]
  [--dependencies <value>]

FLAGS
  -e, --entrypoint=<value>    (required) Entrypoint file for the package to run.
  -o, --target-org=<value>    (required) Target Salesforce org to run against.
      --config-file=<value>   Path to a config file.
      --dependencies=<value>  Dependencies override for the run.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Run a Data Code Extension function package locally using data from your Salesforce Org.

  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 function package against the org with alias "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/payload/entrypoint.py --target-org \
      myorg --config-file ./my-function-package/payload/config.json

FLAG DESCRIPTIONS
  -e, --entrypoint=<value>  Entrypoint file for the package to run.

    The path to the entrypoint file of your initialized Data Cloud custom code package.

  -o, --target-org=<value>  Target Salesforce org to run against.

    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.

  --config-file=<value>  Path to a config file.

    Optional path to a JSON config file that provides input payload for the run. Defaults to the package's
    payload/config.json if not specified.

  --dependencies=<value>  Dependencies override for the run.

    Optional comma-separated list of Python package dependencies to use during the run, overriding those defined in the
    package's requirements.txt.

See code: src/commands/data-code-extension/function/run.ts

`sf data-code-extension function scan`

Scan the Data Code Extension function package for permissions and dependencies.

USAGE
  $ sf data-code-extension function scan [--flags-dir <value>] [-e <value>] [--config-file <value>] [-d] [-n]

FLAGS
  -d, --dry-run              Preview changes without modifying any files.
  -e, --entrypoint=<value>   Path to the entrypoint Python file to scan.
  -n, --no-requirements      Skip updating the requirements.txt file.
      --config-file=<value>  Path to an alternate config file.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Scan the Data Code Extension function package for permissions and dependencies.

  Scans Python files in an initialized Data Code Extension package directory to identify required permissions and
  dependencies. Updates the config.json and requirements.txt files based on the code analysis.

EXAMPLES
  Scan with a custom entrypoint file:

    $ 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 --entrypoint ./my-function-package/payload/entrypoint.py --dry-run

  Scan without updating the requirements.txt file:

    $ 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.

    When set, performs a scan and shows what would be changed but does not modify any files. Useful for reviewing
    changes before applying them.

  -e, --entrypoint=<value>  Path to the entrypoint Python file to scan.

    The path to the entrypoint Python file that will be analyzed. Defaults to 'payload/entrypoint.py' in the current
    directory.

  -n, --no-requirements  Skip updating the requirements.txt file.

    When set, only scans for permissions and updates config.json, but doesn't update the requirements.txt file with
    discovered dependencies.

  --config-file=<value>  Path to an alternate config file.

    Optional path to an alternate JSON config file to use instead of the package's default config. The file must exist.
    Useful for testing different configurations without modifying the package's primary config.json.

See code: src/commands/data-code-extension/function/scan.ts

`sf data-code-extension function zip`

Create a compressed archive of the Data Code Extension function package.

USAGE
  $ sf data-code-extension function zip -p <value> [--flags-dir <value>] [-n <value>]

FLAGS
  -n, --network=<value>      Network configuration, typically used for Jupyter notebook packages.
  -p, --package-dir=<value>  (required) Directory containing the initialized package to archive.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Create a compressed archive of the Data Code Extension function package.

  Creates a ZIP archive of an initialized Data Code Extension package for deployment. The archive includes all necessary
  files from the package directory while respecting .gitignore patterns and package requirements.

EXAMPLES
  Create an archive of a function package:

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

FLAG DESCRIPTIONS
  -n, --network=<value>  Network configuration, typically used for Jupyter notebook packages.

    Optional network configuration for packages that use Jupyter notebooks. Common values include 'host', 'bridge', or a
    custom network name. This flag is typically used when the package needs specific network access configurations.

  -p, --package-dir=<value>  Directory containing the initialized package to archive.

    The path to the directory containing an initialized Data Code Extension package. The directory must exist and
    contain a valid package structure with config.json.

See code: src/commands/data-code-extension/function/zip.ts

`sf data-code-extension script deploy`

Deploy a Data Code Extension script package to a Salesforce org.

USAGE
  $ sf data-code-extension script deploy -n <value> --package-version <value> -d <value> -p <value> -o <value> [--flags-dir <value>]
    [--network <value>] [--cpu-size CPU_L|CPU_XL|CPU_2XL|CPU_4XL]

FLAGS
  -d, --description=<value>      (required) Description of the package.
  -n, --name=<value>             (required) Name of the package to deploy.
  -o, --target-org=<value>       (required) Target Salesforce org for deployment.
  -p, --package-dir=<value>      (required) Directory containing the packaged code.
      --cpu-size=<option>        [default: CPU_2XL] CPU size for the deployment.
                                 <options: CPU_L|CPU_XL|CPU_2XL|CPU_4XL>
      --network=<value>          Network configuration for Jupyter notebooks.
      --package-version=<value>  (required) Version of the package to deploy.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Deploy a Data Code Extension script package to a Salesforce org.

  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 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 ./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 ./payload --target-org myorg --cpu-size CPU_4XL

FLAG DESCRIPTIONS
  -d, --description=<value>  Description of the package.

    A meaningful description of what your Data Cloud custom code package does. This helps identify the package purpose
    in your Salesforce org.

  -n, --name=<value>  Name of the package to deploy.

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

  -o, --target-org=<value>  Target Salesforce org for deployment.

    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.

  -p, --package-dir=<value>  Directory containing the packaged code.

    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.

  --cpu-size=CPU_L|CPU_XL|CPU_2XL|CPU_4XL  CPU size for the deployment.

    The CPU allocation size for your deployed package. Options are: CPU_L (small), CPU_XL (large), CPU_2XL (extra large,
    default), CPU_4XL (maximum). Higher CPU sizes provide more processing power but may have quota implications.

  --network=<value>  Network configuration for Jupyter notebooks.

    Optional network configuration setting for packages that include Jupyter notebooks. Common values include 'host' for
    host network mode. Typically applies to packages with Jupyter notebook support.

  --package-version=<value>  Version of the package to deploy.

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

See code: src/commands/data-code-extension/script/deploy.ts

`sf data-code-extension script init`

Initialize the Data Code Extension script package.

USAGE
  $ sf data-code-extension script init -p <value> [--flags-dir <value>]

FLAGS
  -p, --package-dir=<value>  (required) Directory path where the package will be created.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Initialize the Data Code Extension script package.

  Initializes the Data Code Extension by checking system requirements and setting up the necessary environment.

EXAMPLES
  Initialize a script-based Data Cloud package:

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

FLAG DESCRIPTIONS
  -p, --package-dir=<value>  Directory path where the package will be created.

    The directory path where the new package will be initialized. The directory will be created if it doesn't exist.

See code: src/commands/data-code-extension/script/init.ts

`sf data-code-extension script run`

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

USAGE
  $ sf data-code-extension script run -e <value> -o <value> [--flags-dir <value>] [--config-file <value>]
  [--dependencies <value>]

FLAGS
  -e, --entrypoint=<value>    (required) Entrypoint file for the package to run.
  -o, --target-org=<value>    (required) Target Salesforce org to run against.
      --config-file=<value>   Path to a config file.
      --dependencies=<value>  Dependencies override for the run.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Run a Data Code Extension script package locally using data from your Salesforce Org.

  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 script package against the org with alias "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/payload/entrypoint.py --target-org myorg \
      --config-file ./my-script-package/payload/config.json

FLAG DESCRIPTIONS
  -e, --entrypoint=<value>  Entrypoint file for the package to run.

    The path to the entrypoint file of your initialized Data Cloud custom code package.

  -o, --target-org=<value>  Target Salesforce org to run against.

    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.

  --config-file=<value>  Path to a config file.

    Optional path to a JSON config file that provides input payload for the run. Defaults to the package's
    payload/config.json if not specified.

  --dependencies=<value>  Dependencies override for the run.

    Optional comma-separated list of Python package dependencies to use during the run, overriding those defined in the
    package's requirements.txt.

See code: src/commands/data-code-extension/script/run.ts

`sf data-code-extension script scan`

Scan the Data Code Extension script package for permissions and dependencies.

USAGE
  $ sf data-code-extension script scan [--flags-dir <value>] [-e <value>] [--config-file <value>] [-d] [-n]

FLAGS
  -d, --dry-run              Preview changes without modifying any files.
  -e, --entrypoint=<value>   Path to the entrypoint Python file to scan.
  -n, --no-requirements      Skip updating the requirements.txt file.
      --config-file=<value>  Path to an alternate config file.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Scan the Data Code Extension script package for permissions and dependencies.

  Scans Python files in an initialized Data Code Extension package directory to identify required permissions and
  dependencies. Updates the config.json and requirements.txt files based on the code analysis.

EXAMPLES
  Scan with a custom entrypoint file:

    $ 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 --entrypoint ./my-script-package/payload/entrypoint.py --dry-run

  Scan without updating the requirements.txt file:

    $ 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.

    When set, performs a scan and shows what would be changed but does not modify any files. Useful for reviewing
    changes before applying them.

  -e, --entrypoint=<value>  Path to the entrypoint Python file to scan.

    The path to the entrypoint Python file that will be analyzed. Defaults to 'payload/entrypoint.py' in the current
    directory.

  -n, --no-requirements  Skip updating the requirements.txt file.

    When set, only scans for permissions and updates config.json, but doesn't update the requirements.txt file with
    discovered dependencies.

  --config-file=<value>  Path to an alternate config file.

    Optional path to an alternate JSON config file to use instead of the package's default config. The file must exist.
    Useful for testing different configurations without modifying the package's primary config.json.

See code: src/commands/data-code-extension/script/scan.ts

`sf data-code-extension script zip`

Create a compressed archive of the Data Code Extension script package.

USAGE
  $ sf data-code-extension script zip -p <value> [--flags-dir <value>] [-n <value>]

FLAGS
  -n, --network=<value>      Network configuration, typically used for Jupyter notebook packages.
  -p, --package-dir=<value>  (required) Directory containing the initialized package to archive.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.

DESCRIPTION
  Create a compressed archive of the Data Code Extension script package.

  Creates a ZIP archive of an initialized Data Code Extension package for deployment. The archive includes all necessary
  files from the package directory while respecting .gitignore patterns and package requirements.

EXAMPLES
  Create an archive of a script package:

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

FLAG DESCRIPTIONS
  -n, --network=<value>  Network configuration, typically used for Jupyter notebook packages.

    Optional network configuration for packages that use Jupyter notebooks. Common values include 'host', 'bridge', or a
    custom network name. This flag is typically used when the package needs specific network access configurations.

  -p, --package-dir=<value>  Directory containing the initialized package to archive.

    The path to the directory containing an initialized Data Code Extension package. The directory must exist and
    contain a valid package structure with config.json.

See code: src/commands/data-code-extension/script/zip.ts

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

plugin-data-code-extension

Description

Install

Issues

Contributing

CLA

Build

Commands

sf data-code-extension function deploy

sf data-code-extension function init

sf data-code-extension function run

sf data-code-extension function scan

sf data-code-extension function zip

sf data-code-extension script deploy

sf data-code-extension script init

sf data-code-extension script run

sf data-code-extension script scan

sf data-code-extension script zip