@simplysf/simply 2.7.2 → 2.9.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +805 -24
- package/package.json +15 -11
package/README.md
CHANGED
|
@@ -10,18 +10,179 @@ sf plugins install @simplysf/simply
|
|
|
10
10
|
|
|
11
11
|
## Issues
|
|
12
12
|
|
|
13
|
-
Please report any issues at https://github.com/SimplySF/simply/issues
|
|
13
|
+
Please report any issues at https://github.com/SimplySF/simply-node/issues
|
|
14
14
|
|
|
15
15
|
## Commands
|
|
16
16
|
|
|
17
17
|
<!-- commands -->
|
|
18
18
|
|
|
19
|
+
- [`sf simply apex execute`](#sf-simply-apex-execute)
|
|
20
|
+
- [`sf simply apex logs purge`](#sf-simply-apex-logs-purge)
|
|
21
|
+
- [`sf simply apex trace setup`](#sf-simply-apex-trace-setup)
|
|
22
|
+
- [`sf simply apex trace silence`](#sf-simply-apex-trace-silence)
|
|
19
23
|
- [`sf simply data file upload`](#sf-simply-data-file-upload)
|
|
20
24
|
- [`sf simply data files download`](#sf-simply-data-files-download)
|
|
21
25
|
- [`sf simply data files upload`](#sf-simply-data-files-upload)
|
|
26
|
+
- [`sf simply document diff`](#sf-simply-document-diff)
|
|
27
|
+
- [`sf simply document generate`](#sf-simply-document-generate)
|
|
22
28
|
- [`sf simply package dependencies install`](#sf-simply-package-dependencies-install)
|
|
23
29
|
- [`sf simply package dependencies manage`](#sf-simply-package-dependencies-manage)
|
|
24
30
|
- [`sf simply package version cleanup`](#sf-simply-package-version-cleanup)
|
|
31
|
+
- [`sf simply permissions analyze`](#sf-simply-permissions-analyze)
|
|
32
|
+
- [`sf simply permissions build`](#sf-simply-permissions-build)
|
|
33
|
+
- [`sf simply project update api-version`](#sf-simply-project-update-api-version)
|
|
34
|
+
- [`sf simply schema generate`](#sf-simply-schema-generate)
|
|
35
|
+
- [`sf simply schema visualize`](#sf-simply-schema-visualize)
|
|
36
|
+
- [`sf simply sobject backup`](#sf-simply-sobject-backup)
|
|
37
|
+
- [`sf simply sobject deduplicate`](#sf-simply-sobject-deduplicate)
|
|
38
|
+
- [`sf simply sobject history export`](#sf-simply-sobject-history-export)
|
|
39
|
+
- [`sf simply sobject history query`](#sf-simply-sobject-history-query)
|
|
40
|
+
- [`sf simply sobject history schema`](#sf-simply-sobject-history-schema)
|
|
41
|
+
|
|
42
|
+
## `sf simply apex execute`
|
|
43
|
+
|
|
44
|
+
Execute anonymous Apex code.
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
USAGE
|
|
48
|
+
$ sf simply apex execute -f <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
49
|
+
|
|
50
|
+
FLAGS
|
|
51
|
+
-f, --file=<value> (required) Path to Apex file
|
|
52
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
53
|
+
configuration variable is already set.
|
|
54
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
55
|
+
|
|
56
|
+
GLOBAL FLAGS
|
|
57
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
58
|
+
--json Format output as json.
|
|
59
|
+
|
|
60
|
+
DESCRIPTION
|
|
61
|
+
Execute anonymous Apex code.
|
|
62
|
+
|
|
63
|
+
Executes an anonymous block of Apex code from a local .apex file against a target org and reports the compile and
|
|
64
|
+
execution results, including any debug logs produced.
|
|
65
|
+
|
|
66
|
+
EXAMPLES
|
|
67
|
+
$ sf simply apex execute --target-org myOrg --file scripts/apex/data-fix.apex
|
|
68
|
+
|
|
69
|
+
FLAG DESCRIPTIONS
|
|
70
|
+
-f, --file=<value> Path to Apex file
|
|
71
|
+
|
|
72
|
+
The path to the local .apex file containing the anonymous Apex code to execute.
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
_See code: [@simplysf/simply-apex](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-apex@1.1.10/packages/simply-apex/lib/commands/simply/apex/execute.js)_
|
|
76
|
+
|
|
77
|
+
## `sf simply apex logs purge`
|
|
78
|
+
|
|
79
|
+
Purge Apex debug logs.
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
USAGE
|
|
83
|
+
$ sf simply apex logs purge -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>]
|
|
84
|
+
|
|
85
|
+
FLAGS
|
|
86
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
87
|
+
configuration variable is already set.
|
|
88
|
+
-w, --where=<value> SOQL WHERE clause
|
|
89
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
90
|
+
|
|
91
|
+
GLOBAL FLAGS
|
|
92
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
93
|
+
--json Format output as json.
|
|
94
|
+
|
|
95
|
+
DESCRIPTION
|
|
96
|
+
Purge Apex debug logs.
|
|
97
|
+
|
|
98
|
+
Deletes ApexLog records from the target org. By default all logs are purged; use --where to scope the deletion to a
|
|
99
|
+
subset of logs.
|
|
100
|
+
|
|
101
|
+
EXAMPLES
|
|
102
|
+
$ sf simply apex logs purge --target-org myOrg
|
|
103
|
+
|
|
104
|
+
$ sf simply apex logs purge --target-org myOrg --where "Status = 'Success'"
|
|
105
|
+
|
|
106
|
+
FLAG DESCRIPTIONS
|
|
107
|
+
-w, --where=<value> SOQL WHERE clause
|
|
108
|
+
|
|
109
|
+
A WHERE clause used to filter which ApexLog records are purged (e.g. "Status = 'Success'").
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
_See code: [@simplysf/simply-apex](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-apex@1.1.10/packages/simply-apex/lib/commands/simply/apex/logs/purge.js)_
|
|
113
|
+
|
|
114
|
+
## `sf simply apex trace setup`
|
|
115
|
+
|
|
116
|
+
Configure a debug log trace flag for the current user.
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
USAGE
|
|
120
|
+
$ sf simply apex trace setup -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
121
|
+
|
|
122
|
+
FLAGS
|
|
123
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
124
|
+
configuration variable is already set.
|
|
125
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
126
|
+
|
|
127
|
+
GLOBAL FLAGS
|
|
128
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
129
|
+
--json Format output as json.
|
|
130
|
+
|
|
131
|
+
DESCRIPTION
|
|
132
|
+
Configure a debug log trace flag for the current user.
|
|
133
|
+
|
|
134
|
+
Creates or updates a 24-hour DEVELOPER_LOG trace flag for the user running the command, using a FINEST/FINER debug
|
|
135
|
+
level suitable for the Apex Replay Debugger.
|
|
136
|
+
|
|
137
|
+
EXAMPLES
|
|
138
|
+
$ sf simply apex trace setup --target-org myOrg
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
_See code: [@simplysf/simply-apex](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-apex@1.1.10/packages/simply-apex/lib/commands/simply/apex/trace/setup.js)_
|
|
142
|
+
|
|
143
|
+
## `sf simply apex trace silence`
|
|
144
|
+
|
|
145
|
+
Silence debug logs for specific Apex classes.
|
|
146
|
+
|
|
147
|
+
```
|
|
148
|
+
USAGE
|
|
149
|
+
$ sf simply apex trace silence -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-c <value> | --classes-file
|
|
150
|
+
<value>]
|
|
151
|
+
|
|
152
|
+
FLAGS
|
|
153
|
+
-c, --classes=<value> Comma-separated Apex class names
|
|
154
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
155
|
+
configuration variable is already set.
|
|
156
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
157
|
+
--classes-file=<value> Path to a JSON file listing classes to silence
|
|
158
|
+
|
|
159
|
+
GLOBAL FLAGS
|
|
160
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
161
|
+
--json Format output as json.
|
|
162
|
+
|
|
163
|
+
DESCRIPTION
|
|
164
|
+
Silence debug logs for specific Apex classes.
|
|
165
|
+
|
|
166
|
+
Creates a 24-hour CLASS_TRACING trace flag with a fully suppressed (NONE) debug level for each specified Apex class,
|
|
167
|
+
preventing those classes from generating debug log output.
|
|
168
|
+
|
|
169
|
+
EXAMPLES
|
|
170
|
+
$ sf simply apex trace silence --target-org myOrg --classes NoisyClass,ChattyTrigger
|
|
171
|
+
|
|
172
|
+
$ sf simply apex trace silence --target-org myOrg --classes-file classesToSilence.json
|
|
173
|
+
|
|
174
|
+
FLAG DESCRIPTIONS
|
|
175
|
+
-c, --classes=<value> Comma-separated Apex class names
|
|
176
|
+
|
|
177
|
+
A comma-separated list of Apex class names to silence.
|
|
178
|
+
|
|
179
|
+
--classes-file=<value> Path to a JSON file listing classes to silence
|
|
180
|
+
|
|
181
|
+
The path to a JSON file with the shape { "classes": ["ClassOne", "ClassTwo"] } listing the Apex class names to
|
|
182
|
+
silence.
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
_See code: [@simplysf/simply-apex](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-apex@1.1.10/packages/simply-apex/lib/commands/simply/apex/trace/silence.js)_
|
|
25
186
|
|
|
26
187
|
## `sf simply data file upload`
|
|
27
188
|
|
|
@@ -55,7 +216,7 @@ EXAMPLES
|
|
|
55
216
|
$ sf simply data file upload --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
|
|
56
217
|
```
|
|
57
218
|
|
|
58
|
-
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply/blob/@simplysf/simply-data@2.
|
|
219
|
+
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-data@2.3.9/packages/simply-data/lib/commands/simply/data/file/upload.js)_
|
|
59
220
|
|
|
60
221
|
## `sf simply data files download`
|
|
61
222
|
|
|
@@ -100,7 +261,7 @@ FLAG DESCRIPTIONS
|
|
|
100
261
|
Provide a WHERE clause to allow the plugin to specify which ContentVersion records should be downloaded.
|
|
101
262
|
```
|
|
102
263
|
|
|
103
|
-
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply/blob/@simplysf/simply-data@2.
|
|
264
|
+
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-data@2.3.9/packages/simply-data/lib/commands/simply/data/files/download.js)_
|
|
104
265
|
|
|
105
266
|
## `sf simply data files upload`
|
|
106
267
|
|
|
@@ -145,7 +306,106 @@ FLAG DESCRIPTIONS
|
|
|
145
306
|
quasi concurrent uploads. Please note that setting this value too high can cause performance issues.
|
|
146
307
|
```
|
|
147
308
|
|
|
148
|
-
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply/blob/@simplysf/simply-data@2.
|
|
309
|
+
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-data@2.3.9/packages/simply-data/lib/commands/simply/data/files/upload.js)_
|
|
310
|
+
|
|
311
|
+
## `sf simply document diff`
|
|
312
|
+
|
|
313
|
+
Generate a change report between two git refs.
|
|
314
|
+
|
|
315
|
+
```
|
|
316
|
+
USAGE
|
|
317
|
+
$ sf simply document diff --from-tag <value> --to-tag <value> [--json] [--flags-dir <value>] [--output-file <value>]
|
|
318
|
+
[--template-file <value>] [--output-format html]
|
|
319
|
+
|
|
320
|
+
FLAGS
|
|
321
|
+
--from-tag=<value> (required) The starting git ref for the diff report.
|
|
322
|
+
--output-file=<value> Path to write the generated report to.
|
|
323
|
+
--output-format=<option> [default: html] Output format to render the report in.
|
|
324
|
+
<options: html>
|
|
325
|
+
--template-file=<value> Path to a custom Handlebars template to render instead of the built-in one.
|
|
326
|
+
--to-tag=<value> (required) The ending git ref for the diff report.
|
|
327
|
+
|
|
328
|
+
GLOBAL FLAGS
|
|
329
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
330
|
+
--json Format output as json.
|
|
331
|
+
|
|
332
|
+
DESCRIPTION
|
|
333
|
+
Generate a change report between two git refs.
|
|
334
|
+
|
|
335
|
+
Runs `git diff --name-status` between two git refs (tags, branches, or commits) in the current working directory,
|
|
336
|
+
groups the changed files by Salesforce metadata component type, and renders a Confluence-storage-format change report
|
|
337
|
+
suitable for pasting into a release or change-management page.
|
|
338
|
+
|
|
339
|
+
EXAMPLES
|
|
340
|
+
$ sf simply document diff --from-tag v1.0.0 --to-tag v1.1.0
|
|
341
|
+
|
|
342
|
+
$ sf simply document diff --from-tag v1.0.0 --to-tag v1.1.0 --output-file change-report.html
|
|
343
|
+
|
|
344
|
+
$ sf simply document diff --from-tag v1.0.0 --to-tag v1.1.0 --template-file my-change-report.hbs
|
|
345
|
+
|
|
346
|
+
FLAG DESCRIPTIONS
|
|
347
|
+
--output-file=<value> Path to write the generated report to.
|
|
348
|
+
|
|
349
|
+
When specified, the generated report is written to this path instead of being printed to the terminal.
|
|
350
|
+
|
|
351
|
+
--output-format=html Output format to render the report in.
|
|
352
|
+
|
|
353
|
+
Currently only `html` is supported. Reserved for future formats (e.g. Markdown).
|
|
354
|
+
|
|
355
|
+
--template-file=<value> Path to a custom Handlebars template to render instead of the built-in one.
|
|
356
|
+
|
|
357
|
+
When specified, this template is rendered with the same data the built-in report template receives, and can reuse
|
|
358
|
+
the built-in `changeTable` partial. See this package's README "Custom Templates" section for the data shape and
|
|
359
|
+
available partials.
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
_See code: [@simplysf/simply-document](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-document@0.2.0/packages/simply-document/lib/commands/simply/document/diff.js)_
|
|
363
|
+
|
|
364
|
+
## `sf simply document generate`
|
|
365
|
+
|
|
366
|
+
Generate a technical design document for a Salesforce project.
|
|
367
|
+
|
|
368
|
+
```
|
|
369
|
+
USAGE
|
|
370
|
+
$ sf simply document generate -d <value> --output-file <value> [--json] [--flags-dir <value>] [--template-file <value>]
|
|
371
|
+
[--output-format html]
|
|
372
|
+
|
|
373
|
+
FLAGS
|
|
374
|
+
-d, --directory=<value> (required) Salesforce project source directory to scan.
|
|
375
|
+
--output-file=<value> (required) Path to write the generated document to.
|
|
376
|
+
--output-format=<option> [default: html] Output format to render the document in.
|
|
377
|
+
<options: html>
|
|
378
|
+
--template-file=<value> Path to a custom Handlebars template to render instead of the built-in one.
|
|
379
|
+
|
|
380
|
+
GLOBAL FLAGS
|
|
381
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
382
|
+
--json Format output as json.
|
|
383
|
+
|
|
384
|
+
DESCRIPTION
|
|
385
|
+
Generate a technical design document for a Salesforce project.
|
|
386
|
+
|
|
387
|
+
Scans a Salesforce DX project's source directory for metadata (objects, fields, Apex, Lightning components, flows,
|
|
388
|
+
permissions, and more) and renders a Confluence-storage-format technical design document covering the data model,
|
|
389
|
+
security model, groups/queues/permissions, solution inventory, and custom code inventory.
|
|
390
|
+
|
|
391
|
+
EXAMPLES
|
|
392
|
+
$ sf simply document generate --directory force-app --output-file technical-design-document.html
|
|
393
|
+
|
|
394
|
+
$ sf simply document generate --directory force-app --output-file technical-design-document.html --template-file my-tdd-template.hbs
|
|
395
|
+
|
|
396
|
+
FLAG DESCRIPTIONS
|
|
397
|
+
--output-format=html Output format to render the document in.
|
|
398
|
+
|
|
399
|
+
Currently only `html` is supported. Reserved for future formats (e.g. Markdown).
|
|
400
|
+
|
|
401
|
+
--template-file=<value> Path to a custom Handlebars template to render instead of the built-in one.
|
|
402
|
+
|
|
403
|
+
When specified, this template is rendered with the same scanned project data the built-in technical design document
|
|
404
|
+
template receives, and can reuse the built-in `loud` helper. See this package's README "Custom Templates" section
|
|
405
|
+
for the data shape.
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
_See code: [@simplysf/simply-document](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-document@0.2.0/packages/simply-document/lib/commands/simply/document/generate.js)_
|
|
149
409
|
|
|
150
410
|
## `sf simply package dependencies install`
|
|
151
411
|
|
|
@@ -154,8 +414,8 @@ Install package dependencies for a Salesforce project.
|
|
|
154
414
|
```
|
|
155
415
|
USAGE
|
|
156
416
|
$ sf simply package dependencies install -o <value> [--json] [--flags-dir <value>] [-a all|package] [--api-version <value>] [-z
|
|
157
|
-
<value>] [-i All|Delta] [-k <value>...] [-r] [-
|
|
158
|
-
DeprecateOnly|Mixed|Delete] [-w <value>]
|
|
417
|
+
<value>] [-i All|Delta|Upgrade] [-k <value>...] [-r] [--output-file <value>] [-b <value>] [-s AllUsers|AdminsOnly]
|
|
418
|
+
[-v <value>] [-t DeprecateOnly|Mixed|Delete] [-w <value>]
|
|
159
419
|
|
|
160
420
|
FLAGS
|
|
161
421
|
-a, --apex-compile=<option> Compile all Apex in the org and package, or only Apex in the package; unlocked
|
|
@@ -163,8 +423,8 @@ FLAGS
|
|
|
163
423
|
<options: all|package>
|
|
164
424
|
-b, --publish-wait=<value> Maximum number of minutes to wait for the Subscriber Package Version ID to become
|
|
165
425
|
available in the target org before canceling the install request.
|
|
166
|
-
-i, --install-type=<option> [default:
|
|
167
|
-
<options: All|Delta>
|
|
426
|
+
-i, --install-type=<option> [default: Upgrade] Install all packages, only deltas, or only newer versions.
|
|
427
|
+
<options: All|Delta|Upgrade>
|
|
168
428
|
-k, --installation-key=<value>... Installation key for key-protected packages
|
|
169
429
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
170
430
|
configuration variable is already set.
|
|
@@ -180,6 +440,7 @@ FLAGS
|
|
|
180
440
|
-w, --wait=<value> Number of minutes to wait for installation status.
|
|
181
441
|
-z, --branch=<value> Package branch to consider when specifiying a Package/VersionNumber combination
|
|
182
442
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
443
|
+
--output-file=<value> Path to write a JSON install report to.
|
|
183
444
|
|
|
184
445
|
GLOBAL FLAGS
|
|
185
446
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -197,6 +458,8 @@ EXAMPLES
|
|
|
197
458
|
|
|
198
459
|
$ sf simply package dependencies install --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key "MyPackage1Alias:MyPackage1Key" --installation-key "MyPackage2Alias:MyPackage2Key"
|
|
199
460
|
|
|
461
|
+
$ sf simply package dependencies install --target-org myTargetOrg --target-dev-hub myTargetDevHub --output-file install-report.json
|
|
462
|
+
|
|
200
463
|
FLAG DESCRIPTIONS
|
|
201
464
|
-a, --apex-compile=all|package
|
|
202
465
|
|
|
@@ -211,11 +474,14 @@ FLAG DESCRIPTIONS
|
|
|
211
474
|
This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if
|
|
212
475
|
--apex-compile package is specified.
|
|
213
476
|
|
|
214
|
-
-i, --install-type=All|Delta Install all packages or only
|
|
477
|
+
-i, --install-type=All|Delta|Upgrade Install all packages, only deltas, or only newer versions.
|
|
215
478
|
|
|
216
479
|
If 'All' is specified, then all packages specified in package dependencies are installed, regardless of if the
|
|
217
480
|
version already is installed in the org. If 'Delta' is specified, then only packages that differ from what is
|
|
218
|
-
installed in the org will be installed.
|
|
481
|
+
installed in the org will be installed. If 'Upgrade' is specified, then a package is installed only if it isn't
|
|
482
|
+
already installed, or if its semantic version (major.minor.patch.build) is newer than the version currently
|
|
483
|
+
installed in the org; packages with an installed version that is the same as or newer than the target version are
|
|
484
|
+
skipped.
|
|
219
485
|
|
|
220
486
|
-k, --installation-key=<value>... Installation key for key-protected packages
|
|
221
487
|
|
|
@@ -239,9 +505,16 @@ FLAG DESCRIPTIONS
|
|
|
239
505
|
|
|
240
506
|
For dependencies specified by Package/VersionNumber combination, you can specify the branch group of builds to work
|
|
241
507
|
from by entering the branch build name. If not specified, the builds from NULL branch will be considered.
|
|
508
|
+
|
|
509
|
+
--output-file=<value> Path to write a JSON install report to.
|
|
510
|
+
|
|
511
|
+
When specified, a JSON report of the install outcome for every resolved dependency is written to this path, in
|
|
512
|
+
addition to the normal terminal output you can continue to monitor as the command runs. Each entry includes the
|
|
513
|
+
package name, the SubscriberPackageVersionId already installed in the org (if any), the SubscriberPackageVersionId
|
|
514
|
+
that was attempted, and the decision made (Skipped, Installed, Installing, or Failed).
|
|
242
515
|
```
|
|
243
516
|
|
|
244
|
-
_See code: [@simplysf/simply-package](https://github.com/SimplySF/simply/blob/@simplysf/simply-package@2.
|
|
517
|
+
_See code: [@simplysf/simply-package](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-package@2.8.1/packages/simply-package/lib/commands/simply/package/dependencies/install.js)_
|
|
245
518
|
|
|
246
519
|
## `sf simply package dependencies manage`
|
|
247
520
|
|
|
@@ -300,7 +573,7 @@ FLAG DESCRIPTIONS
|
|
|
300
573
|
version without interactive prompts. Mutually exclusive with --update-to-latest.
|
|
301
574
|
```
|
|
302
575
|
|
|
303
|
-
_See code: [@simplysf/simply-package](https://github.com/SimplySF/simply/blob/@simplysf/simply-package@2.
|
|
576
|
+
_See code: [@simplysf/simply-package](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-package@2.8.1/packages/simply-package/lib/commands/simply/package/dependencies/manage.js)_
|
|
304
577
|
|
|
305
578
|
## `sf simply package version cleanup`
|
|
306
579
|
|
|
@@ -308,15 +581,16 @@ Cleanup package versions.
|
|
|
308
581
|
|
|
309
582
|
```
|
|
310
583
|
USAGE
|
|
311
|
-
$ sf simply package version cleanup -
|
|
312
|
-
|
|
584
|
+
$ sf simply package version cleanup -p <value> -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-s <value> | -x
|
|
585
|
+
<value>]
|
|
313
586
|
|
|
314
587
|
FLAGS
|
|
315
|
-
-p, --package=<value>
|
|
316
|
-
-s, --matcher=<value>
|
|
317
|
-
-v, --target-dev-hub=<value>
|
|
318
|
-
|
|
319
|
-
|
|
588
|
+
-p, --package=<value> (required) Package Id
|
|
589
|
+
-s, --matcher=<value> MAJOR.MINOR.PATCH to select on
|
|
590
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
591
|
+
configuration variable is already set.
|
|
592
|
+
-x, --exclude-matcher=<value> MAJOR.MINOR.PATCH to exclude on
|
|
593
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
320
594
|
|
|
321
595
|
GLOBAL FLAGS
|
|
322
596
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -325,21 +599,528 @@ GLOBAL FLAGS
|
|
|
325
599
|
DESCRIPTION
|
|
326
600
|
Cleanup package versions.
|
|
327
601
|
|
|
328
|
-
Delete package versions for a given package provided a MAJOR.MINOR.PATCH matcher
|
|
329
|
-
versions.
|
|
602
|
+
Delete package versions for a given package provided a MAJOR.MINOR.PATCH matcher, either to select on or to exclude
|
|
603
|
+
on. Does not delete released package versions.
|
|
604
|
+
|
|
605
|
+
If --matcher is provided, only the unreleased versions matching MAJOR.MINOR.PATCH are deleted. If --exclude-matcher is
|
|
606
|
+
provided instead, every unreleased version that does _not_ match MAJOR.MINOR.PATCH is deleted. Exactly one of
|
|
607
|
+
--matcher or --exclude-matcher must be specified.
|
|
330
608
|
|
|
331
609
|
EXAMPLES
|
|
332
610
|
$ sf simply package version cleanup --package 0Hoxx00000000CqCAI --matcher 2.10.0 --target-dev-hub myDevHub
|
|
333
611
|
|
|
612
|
+
$ sf simply package version cleanup --package 0Hoxx00000000CqCAI --exclude-matcher 2.10.0 --target-dev-hub myDevHub
|
|
613
|
+
|
|
334
614
|
FLAG DESCRIPTIONS
|
|
335
615
|
-p, --package=<value> Package Id
|
|
336
616
|
|
|
337
617
|
The 0Ht Package Id that you wish to cleanup versions for.
|
|
338
618
|
|
|
339
|
-
-s, --matcher=<value> MAJOR.MINOR.PATCH
|
|
619
|
+
-s, --matcher=<value> MAJOR.MINOR.PATCH to select on
|
|
620
|
+
|
|
621
|
+
The MAJOR.MINOR.PATCH matcher that should be used to find package versions to delete. Only versions matching this
|
|
622
|
+
matcher are deleted. Mutually exclusive with --exclude-matcher.
|
|
623
|
+
|
|
624
|
+
-x, --exclude-matcher=<value> MAJOR.MINOR.PATCH to exclude on
|
|
625
|
+
|
|
626
|
+
The MAJOR.MINOR.PATCH matcher that should be used to find package versions to keep. Every unreleased version that
|
|
627
|
+
does not match this matcher is deleted. Mutually exclusive with --matcher.
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
_See code: [@simplysf/simply-package](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-package@2.8.1/packages/simply-package/lib/commands/simply/package/version/cleanup.js)_
|
|
631
|
+
|
|
632
|
+
## `sf simply permissions analyze`
|
|
633
|
+
|
|
634
|
+
Analyze permission sets and permission set groups in an org.
|
|
635
|
+
|
|
636
|
+
```
|
|
637
|
+
USAGE
|
|
638
|
+
$ sf simply permissions analyze -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>...] [--output
|
|
639
|
+
<value>]
|
|
640
|
+
|
|
641
|
+
FLAGS
|
|
642
|
+
-f, --filter=<value>... Permission set or group names to include
|
|
643
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
644
|
+
configuration variable is already set.
|
|
645
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
646
|
+
--output=<value> [default: permissions_report.html] Output HTML file path
|
|
647
|
+
|
|
648
|
+
GLOBAL FLAGS
|
|
649
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
650
|
+
--json Format output as json.
|
|
651
|
+
|
|
652
|
+
DESCRIPTION
|
|
653
|
+
Analyze permission sets and permission set groups in an org.
|
|
654
|
+
|
|
655
|
+
Generates an HTML report of every permission set and permission set group in the target org, grouped by installed
|
|
656
|
+
package, including their object and field permissions.
|
|
657
|
+
|
|
658
|
+
EXAMPLES
|
|
659
|
+
$ sf simply permissions analyze --target-org myOrg
|
|
660
|
+
|
|
661
|
+
$ sf simply permissions analyze --target-org myOrg --output reports/permissions.html --filter My_Permission_Set --filter Another_Set
|
|
662
|
+
|
|
663
|
+
FLAG DESCRIPTIONS
|
|
664
|
+
-f, --filter=<value>... Permission set or group names to include
|
|
665
|
+
|
|
666
|
+
One or more PermissionSet (Name) or PermissionSetGroup (DeveloperName) API names to restrict the report to. If
|
|
667
|
+
omitted, all permission sets and groups are included.
|
|
668
|
+
|
|
669
|
+
--output=<value> Output HTML file path
|
|
670
|
+
|
|
671
|
+
The path to write the generated HTML report to.
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-permissions@1.2.13/packages/simply-permissions/lib/commands/simply/permissions/analyze.js)_
|
|
675
|
+
|
|
676
|
+
## `sf simply permissions build`
|
|
677
|
+
|
|
678
|
+
Generate a permission set from Salesforce source metadata.
|
|
679
|
+
|
|
680
|
+
```
|
|
681
|
+
USAGE
|
|
682
|
+
$ sf simply permissions build --type read-only|view-all|modify-all -n <value> -d <value> --output <value> [--json]
|
|
683
|
+
[--flags-dir <value>] [-c <value>] [--include-record-types] [--label <value>] [--description <value>]
|
|
684
|
+
|
|
685
|
+
FLAGS
|
|
686
|
+
-c, --config=<value> Path to a permission set configuration file
|
|
687
|
+
-d, --directory=<value> (required) Path to the Salesforce project directory
|
|
688
|
+
-n, --name=<value> (required) API name for the permission set
|
|
689
|
+
--description=<value> Description for the permission set
|
|
690
|
+
--include-record-types Include record type visibilities
|
|
691
|
+
--label=<value> Label for the permission set
|
|
692
|
+
--output=<value> (required) Output directory
|
|
693
|
+
--type=<option> (required) Baseline permission type
|
|
694
|
+
<options: read-only|view-all|modify-all>
|
|
695
|
+
|
|
696
|
+
GLOBAL FLAGS
|
|
697
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
698
|
+
--json Format output as json.
|
|
699
|
+
|
|
700
|
+
DESCRIPTION
|
|
701
|
+
Generate a permission set from Salesforce source metadata.
|
|
702
|
+
|
|
703
|
+
Scans a Salesforce project directory for custom objects, fields, tabs, and (optionally) record types, then generates a
|
|
704
|
+
permission set XML file with a baseline of permissions determined by --type. An optional JSON --config file can
|
|
705
|
+
override individual object, field, tab, record type, and user permission settings, as well as whether the permission
|
|
706
|
+
set requires activation.
|
|
707
|
+
|
|
708
|
+
EXAMPLES
|
|
709
|
+
$ sf simply permissions build --type read-only --name My_Read_Only_Access --directory force-app --output force-app/main/default/permissionsets
|
|
710
|
+
|
|
711
|
+
$ sf simply permissions build --type modify-all --name My_Admin_Access --directory force-app --config config/permission-overrides.json --output force-app/main/default/permissionsets --include-record-types
|
|
712
|
+
|
|
713
|
+
FLAG DESCRIPTIONS
|
|
714
|
+
-c, --config=<value> Path to a permission set configuration file
|
|
715
|
+
|
|
716
|
+
The path to a JSON file that overrides individual object, field, tab, record type, and user permission settings, as
|
|
717
|
+
well as whether the permission set requires activation, on top of the --type baseline.
|
|
718
|
+
|
|
719
|
+
-d, --directory=<value> Path to the Salesforce project directory
|
|
720
|
+
|
|
721
|
+
The path to the Salesforce source directory to scan for custom objects, fields, tabs, and record types.
|
|
722
|
+
|
|
723
|
+
-n, --name=<value> API name for the permission set
|
|
724
|
+
|
|
725
|
+
The API name for the generated permission set; also used to derive the output filename.
|
|
726
|
+
|
|
727
|
+
--include-record-types Include record type visibilities
|
|
728
|
+
|
|
729
|
+
Automatically include record type visibilities discovered from the source metadata, marked as visible by default.
|
|
730
|
+
|
|
731
|
+
--output=<value> Output directory
|
|
732
|
+
|
|
733
|
+
The directory to write the generated permission set XML file to.
|
|
734
|
+
|
|
735
|
+
--type=read-only|view-all|modify-all Baseline permission type
|
|
736
|
+
|
|
737
|
+
The baseline permission level to generate: 'read-only' grants read access to all discovered objects and fields,
|
|
738
|
+
'view-all' additionally grants view-all-records, and 'modify-all' grants full CRUD and modify-all-records access.
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
_See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-permissions@1.2.13/packages/simply-permissions/lib/commands/simply/permissions/build.js)_
|
|
742
|
+
|
|
743
|
+
## `sf simply project update api-version`
|
|
744
|
+
|
|
745
|
+
Update the Salesforce API version across a project's metadata.
|
|
746
|
+
|
|
747
|
+
```
|
|
748
|
+
USAGE
|
|
749
|
+
$ sf simply project update api-version -d <value> -a <value> [--json] [--flags-dir <value>]
|
|
750
|
+
|
|
751
|
+
FLAGS
|
|
752
|
+
-a, --api-version=<value> (required) Target Salesforce API version
|
|
753
|
+
-d, --directory=<value> (required) Path to the Salesforce project directory
|
|
754
|
+
|
|
755
|
+
GLOBAL FLAGS
|
|
756
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
757
|
+
--json Format output as json.
|
|
758
|
+
|
|
759
|
+
DESCRIPTION
|
|
760
|
+
Update the Salesforce API version across a project's metadata.
|
|
761
|
+
|
|
762
|
+
Recursively scans a directory for `-meta.xml` files and updates every `<apiVersion>` tag to the target version. If the
|
|
763
|
+
directory contains an `sfdx-project.json` file, its `sourceApiVersion` property is updated to match.
|
|
764
|
+
|
|
765
|
+
EXAMPLES
|
|
766
|
+
$ sf simply project update api-version --directory force-app --api-version 62.0
|
|
767
|
+
|
|
768
|
+
$ sf simply project update api-version --directory . --api-version 63.0
|
|
769
|
+
|
|
770
|
+
FLAG DESCRIPTIONS
|
|
771
|
+
-a, --api-version=<value> Target Salesforce API version
|
|
772
|
+
|
|
773
|
+
The Salesforce API version to set on all metadata files and, if present, sfdx-project.json.
|
|
774
|
+
|
|
775
|
+
-d, --directory=<value> Path to the Salesforce project directory
|
|
776
|
+
|
|
777
|
+
The path to the Salesforce project directory to scan for metadata files.
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
_See code: [@simplysf/simply-project](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-project@1.2.10/packages/simply-project/lib/commands/simply/project/update/api-version.js)_
|
|
781
|
+
|
|
782
|
+
## `sf simply schema generate`
|
|
783
|
+
|
|
784
|
+
Generate Salesforce CustomObject/CustomField/RecordType metadata from a CSV or Excel schema definition file.
|
|
785
|
+
|
|
786
|
+
```
|
|
787
|
+
USAGE
|
|
788
|
+
$ sf simply schema generate -f <value> -d <value> [--json] [--flags-dir <value>]
|
|
789
|
+
|
|
790
|
+
FLAGS
|
|
791
|
+
-d, --output-dir=<value> (required) The output directory to write the generated metadata into.
|
|
792
|
+
-f, --file=<value> (required) Path to the CSV or Excel (.xlsx/.xls) schema definition file.
|
|
793
|
+
|
|
794
|
+
GLOBAL FLAGS
|
|
795
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
796
|
+
--json Format output as json.
|
|
797
|
+
|
|
798
|
+
DESCRIPTION
|
|
799
|
+
Generate Salesforce CustomObject/CustomField/RecordType metadata from a CSV or Excel schema definition file.
|
|
800
|
+
|
|
801
|
+
Reads a flat CSV or an Excel workbook describing one or more custom objects, their fields, and (CSV only) their record
|
|
802
|
+
types, and writes Salesforce DX source-format metadata (`.object-meta.xml`, `.field-meta.xml`, `.recordType-meta.xml`)
|
|
803
|
+
into `--output-dir`.
|
|
804
|
+
|
|
805
|
+
For CSV input, each row's `Type` column (`CustomObject`, `CustomField`, or `RecordType`) and `ObjectName` column group
|
|
806
|
+
the rows by object. For Excel input (`.xlsx`/`.xls`), the workbook must contain an `object` worksheet (a two-column
|
|
807
|
+
key/value sheet describing the sObject) and a `fields` worksheet (one row per field); picklist fields may reference an
|
|
808
|
+
additional values worksheet by name.
|
|
809
|
+
|
|
810
|
+
EXAMPLES
|
|
811
|
+
$ sf simply schema generate --file schema.csv --output-dir force-app/main/default/objects
|
|
812
|
+
|
|
813
|
+
$ sf simply schema generate --file MyObject__c.xlsx --output-dir force-app/main/default/objects
|
|
814
|
+
|
|
815
|
+
FLAG DESCRIPTIONS
|
|
816
|
+
-f, --file=<value> Path to the CSV or Excel (.xlsx/.xls) schema definition file.
|
|
817
|
+
|
|
818
|
+
A `.csv` file processed as the flat CSV flow, or a `.xlsx`/`.xls` file processed as the Excel flow.
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
_See code: [@simplysf/simply-schema](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-schema@0.2.0/packages/simply-schema/lib/commands/simply/schema/generate.js)_
|
|
822
|
+
|
|
823
|
+
## `sf simply schema visualize`
|
|
824
|
+
|
|
825
|
+
Generate visualizations of Salesforce schema from a live org or local source files.
|
|
826
|
+
|
|
827
|
+
```
|
|
828
|
+
USAGE
|
|
829
|
+
$ sf simply schema visualize [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>] [-d <value>...]
|
|
830
|
+
[--source-objects <value>] [--related-objects <value>] [--object-type custom|standard|all] [--field-type
|
|
831
|
+
custom|standard|all] [--output-type html|md|csv...] [--output-dir <value>]
|
|
832
|
+
|
|
833
|
+
FLAGS
|
|
834
|
+
-d, --source-dir=<value>... One or more paths to directories containing Salesforce DX source. Use this for
|
|
835
|
+
local-source generation.
|
|
836
|
+
-o, --target-org=<value> Username or alias of the org to visualize. Use this for live-org generation.
|
|
837
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
838
|
+
--field-type=<option> [default: custom] Scope of relationship fields to include: custom, standard, or all.
|
|
839
|
+
<options: custom|standard|all>
|
|
840
|
+
--object-type=<option> [default: custom] Scope of objects to include: custom, standard, or all.
|
|
841
|
+
<options: custom|standard|all>
|
|
842
|
+
--output-dir=<value> The output directory for the generated files.
|
|
843
|
+
--output-type=<option>... [default: html,md] Output format(s) to generate.
|
|
844
|
+
<options: html|md|csv>
|
|
845
|
+
--related-objects=<value> Comma-separated list of related objects to filter the visualization to, or `all`.
|
|
846
|
+
--source-objects=<value> Comma-separated list of source objects to start from, or `all`.
|
|
847
|
+
|
|
848
|
+
GLOBAL FLAGS
|
|
849
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
850
|
+
--json Format output as json.
|
|
851
|
+
|
|
852
|
+
DESCRIPTION
|
|
853
|
+
Generate visualizations of Salesforce schema from a live org or local source files.
|
|
854
|
+
|
|
855
|
+
Builds an object-relationship diagram (interactive HTML), a Mermaid entity-relationship diagram (Markdown), and/or a
|
|
856
|
+
relationship CSV, either from a live org's Tooling API or from local Salesforce DX source directories. Exactly one of
|
|
857
|
+
`--target-org` or `--source-dir` must be specified.
|
|
858
|
+
|
|
859
|
+
EXAMPLES
|
|
860
|
+
$ sf simply schema visualize --target-org myTargetOrg
|
|
861
|
+
|
|
862
|
+
$ sf simply schema visualize --target-org myTargetOrg --source-objects Account,Contact --related-objects all
|
|
863
|
+
|
|
864
|
+
$ sf simply schema visualize --source-dir force-app --output-type html,md
|
|
865
|
+
|
|
866
|
+
FLAG DESCRIPTIONS
|
|
867
|
+
--output-type=html|md|csv... Output format(s) to generate.
|
|
868
|
+
|
|
869
|
+
One or more of `html` (interactive diagram), `md` (Mermaid entity-relationship diagram), or `csv` (relationship
|
|
870
|
+
data).
|
|
871
|
+
|
|
872
|
+
--related-objects=<value> Comma-separated list of related objects to filter the visualization to, or `all`.
|
|
873
|
+
|
|
874
|
+
Comma-separated API names of related objects to include in the visualization. If `all` is specified, every related
|
|
875
|
+
object is included regardless of `--object-type`. If not specified, related objects aren't filtered.
|
|
876
|
+
|
|
877
|
+
--source-objects=<value> Comma-separated list of source objects to start from, or `all`.
|
|
878
|
+
|
|
879
|
+
Comma-separated API names of the objects to start the visualization from (e.g. `Account,MyObject__c`). If `all` is
|
|
880
|
+
specified, every discovered object is included. If not specified, every object matching `--object-type` is included.
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
_See code: [@simplysf/simply-schema](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-schema@0.2.0/packages/simply-schema/lib/commands/simply/schema/visualize.js)_
|
|
884
|
+
|
|
885
|
+
## `sf simply sobject backup`
|
|
886
|
+
|
|
887
|
+
Back up SObject data to a CSV file.
|
|
888
|
+
|
|
889
|
+
```
|
|
890
|
+
USAGE
|
|
891
|
+
$ sf simply sobject backup -s <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>]
|
|
892
|
+
|
|
893
|
+
FLAGS
|
|
894
|
+
-d, --output-dir=<value> Output directory
|
|
895
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
896
|
+
configuration variable is already set.
|
|
897
|
+
-s, --sobject=<value> (required) SObject API name
|
|
898
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
899
|
+
|
|
900
|
+
GLOBAL FLAGS
|
|
901
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
902
|
+
--json Format output as json.
|
|
903
|
+
|
|
904
|
+
DESCRIPTION
|
|
905
|
+
Back up SObject data to a CSV file.
|
|
906
|
+
|
|
907
|
+
Describes the given SObject, queries every field via the Bulk API, and writes the results to a timestamped CSV file.
|
|
908
|
+
|
|
909
|
+
EXAMPLES
|
|
910
|
+
$ sf simply sobject backup --target-org myOrg --sobject Account
|
|
911
|
+
|
|
912
|
+
$ sf simply sobject backup --target-org myOrg --sobject Custom_Object__c --output-dir backups
|
|
913
|
+
|
|
914
|
+
FLAG DESCRIPTIONS
|
|
915
|
+
-d, --output-dir=<value> Output directory
|
|
916
|
+
|
|
917
|
+
The directory to save the backup CSV file to. Defaults to the current directory.
|
|
918
|
+
|
|
919
|
+
-s, --sobject=<value> SObject API name
|
|
920
|
+
|
|
921
|
+
The API name of the SObject to back up.
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
_See code: [@simplysf/simply-sobject](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-sobject@1.4.0/packages/simply-sobject/lib/commands/simply/sobject/backup.js)_
|
|
925
|
+
|
|
926
|
+
## `sf simply sobject deduplicate`
|
|
927
|
+
|
|
928
|
+
Identify and prepare deduplication of an SObject's records.
|
|
929
|
+
|
|
930
|
+
```
|
|
931
|
+
USAGE
|
|
932
|
+
$ sf simply sobject deduplicate -c <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--dry-run]
|
|
933
|
+
[--output-dir <value>]
|
|
934
|
+
|
|
935
|
+
FLAGS
|
|
936
|
+
-c, --config=<value> (required) Path to a deduplication configuration file
|
|
937
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
938
|
+
configuration variable is already set.
|
|
939
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
940
|
+
--dry-run Skip calculating associated object lookup replacements
|
|
941
|
+
--output-dir=<value> Output directory
|
|
942
|
+
|
|
943
|
+
GLOBAL FLAGS
|
|
944
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
945
|
+
--json Format output as json.
|
|
946
|
+
|
|
947
|
+
DESCRIPTION
|
|
948
|
+
Identify and prepare deduplication of an SObject's records.
|
|
949
|
+
|
|
950
|
+
Queries an SObject, groups records by a composite key built from configured fields, and writes CSV files listing which
|
|
951
|
+
records are unique and which are duplicates that should be deleted. For each associated object with lookups to the
|
|
952
|
+
primary object, also writes a CSV of the lookup field updates needed to re-point duplicate references at the surviving
|
|
953
|
+
unique record. This command does not perform any deletes or updates in the org; it only prepares the CSV files for a
|
|
954
|
+
subsequent data load.
|
|
955
|
+
|
|
956
|
+
EXAMPLES
|
|
957
|
+
$ sf simply sobject deduplicate --target-org myOrg --config config/deduplicate-account.json
|
|
958
|
+
|
|
959
|
+
$ sf simply sobject deduplicate --target-org myOrg --config config/deduplicate-account.json --dry-run
|
|
960
|
+
|
|
961
|
+
FLAG DESCRIPTIONS
|
|
962
|
+
-c, --config=<value> Path to a deduplication configuration file
|
|
963
|
+
|
|
964
|
+
The path to a JSON file describing the primary object, its composite key fields, and any associated objects with
|
|
965
|
+
lookups to it.
|
|
966
|
+
|
|
967
|
+
--dry-run Skip calculating associated object lookup replacements
|
|
968
|
+
|
|
969
|
+
When set, only the primary object's unique/duplicate CSV files are generated; associated object lookup replacement
|
|
970
|
+
files are not calculated.
|
|
971
|
+
|
|
972
|
+
--output-dir=<value> Output directory
|
|
973
|
+
|
|
974
|
+
The directory to write the generated CSV files to. Defaults to ./temp/<primaryObjectApiName>.
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
_See code: [@simplysf/simply-sobject](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-sobject@1.4.0/packages/simply-sobject/lib/commands/simply/sobject/deduplicate.js)_
|
|
978
|
+
|
|
979
|
+
## `sf simply sobject history export`
|
|
980
|
+
|
|
981
|
+
Export field history for an SObject within a date range to a CSV file.
|
|
982
|
+
|
|
983
|
+
```
|
|
984
|
+
USAGE
|
|
985
|
+
$ sf simply sobject history export -s <value> --start-date <value> --end-date <value> -o <value> [--json] [--flags-dir <value>]
|
|
986
|
+
[--api-version <value>] [-d <value>]
|
|
987
|
+
|
|
988
|
+
FLAGS
|
|
989
|
+
-d, --output-dir=<value> Output directory
|
|
990
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
991
|
+
configuration variable is already set.
|
|
992
|
+
-s, --sobject=<value> (required) SObject API name
|
|
993
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
994
|
+
--end-date=<value> (required) End date (YYYY-MM-DD)
|
|
995
|
+
--start-date=<value> (required) Start date (YYYY-MM-DD)
|
|
996
|
+
|
|
997
|
+
GLOBAL FLAGS
|
|
998
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
999
|
+
--json Format output as json.
|
|
1000
|
+
|
|
1001
|
+
DESCRIPTION
|
|
1002
|
+
Export field history for an SObject within a date range to a CSV file.
|
|
1003
|
+
|
|
1004
|
+
Queries the field history object for the given SObject (e.g. `AccountHistory`, `Custom_Object__History`, or
|
|
1005
|
+
`OpportunityFieldHistory`) for changes created within the given date range, and writes the results to a timestamped
|
|
1006
|
+
CSV file.
|
|
1007
|
+
|
|
1008
|
+
EXAMPLES
|
|
1009
|
+
$ sf simply sobject history export --target-org myOrg --sobject Account --start-date 2026-01-01 --end-date 2026-01-31
|
|
1010
|
+
|
|
1011
|
+
$ sf simply sobject history export --target-org myOrg --sobject Custom_Object__c --start-date 2026-01-01 --end-date 2026-01-31 --output-dir exports
|
|
1012
|
+
|
|
1013
|
+
FLAG DESCRIPTIONS
|
|
1014
|
+
-d, --output-dir=<value> Output directory
|
|
1015
|
+
|
|
1016
|
+
The directory to save the exported CSV file to. Defaults to the current directory.
|
|
1017
|
+
|
|
1018
|
+
-s, --sobject=<value> SObject API name
|
|
1019
|
+
|
|
1020
|
+
The API name of the SObject to export field history for (e.g. Account or Custom_Object__c).
|
|
1021
|
+
|
|
1022
|
+
--end-date=<value> End date (YYYY-MM-DD)
|
|
1023
|
+
|
|
1024
|
+
The end of the date range to export history for, inclusive.
|
|
1025
|
+
|
|
1026
|
+
--start-date=<value> Start date (YYYY-MM-DD)
|
|
1027
|
+
|
|
1028
|
+
The start of the date range to export history for, inclusive.
|
|
1029
|
+
```
|
|
1030
|
+
|
|
1031
|
+
_See code: [@simplysf/simply-sobject](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-sobject@1.4.0/packages/simply-sobject/lib/commands/simply/sobject/history/export.js)_
|
|
1032
|
+
|
|
1033
|
+
## `sf simply sobject history query`
|
|
1034
|
+
|
|
1035
|
+
Query the field history of an SObject, with optional filtering.
|
|
1036
|
+
|
|
1037
|
+
```
|
|
1038
|
+
USAGE
|
|
1039
|
+
$ sf simply sobject history query --object <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--filters
|
|
1040
|
+
<value>] [-d <value>]
|
|
1041
|
+
|
|
1042
|
+
FLAGS
|
|
1043
|
+
-d, --output-dir=<value> Output directory
|
|
1044
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1045
|
+
configuration variable is already set.
|
|
1046
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1047
|
+
--filters=<value> Path to a filter configuration file, or a raw JSON filter string
|
|
1048
|
+
--object=<value> (required) SObject API name
|
|
1049
|
+
|
|
1050
|
+
GLOBAL FLAGS
|
|
1051
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1052
|
+
--json Format output as json.
|
|
1053
|
+
|
|
1054
|
+
DESCRIPTION
|
|
1055
|
+
Query the field history of an SObject, with optional filtering.
|
|
1056
|
+
|
|
1057
|
+
Queries the field history object for the given SObject (e.g. `AccountHistory`, `Custom_Object__History`, or
|
|
1058
|
+
`OpportunityFieldHistory`) and writes the results to a timestamped CSV file. An optional filter tree can be supplied
|
|
1059
|
+
to narrow the results: conditions on Field, CreatedById, CreatedDate, or the parent lookup field are pushed into the
|
|
1060
|
+
SOQL WHERE clause; conditions on any other field (e.g. OldValue or NewValue) are applied client-side after the query
|
|
1061
|
+
runs.
|
|
1062
|
+
|
|
1063
|
+
EXAMPLES
|
|
1064
|
+
$ sf simply sobject history query --target-org myOrg --object Account
|
|
1065
|
+
|
|
1066
|
+
$ sf simply sobject history query --target-org myOrg --object Custom_Object__c --filters config/history-filters.json
|
|
1067
|
+
|
|
1068
|
+
$ sf simply sobject history query --target-org myOrg --object Account --filters '{"logic":"AND","filters":[{"field":"Field","operator":"=","value":"Name"}]}'
|
|
1069
|
+
|
|
1070
|
+
FLAG DESCRIPTIONS
|
|
1071
|
+
-d, --output-dir=<value> Output directory
|
|
1072
|
+
|
|
1073
|
+
The directory to save the query results CSV file to. Defaults to the current directory.
|
|
1074
|
+
|
|
1075
|
+
--filters=<value> Path to a filter configuration file, or a raw JSON filter string
|
|
1076
|
+
|
|
1077
|
+
A JSON object describing a tree of filter conditions: `{ "logic": "AND", "filters": [ { "field": "Field",
|
|
1078
|
+
"operator": "=", "value": "Status__c" } ] }`. Each entry in `filters` is either a condition (`field`, `operator`,
|
|
1079
|
+
`value`) or another nested group with its own `logic`/`filters`. Supported operators are =, !=, >, <, >=, <=, IN,
|
|
1080
|
+
NOT IN, and LIKE (using `%` as a wildcard).
|
|
1081
|
+
|
|
1082
|
+
--object=<value> SObject API name
|
|
1083
|
+
|
|
1084
|
+
The API name of the SObject to query field history for (e.g. Account or Custom_Object__c).
|
|
1085
|
+
```
|
|
1086
|
+
|
|
1087
|
+
_See code: [@simplysf/simply-sobject](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-sobject@1.4.0/packages/simply-sobject/lib/commands/simply/sobject/history/query.js)_
|
|
1088
|
+
|
|
1089
|
+
## `sf simply sobject history schema`
|
|
1090
|
+
|
|
1091
|
+
Report on which objects and fields have field history tracking enabled.
|
|
1092
|
+
|
|
1093
|
+
```
|
|
1094
|
+
USAGE
|
|
1095
|
+
$ sf simply sobject history schema -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>]
|
|
1096
|
+
|
|
1097
|
+
FLAGS
|
|
1098
|
+
-d, --output-dir=<value> Output directory
|
|
1099
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1100
|
+
configuration variable is already set.
|
|
1101
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1102
|
+
|
|
1103
|
+
GLOBAL FLAGS
|
|
1104
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1105
|
+
--json Format output as json.
|
|
1106
|
+
|
|
1107
|
+
DESCRIPTION
|
|
1108
|
+
Report on which objects and fields have field history tracking enabled.
|
|
1109
|
+
|
|
1110
|
+
Identifies every object with field history tracking enabled, and every tracked field on each, resolving the
|
|
1111
|
+
managed/unlocked package each field belongs to, and writes the results to a timestamped CSV file and a browsable HTML
|
|
1112
|
+
report.
|
|
1113
|
+
|
|
1114
|
+
EXAMPLES
|
|
1115
|
+
$ sf simply sobject history schema --target-org myOrg
|
|
1116
|
+
|
|
1117
|
+
$ sf simply sobject history schema --target-org myOrg --output-dir reports
|
|
1118
|
+
|
|
1119
|
+
FLAG DESCRIPTIONS
|
|
1120
|
+
-d, --output-dir=<value> Output directory
|
|
340
1121
|
|
|
341
|
-
The
|
|
1122
|
+
The directory to save the generated CSV and HTML report files to. Defaults to the current directory.
|
|
342
1123
|
```
|
|
343
1124
|
|
|
344
|
-
_See code: [@simplysf/simply-
|
|
1125
|
+
_See code: [@simplysf/simply-sobject](https://github.com/SimplySF/simply-node/blob/@simplysf/simply-sobject@1.4.0/packages/simply-sobject/lib/commands/simply/sobject/history/schema.js)_
|
|
345
1126
|
<!-- commandsstop -->
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simplysf/simply",
|
|
3
3
|
"description": "Salesforce CLI Plugins created by @SimplySF",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.9.4",
|
|
5
5
|
"author": "@ClayChipps",
|
|
6
|
-
"homepage": "https://github.com/SimplySF/simply",
|
|
7
|
-
"bugs": "https://github.com/SimplySF/simply/issues",
|
|
6
|
+
"homepage": "https://github.com/SimplySF/simply-node",
|
|
7
|
+
"bugs": "https://github.com/SimplySF/simply-node/issues",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
|
-
"url": "https://github.com/SimplySF/simply",
|
|
10
|
+
"url": "https://github.com/SimplySF/simply-node",
|
|
11
11
|
"directory": "packages/simply"
|
|
12
12
|
},
|
|
13
13
|
"engines": {
|
|
@@ -57,9 +57,11 @@
|
|
|
57
57
|
"plugins": [
|
|
58
58
|
"@simplysf/simply-apex",
|
|
59
59
|
"@simplysf/simply-data",
|
|
60
|
+
"@simplysf/simply-document",
|
|
60
61
|
"@simplysf/simply-package",
|
|
61
62
|
"@simplysf/simply-permissions",
|
|
62
63
|
"@simplysf/simply-project",
|
|
64
|
+
"@simplysf/simply-schema",
|
|
63
65
|
"@simplysf/simply-sobject"
|
|
64
66
|
],
|
|
65
67
|
"repositoryPrefix": "<%- repo %>/blob/@simplysf/simply@<%- version %>/packages/simply/<%- commandPath %>",
|
|
@@ -70,12 +72,14 @@
|
|
|
70
72
|
},
|
|
71
73
|
"dependencies": {
|
|
72
74
|
"@oclif/core": "^4.11.2",
|
|
73
|
-
"@simplysf/simply-apex": "^1.1.
|
|
74
|
-
"@simplysf/simply-data": "^2.3.
|
|
75
|
-
"@simplysf/simply-
|
|
76
|
-
"@simplysf/simply-
|
|
77
|
-
"@simplysf/simply-
|
|
78
|
-
"@simplysf/simply-
|
|
75
|
+
"@simplysf/simply-apex": "^1.1.11",
|
|
76
|
+
"@simplysf/simply-data": "^2.3.10",
|
|
77
|
+
"@simplysf/simply-document": "^0.3.0",
|
|
78
|
+
"@simplysf/simply-package": "^2.8.2",
|
|
79
|
+
"@simplysf/simply-permissions": "^1.2.14",
|
|
80
|
+
"@simplysf/simply-project": "^1.2.11",
|
|
81
|
+
"@simplysf/simply-schema": "^0.3.0",
|
|
82
|
+
"@simplysf/simply-sobject": "^1.4.1",
|
|
79
83
|
"debug": "^4.4.3"
|
|
80
84
|
},
|
|
81
85
|
"devDependencies": {
|
|
@@ -163,5 +167,5 @@
|
|
|
163
167
|
"output": []
|
|
164
168
|
}
|
|
165
169
|
},
|
|
166
|
-
"gitHead": "
|
|
170
|
+
"gitHead": "e87938c1f4074def66ef1710aa0cb491054ee000"
|
|
167
171
|
}
|