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
12 changes: 6 additions & 6 deletions messages/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,31 @@ Deploys an initialized and packaged Data Cloud code extension to a Salesforce or

- 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 ./package --target-org 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

- 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 ./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 ./my-%s-package --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 ./package --target-org 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

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

# info.checkingPython

Expand Down
18 changes: 14 additions & 4 deletions messages/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,25 @@ Run a Data Code Extension %s 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
# examples.script

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

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

- Run with a custom config file:

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

- 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

# info.checkingPython

Expand Down
30 changes: 24 additions & 6 deletions messages/scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,41 @@ Scan the Data Code Extension %s 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
# examples.script

- Scan a %s package in the current directory:
- Scan a script package in the current directory:

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

- Scan with a custom entrypoint file:

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

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

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

- Scan without updating the requirements.txt file:

<%= config.bin %> data-code-extension %s scan --no-requirements
<%= config.bin %> data-code-extension script scan --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

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

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

- Scan without updating the requirements.txt file:

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

# info.checkingPython

Expand Down
2 changes: 1 addition & 1 deletion src/commands/data-code-extension/function/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export default class Run extends RunBase {
public static readonly state = 'beta';
public static readonly summary = messages.getMessage('summary', ['function']);
public static readonly description = messages.getMessage('description');
public static readonly examples = messages.getMessages('examples', ['function', 'function', 'function']);
public static readonly examples = messages.getMessages('examples.function');

public static readonly flags = {
entrypoint: Flags.file({
Expand Down
8 changes: 1 addition & 7 deletions src/commands/data-code-extension/function/scan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,7 @@ export default class Scan extends ScanBase {
public static readonly state = 'beta';
public static readonly summary = messages.getMessage('summary', ['function']);
public static readonly description = messages.getMessage('description');
public static readonly examples = messages.getMessages('examples', [
'function',
'function',
'function',
'function',
'function',
]);
public static readonly examples = messages.getMessages('examples.function');

public static readonly flags = {
entrypoint: Flags.string({
Expand Down
2 changes: 1 addition & 1 deletion src/commands/data-code-extension/script/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export default class Run extends RunBase {
public static readonly state = 'beta';
public static readonly summary = messages.getMessage('summary', ['script']);
public static readonly description = messages.getMessage('description');
public static readonly examples = messages.getMessages('examples', ['script', 'script', 'script']);
public static readonly examples = messages.getMessages('examples.script');

public static readonly flags = {
entrypoint: Flags.file({
Expand Down
8 changes: 1 addition & 7 deletions src/commands/data-code-extension/script/scan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,7 @@ export default class Scan extends ScanBase {
public static readonly state = 'beta';
public static readonly summary = messages.getMessage('summary', ['script']);
public static readonly description = messages.getMessage('description');
public static readonly examples = messages.getMessages('examples', [
'script',
'script',
'script',
'script',
'script',
]);
public static readonly examples = messages.getMessages('examples.script');

public static readonly flags = {
entrypoint: Flags.string({
Expand Down
Loading