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
78 changes: 24 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ FLAG DESCRIPTIONS
of your code.
```

_See code: [src/commands/data-code-extension/function/deploy.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/function/deploy.ts)_
_See code: [src/commands/data-code-extension/function/deploy.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/function/deploy.ts)_

## `sf data-code-extension function init`

Expand Down Expand Up @@ -195,7 +195,7 @@ FLAG DESCRIPTIONS
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](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/function/init.ts)_
_See code: [src/commands/data-code-extension/function/init.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/function/init.ts)_

## `sf data-code-extension function run`

Expand Down Expand Up @@ -224,18 +224,13 @@ DESCRIPTION
EXAMPLES
Run a function package against the org with alias "myorg":

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

Run with a custom config file:

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

Run with dependencies:

$ sf data-code-extension function run --entrypoint ./my-package --target-org myorg --dependencies \
"pandas==2.0.0"

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

Expand All @@ -257,7 +252,7 @@ FLAG DESCRIPTIONS
package's requirements.txt.
```

_See code: [src/commands/data-code-extension/function/run.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/function/run.ts)_
_See code: [src/commands/data-code-extension/function/run.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/function/run.ts)_

## `sf data-code-extension function scan`

Expand All @@ -269,7 +264,7 @@ USAGE

FLAGS
-d, --dry-run Preview changes without modifying any files.
-e, --entrypoint=<value> Path to the config.json file to update.
-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.

Expand All @@ -289,11 +284,7 @@ EXAMPLES

Scan with a custom entrypoint file:

$ sf data-code-extension function scan --entrypoint my_script.py

Scan with an alternate config file:

$ sf data-code-extension function scan --config-file alternate-config.json
$ sf data-code-extension function scan --entrypoint payload/entrypoint.py

Perform a dry run to see what would be changed:

Expand All @@ -309,10 +300,10 @@ FLAG DESCRIPTIONS
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 config.json file to update.
-e, --entrypoint=<value> Path to the entrypoint Python file to scan.

The path to the config.json file that will be analyzed and updated with discovered permissions. Defaults to
'payload/config.json' in the current directory.
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.

Expand All @@ -325,7 +316,7 @@ FLAG DESCRIPTIONS
Useful for testing different configurations without modifying the package's primary config.json.
```

_See code: [src/commands/data-code-extension/function/scan.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/function/scan.ts)_
_See code: [src/commands/data-code-extension/function/scan.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/function/scan.ts)_

## `sf data-code-extension function zip`

Expand Down Expand Up @@ -353,10 +344,6 @@ EXAMPLES

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

Create an archive with network configuration for Jupyter notebooks:

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

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

Expand All @@ -369,7 +356,7 @@ FLAG DESCRIPTIONS
contain a valid package structure with config.json.
```

_See code: [src/commands/data-code-extension/function/zip.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/function/zip.ts)_
_See code: [src/commands/data-code-extension/function/zip.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/function/zip.ts)_

## `sf data-code-extension script deploy`

Expand Down Expand Up @@ -411,11 +398,6 @@ EXAMPLES
$ sf 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

Deploy with network configuration for Jupyter notebooks:

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

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

Expand Down Expand Up @@ -453,7 +435,7 @@ FLAG DESCRIPTIONS
of your code.
```

_See code: [src/commands/data-code-extension/script/deploy.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/script/deploy.ts)_
_See code: [src/commands/data-code-extension/script/deploy.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/script/deploy.ts)_

## `sf data-code-extension script init`

Expand Down Expand Up @@ -485,7 +467,7 @@ FLAG DESCRIPTIONS
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](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/script/init.ts)_
_See code: [src/commands/data-code-extension/script/init.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/script/init.ts)_

## `sf data-code-extension script run`

Expand Down Expand Up @@ -514,17 +496,13 @@ DESCRIPTION
EXAMPLES
Run a script package against the org with alias "myorg":

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

Run with a custom config file:

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

Run with dependencies:

$ sf data-code-extension script run --entrypoint ./my-package --target-org myorg --dependencies "pandas==2.0.0"

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

Expand All @@ -546,7 +524,7 @@ FLAG DESCRIPTIONS
package's requirements.txt.
```

_See code: [src/commands/data-code-extension/script/run.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/script/run.ts)_
_See code: [src/commands/data-code-extension/script/run.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/script/run.ts)_

## `sf data-code-extension script scan`

Expand All @@ -558,7 +536,7 @@ USAGE

FLAGS
-d, --dry-run Preview changes without modifying any files.
-e, --entrypoint=<value> Path to the config.json file to update.
-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.

Expand All @@ -578,11 +556,7 @@ EXAMPLES

Scan with a custom entrypoint file:

$ sf data-code-extension script scan --entrypoint my_script.py

Scan with an alternate config file:

$ sf data-code-extension script scan --config-file alternate-config.json
$ sf data-code-extension script scan --entrypoint payload/entrypoint.py

