Skip to content

Commit 4464cff

Browse files
committed
fix: update README, remove examples
1 parent ede053d commit 4464cff

File tree

3 files changed

+26
-68
lines changed

3 files changed

+26
-68
lines changed

README.md

Lines changed: 24 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ FLAG DESCRIPTIONS
163163
of your code.
164164
```
165165

166-
_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)_
166+
_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)_
167167

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

@@ -195,7 +195,7 @@ FLAG DESCRIPTIONS
195195
The directory path where the new package will be initialized. The directory will be created if it doesn't exist.
196196
```
197197

198-
_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)_
198+
_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)_
199199

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

@@ -224,18 +224,13 @@ DESCRIPTION
224224
EXAMPLES
225225
Run a function package against the org with alias "myorg":
226226
227-
$ sf data-code-extension function run --entrypoint ./my-package --target-org myorg
227+
$ sf data-code-extension function run --entrypoint ./my-package/entrypoint.py --target-org myorg
228228
229229
Run with a custom config file:
230230
231-
$ sf data-code-extension function run --entrypoint ./my-package --target-org myorg --config-file \
231+
$ sf data-code-extension function run --entrypoint ./my-package/entrypoint.py --target-org myorg --config-file \
232232
./payload/config.json
233233
234-
Run with dependencies:
235-
236-
$ sf data-code-extension function run --entrypoint ./my-package --target-org myorg --dependencies \
237-
"pandas==2.0.0"
238-
239234
FLAG DESCRIPTIONS
240235
-e, --entrypoint=<value> Entrypoint file for the package to run.
241236
@@ -257,7 +252,7 @@ FLAG DESCRIPTIONS
257252
package's requirements.txt.
258253
```
259254

260-
_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)_
255+
_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)_
261256

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

@@ -269,7 +264,7 @@ USAGE
269264
270265
FLAGS
271266
-d, --dry-run Preview changes without modifying any files.
272-
-e, --entrypoint=<value> Path to the config.json file to update.
267+
-e, --entrypoint=<value> Path to the entrypoint Python file to scan.
273268
-n, --no-requirements Skip updating the requirements.txt file.
274269
--config-file=<value> Path to an alternate config file.
275270
@@ -289,11 +284,7 @@ EXAMPLES
289284
290285
Scan with a custom entrypoint file:
291286
292-
$ sf data-code-extension function scan --entrypoint my_script.py
293-
294-
Scan with an alternate config file:
295-
296-
$ sf data-code-extension function scan --config-file alternate-config.json
287+
$ sf data-code-extension function scan --entrypoint payload/entrypoint.py
297288
298289
Perform a dry run to see what would be changed:
299290
@@ -309,10 +300,10 @@ FLAG DESCRIPTIONS
309300
When set, performs a scan and shows what would be changed but does not modify any files. Useful for reviewing
310301
changes before applying them.
311302
312-
-e, --entrypoint=<value> Path to the config.json file to update.
303+
-e, --entrypoint=<value> Path to the entrypoint Python file to scan.
313304
314-
The path to the config.json file that will be analyzed and updated with discovered permissions. Defaults to
315-
'payload/config.json' in the current directory.
305+
The path to the entrypoint Python file that will be analyzed. Defaults to 'payload/entrypoint.py' in the current
306+
directory.
316307
317308
-n, --no-requirements Skip updating the requirements.txt file.
318309
@@ -325,7 +316,7 @@ FLAG DESCRIPTIONS
325316
Useful for testing different configurations without modifying the package's primary config.json.
326317
```
327318

328-
_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)_
319+
_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)_
329320

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

@@ -353,10 +344,6 @@ EXAMPLES
353344
354345
$ sf data-code-extension function zip --package-dir ./my-function-package
355346
356-
Create an archive with network configuration for Jupyter notebooks:
357-
358-
$ sf data-code-extension function zip --package-dir ./my-function-package --network host
359-
360347
FLAG DESCRIPTIONS
361348
-n, --network=<value> Network configuration, typically used for Jupyter notebook packages.
362349
@@ -369,7 +356,7 @@ FLAG DESCRIPTIONS
369356
contain a valid package structure with config.json.
370357
```
371358

372-
_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)_
359+
_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)_
373360

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

@@ -411,11 +398,6 @@ EXAMPLES
411398
$ sf data-code-extension script deploy --name my-package --package-version 1.0.0 --description "My package" \
412399
--package-dir ./package --target-org myorg --cpu-size CPU_4XL
413400
414-
Deploy with network configuration for Jupyter notebooks:
415-
416-
$ sf data-code-extension script deploy --name my-package --package-version 1.0.0 --description "My package" \
417-
--package-dir ./package --target-org myorg --network host
418-
419401
FLAG DESCRIPTIONS
420402
-d, --description=<value> Description of the package.
421403
@@ -453,7 +435,7 @@ FLAG DESCRIPTIONS
453435
of your code.
454436
```
455437

456-
_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)_
438+
_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)_
457439

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