Perform a dry run to see what would be changed:

Expand All @@ -598,10 +572,10 @@ FLAG DESCRIPTIONS
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 config.json file to update.
-e, --entrypoint=<value> Path to the entrypoint Python file to scan.

The path to the config.json file that will be analyzed and updated with discovered permissions. Defaults to
'payload/config.json' in the current directory.
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.

Expand All @@ -614,7 +588,7 @@ FLAG DESCRIPTIONS
Useful for testing different configurations without modifying the package's primary config.json.
```

_See code: [src/commands/data-code-extension/script/scan.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/script/scan.ts)_
_See code: [src/commands/data-code-extension/script/scan.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/script/scan.ts)_

## `sf data-code-extension script zip`

Expand Down Expand Up @@ -642,10 +616,6 @@ EXAMPLES

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

Create an archive with network configuration for Jupyter notebooks:

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

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

Expand All @@ -658,6 +628,6 @@ FLAG DESCRIPTIONS
contain a valid package structure with config.json.
```

_See code: [src/commands/data-code-extension/script/zip.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.0/src/commands/data-code-extension/script/zip.ts)_
_See code: [src/commands/data-code-extension/script/zip.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/v0.1.0/src/commands/data-code-extension/script/zip.ts)_

<!-- commandsstop -->
8 changes: 0 additions & 8 deletions messages/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ Deploys an initialized and packaged Data Cloud code extension to a Salesforce or

<%= 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 --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --network host

# examples.script

- Deploy a script package to the org with alias "myorg":
Expand All @@ -30,10 +26,6 @@ Deploys an initialized and packaged Data Cloud code extension to a Salesforce or

<%= 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

- Deploy with network configuration for Jupyter notebooks:

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

# examples.function

- Deploy a function package to the org with alias "myorg":
Expand Down
8 changes: 2 additions & 6 deletions messages/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,11 @@ Executes an initialized Data Cloud custom code package against a Salesforce org.

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

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

- Run with a custom config file:

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

- Run with dependencies:

<%= config.bin %> data-code-extension %s run --entrypoint ./my-package --target-org myorg --dependencies "pandas==2.0.0"
<%= config.bin %> data-code-extension %s run --entrypoint ./my-package/entrypoint.py --target-org myorg --config-file ./payload/config.json

# info.checkingPython

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

- Scan with a custom entrypoint file:

<%= config.bin %> data-code-extension %s scan --entrypoint my_script.py

- Scan with an alternate config file:

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

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

Expand Down Expand Up @@ -109,7 +105,7 @@ Failed to scan package at '%s': %s
- Verify the config file path is correct
- Check if you're in the right directory
- Run 'init' command first if package is not initialized
- Use default config path: payload/config.json
- Use default entrypoint path: payload/entrypoint.py

# actions.notInPackageDir

Expand Down Expand Up @@ -140,11 +136,11 @@ Optional path to an alternate JSON config file to use instead of the package's d

# flags.entrypoint.summary

Path to the config.json file to update.
Path to the entrypoint Python file to scan.

# flags.entrypoint.description

The path to the config.json file that will be analyzed and updated with discovered permissions. Defaults to 'payload/config.json' in the current directory.
The path to the entrypoint Python file that will be analyzed. Defaults to 'payload/entrypoint.py' in the current directory.

# flags.dryRun.summary

Expand Down
4 changes: 0 additions & 4 deletions messages/zip.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ Creates a ZIP archive of an initialized Data Code Extension package for deployme

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

- Create an archive with network configuration for Jupyter notebooks:

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

# info.checkingPython

Checking Python version...
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', 'function']);
public static readonly examples = messages.getMessages('examples', ['function', 'function', 'function']);

public static readonly flags = {
entrypoint: Flags.file({
Expand Down
1 change: 0 additions & 1 deletion src/commands/data-code-extension/function/scan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export default class Scan extends ScanBase {
'function',
'function',
'function',
'function',
]);

public static readonly flags = {
Expand Down
8 changes: 1 addition & 7 deletions src/commands/data-code-extension/function/zip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,7 @@ export default class Zip extends ZipBase {
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', 'function', 'function']);

public static readonly flags = {
'package-dir': Flags.directory({
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', 'script']);
public static readonly examples = messages.getMessages('examples', ['script', 'script', 'script']);

public static readonly flags = {
entrypoint: Flags.file({
Expand Down
1 change: 0 additions & 1 deletion src/commands/data-code-extension/script/scan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export default class Scan extends ScanBase {
'script',
'script',
'script',
'script',
]);

public static readonly flags = {
Expand Down
8 changes: 1 addition & 7 deletions src/commands/data-code-extension/script/zip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,7 @@ export default class Zip extends ZipBase {
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', 'script', 'script']);

public static readonly flags = {
'package-dir': Flags.directory({
Expand Down
Loading
Loading