@@ -485,7 +467,7 @@ FLAG DESCRIPTIONS
485467
The directory path where the new package will be initialized. The directory will be created if it doesn't exist.
486468
```
487469

488-
_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)_
470+
_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)_
489471

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

@@ -514,17 +496,13 @@ DESCRIPTION
514496
EXAMPLES
515497
Run a script package against the org with alias "myorg":
516498
517-
$ sf data-code-extension script run --entrypoint ./my-package --target-org myorg
499+
$ sf data-code-extension script run --entrypoint ./my-package/entrypoint.py --target-org myorg
518500
519501
Run with a custom config file:
520502
521-
$ sf data-code-extension script run --entrypoint ./my-package --target-org myorg --config-file \
503+
$ sf data-code-extension script run --entrypoint ./my-package/entrypoint.py --target-org myorg --config-file \
522504
./payload/config.json
523505
524-
Run with dependencies:
525-
526-
$ sf data-code-extension script run --entrypoint ./my-package --target-org myorg --dependencies "pandas==2.0.0"
527-
528506
FLAG DESCRIPTIONS
529507
-e, --entrypoint=<value> Entrypoint file for the package to run.
530508
@@ -546,7 +524,7 @@ FLAG DESCRIPTIONS
546524
package's requirements.txt.
547525
```
548526

549-
_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)_
527+
_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)_
550528

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

@@ -558,7 +536,7 @@ USAGE
558536
559537
FLAGS
560538
-d, --dry-run Preview changes without modifying any files.
561-
-e, --entrypoint=<value> Path to the config.json file to update.
539+
-e, --entrypoint=<value> Path to the entrypoint Python file to scan.
562540
-n, --no-requirements Skip updating the requirements.txt file.
563541
--config-file=<value> Path to an alternate config file.
564542
@@ -578,11 +556,7 @@ EXAMPLES
578556
579557
Scan with a custom entrypoint file:
580558
581-
$ sf data-code-extension script scan --entrypoint my_script.py
582-
583-
Scan with an alternate config file:
584-
585-
$ sf data-code-extension script scan --config-file alternate-config.json
559+
$ sf data-code-extension script scan --entrypoint payload/entrypoint.py
586560
587561
Perform a dry run to see what would be changed:
588562
@@ -598,10 +572,10 @@ FLAG DESCRIPTIONS
598572
When set, performs a scan and shows what would be changed but does not modify any files. Useful for reviewing
599573
changes before applying them.
600574
601-
-e, --entrypoint=<value> Path to the config.json file to update.
575+
-e, --entrypoint=<value> Path to the entrypoint Python file to scan.
602576
603-
The path to the config.json file that will be analyzed and updated with discovered permissions. Defaults to
604-
'payload/config.json' in the current directory.
577+
The path to the entrypoint Python file that will be analyzed. Defaults to 'payload/entrypoint.py' in the current
578+
directory.
605579
606580
-n, --no-requirements Skip updating the requirements.txt file.
607581
@@ -614,7 +588,7 @@ FLAG DESCRIPTIONS
614588
Useful for testing different configurations without modifying the package's primary config.json.
615589
```
616590

617-
_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)_
591+
_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)_
618592

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

@@ -642,10 +616,6 @@ EXAMPLES
642616
643617
$ sf data-code-extension script zip --package-dir ./my-script-package
644618
645-
Create an archive with network configuration for Jupyter notebooks:
646-
647-
$ sf data-code-extension script zip --package-dir ./my-script-package --network host
648-
649619
FLAG DESCRIPTIONS
650620
-n, --network=<value> Network configuration, typically used for Jupyter notebook packages.
651621
@@ -658,6 +628,6 @@ FLAG DESCRIPTIONS
658628
contain a valid package structure with config.json.
659629
```
660630

661-
_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)_
631+
_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)_
662632

663633
<!-- commandsstop -->

messages/deploy.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ Deploys an initialized and packaged Data Cloud code extension to a Salesforce or
1616

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

19-
- Deploy with network configuration for Jupyter notebooks:
20-
21-
<%= 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
22-
2319
# examples.script
2420

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

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

33-
- Deploy with network configuration for Jupyter notebooks:
34-
35-
<%= 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
36-
3729
# examples.function
3830

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

messages/run.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,11 @@ Executes an initialized Data Cloud custom code package against a Salesforce org.
1010

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

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

1515
- Run with a custom config file:
1616

17-
<%= config.bin %> data-code-extension %s run --entrypoint ./my-package --target-org myorg --config-file ./payload/config.json
18-
19-
- Run with dependencies:
20-
21-
<%= config.bin %> data-code-extension %s run --entrypoint ./my-package --target-org myorg --dependencies "pandas==2.0.0"
17+
<%= config.bin %> data-code-extension %s run --entrypoint ./my-package/entrypoint.py --target-org myorg --config-file ./payload/config.json
2218

2319
# info.checkingPython
2420

0 commit comments

Comments
 (0)