@salesforce/cli 2.60.13 → 2.60.14-dev.0
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 +319 -157
- package/npm-shrinkwrap.json +3070 -1445
- package/oclif.lock +1020 -679
- package/oclif.manifest.json +132 -132
- package/package.json +38 -29
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.60.
|
|
27
|
+
@salesforce/cli/2.60.14-dev.0 linux-x64 node-v20.17.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -54,7 +54,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
54
54
|
- [`sf apex run test`](#sf-apex-run-test)
|
|
55
55
|
- [`sf apex tail log`](#sf-apex-tail-log)
|
|
56
56
|
- [`sf api request graphql`](#sf-api-request-graphql)
|
|
57
|
-
- [`sf api request rest
|
|
57
|
+
- [`sf api request rest [URL]`](#sf-api-request-rest-url)
|
|
58
58
|
- [`sf autocomplete [SHELL]`](#sf-autocomplete-shell)
|
|
59
59
|
- [`sf commands`](#sf-commands)
|
|
60
60
|
- [`sf config get`](#sf-config-get)
|
|
@@ -66,6 +66,8 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
66
66
|
- [`sf data delete bulk`](#sf-data-delete-bulk)
|
|
67
67
|
- [`sf data delete record`](#sf-data-delete-record)
|
|
68
68
|
- [`sf data delete resume`](#sf-data-delete-resume)
|
|
69
|
+
- [`sf data export bulk`](#sf-data-export-bulk)
|
|
70
|
+
- [`sf data export resume`](#sf-data-export-resume)
|
|
69
71
|
- [`sf data export tree`](#sf-data-export-tree)
|
|
70
72
|
- [`sf data get record`](#sf-data-get-record)
|
|
71
73
|
- [`sf data import tree`](#sf-data-import-tree)
|
|
@@ -205,7 +207,7 @@ EXAMPLES
|
|
|
205
207
|
$ sf alias list
|
|
206
208
|
```
|
|
207
209
|
|
|
208
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
210
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/alias/list.ts)_
|
|
209
211
|
|
|
210
212
|
## `sf alias set`
|
|
211
213
|
|
|
@@ -254,7 +256,7 @@ EXAMPLES
|
|
|
254
256
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
255
257
|
```
|
|
256
258
|
|
|
257
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
259
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/alias/set.ts)_
|
|
258
260
|
|
|
259
261
|
## `sf alias unset`
|
|
260
262
|
|
|
@@ -294,7 +296,7 @@ EXAMPLES
|
|
|
294
296
|
$ sf alias unset --all [--no-prompt]
|
|
295
297
|
```
|
|
296
298
|
|
|
297
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
299
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/alias/unset.ts)_
|
|
298
300
|
|
|
299
301
|
## `sf analytics generate template`
|
|
300
302
|
|
|
@@ -336,7 +338,7 @@ FLAG DESCRIPTIONS
|
|
|
336
338
|
directory.
|
|
337
339
|
```
|
|
338
340
|
|
|
339
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
341
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/analytics/generate/template.ts)_
|
|
340
342
|
|
|
341
343
|
## `sf apex generate class`
|
|
342
344
|
|
|
@@ -395,7 +397,7 @@ FLAG DESCRIPTIONS
|
|
|
395
397
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
396
398
|
```
|
|
397
399
|
|
|
398
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
400
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/apex/generate/class.ts)_
|
|
399
401
|
|
|
400
402
|
## `sf apex generate trigger`
|
|
401
403
|
|
|
@@ -464,7 +466,7 @@ FLAG DESCRIPTIONS
|
|
|
464
466
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
465
467
|
```
|
|
466
468
|
|
|
467
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
469
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/apex/generate/trigger.ts)_
|
|
468
470
|
|
|
469
471
|
## `sf apex get log`
|
|
470
472
|
|
|
@@ -520,7 +522,7 @@ FLAG DESCRIPTIONS
|
|
|
520
522
|
directory.
|
|
521
523
|
```
|
|
522
524
|
|
|
523
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
525
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/get/log.ts)_
|
|
524
526
|
|
|
525
527
|
## `sf apex get test`
|
|
526
528
|
|
|
@@ -528,8 +530,8 @@ Display test results for a specific asynchronous test run.
|
|
|
528
530
|
|
|
529
531
|
```
|
|
530
532
|
USAGE
|
|
531
|
-
$ sf apex get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
532
|
-
[-r human|tap|junit|json] [--concise]
|
|
533
|
+
$ sf apex get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
534
|
+
[--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
|
|
533
535
|
|
|
534
536
|
FLAGS
|
|
535
537
|
-c, --code-coverage Retrieve code coverage results.
|
|
@@ -541,6 +543,7 @@ FLAGS
|
|
|
541
543
|
<options: human|tap|junit|json>
|
|
542
544
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
543
545
|
--concise Display only failed test results; works with human-readable output only.
|
|
546
|
+
--detailed-coverage Display detailed code coverage per test.
|
|
544
547
|
|
|
545
548
|
GLOBAL FLAGS
|
|
546
549
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -552,6 +555,10 @@ DESCRIPTION
|
|
|
552
555
|
Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is
|
|
553
556
|
displayed after running the "sf apex test run" command.
|
|
554
557
|
|
|
558
|
+
To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
|
|
559
|
+
summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
|
|
560
|
+
format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
|
|
561
|
+
|
|
555
562
|
ALIASES
|
|
556
563
|
$ sf force apex test report
|
|
557
564
|
|
|
@@ -575,7 +582,7 @@ EXAMPLES
|
|
|
575
582
|
me@myorg'
|
|
576
583
|
```
|
|
577
584
|
|
|
578
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
585
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/get/test.ts)_
|
|
579
586
|
|
|
580
587
|
## `sf apex list log`
|
|
581
588
|
|
|
@@ -615,7 +622,7 @@ EXAMPLES
|
|
|
615
622
|
$ sf apex list log --target-org me@my.org
|
|
616
623
|
```
|
|
617
624
|
|
|
618
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
625
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/list/log.ts)_
|
|
619
626
|
|
|
620
627
|
## `sf apex run`
|
|
621
628
|
|
|
@@ -662,7 +669,7 @@ EXAMPLES
|
|
|
662
669
|
$ sf apex run
|
|
663
670
|
```
|
|
664
671
|
|
|
665
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
672
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/run.ts)_
|
|
666
673
|
|
|
667
674
|
## `sf apex run test`
|
|
668
675
|
|
|
@@ -802,7 +809,7 @@ FLAG DESCRIPTIONS
|
|
|
802
809
|
--tests Test1 --tests Test2
|
|
803
810
|
```
|
|
804
811
|
|
|
805
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
812
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/run/test.ts)_
|
|
806
813
|
|
|
807
814
|
## `sf apex tail log`
|
|
808
815
|
|
|
@@ -845,7 +852,7 @@ EXAMPLES
|
|
|
845
852
|
$ sf apex tail log --color --skip-trace-flag
|
|
846
853
|
```
|
|
847
854
|
|
|
848
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
855
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/tail/log.ts)_
|
|
849
856
|
|
|
850
857
|
## `sf api request graphql`
|
|
851
858
|
|
|
@@ -898,31 +905,33 @@ EXAMPLES
|
|
|
898
905
|
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
|
|
899
906
|
```
|
|
900
907
|
|
|
901
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.
|
|
908
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.1/src/commands/api/request/graphql.ts)_
|
|
902
909
|
|
|
903
|
-
## `sf api request rest
|
|
910
|
+
## `sf api request rest [URL]`
|
|
904
911
|
|
|
905
912
|
Make an authenticated HTTP request using the Salesforce REST API.
|
|
906
913
|
|
|
907
914
|
```
|
|
908
915
|
USAGE
|
|
909
|
-
$ sf api request rest
|
|
910
|
-
|
|
916
|
+
$ sf api request rest [URL] -o <value> [--flags-dir <value>] [-i | -S Example: report.xlsx] [-X
|
|
917
|
+
GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE] [-H key:value...] [-f file | -b file]
|
|
911
918
|
|
|
912
919
|
ARGUMENTS
|
|
913
|
-
|
|
920
|
+
URL Salesforce API endpoint
|
|
914
921
|
|
|
915
922
|
FLAGS
|
|
916
923
|
-H, --header=key:value... HTTP header in "key:value" format.
|
|
917
924
|
-S, --stream-to-file=Example: report.xlsx Stream responses to a file.
|
|
918
|
-
-X, --method=<option>
|
|
925
|
+
-X, --method=<option> HTTP method for the request.
|
|
919
926
|
<options: GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE>
|
|
927
|
+
-b, --body=file File or content for the body of the HTTP request. Specify "-" to read from
|
|
928
|
+
standard input or "" for an empty body. If passing a file, prefix the
|
|
929
|
+
filename with '@'.
|
|
930
|
+
-f, --file=file JSON file that contains values for the request header, body, method, and
|
|
931
|
+
URL.
|
|
920
932
|
-i, --include Include the HTTP response status and headers in the output.
|
|
921
933
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the
|
|
922
934
|
`target-org` configuration variable is already set.
|
|
923
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
924
|
-
--body=file File or content for the body of the HTTP request. Specify "-" to read from
|
|
925
|
-
standard input or "" for an empty body.
|
|
926
935
|
|
|
927
936
|
GLOBAL FLAGS
|
|
928
937
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -939,33 +948,73 @@ DESCRIPTION
|
|
|
939
948
|
EXAMPLES
|
|
940
949
|
List information about limits in the org with alias "my-org":
|
|
941
950
|
|
|
942
|
-
$ sf api request rest 'limits' --target-org my-org
|
|
951
|
+
$ sf api request rest 'services/data/v56.0/limits' --target-org my-org
|
|
943
952
|
|
|
944
953
|
List all endpoints in your default org; write the output to a file called "output.txt" and include the HTTP response
|
|
945
954
|
status and headers:
|
|
946
955
|
|
|
947
|
-
$ sf api request rest '/' --stream-to-file output.txt --include
|
|
956
|
+
$ sf api request rest '/services/data/v56.0/' --stream-to-file output.txt --include
|
|
948
957
|
|
|
949
958
|
Get the response in XML format by specifying the "Accept" HTTP header:
|
|
950
959
|
|
|
951
|
-
$ sf api request rest 'limits' --header 'Accept: application/xml'
|
|
960
|
+
$ sf api request rest '/services/data/v56.0/limits' --header 'Accept: application/xml'
|
|
952
961
|
|
|
953
962
|
Create an account record using the POST method; specify the request details directly in the "--body" flag:
|
|
954
963
|
|
|
955
|
-
$ sf api request rest
|
|
956
|
-
\"Boise\"}" --method POST
|
|
964
|
+
$ sf api request rest /services/data/v56.0/sobjects/account --body "{\"Name\" : \"Account from REST \
|
|
965
|
+
API\",\"ShippingCity\" : \"Boise\"}" --method POST
|
|
957
966
|
|
|
958
|
-
Create an account record using the information in a file called "info.json":
|
|
967
|
+
Create an account record using the information in a file called "info.json" (note the @ prefixing the file name):
|
|
959
968
|
|
|
960
|
-
$ sf api request rest 'sobjects/account' --body info.json --method POST
|
|
969
|
+
$ sf api request rest '/services/data/v56.0/sobjects/account' --body @info.json --method POST
|
|
961
970
|
|
|
962
971
|
Update an account record using the PATCH method:
|
|
963
972
|
|
|
964
|
-
$ sf api request rest 'sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San
|
|
965
|
-
PATCH
|
|
973
|
+
$ sf api request rest '/services/data/v56.0/sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San \
|
|
974
|
+
Francisco\"}" --method PATCH
|
|
975
|
+
|
|
976
|
+
Store the values for the request header, body, and so on, in a file, which you then specify with the --file flag;
|
|
977
|
+
see the description of --file for more information:
|
|
978
|
+
|
|
979
|
+
$ sf api request rest --file myFile.json
|
|
980
|
+
|
|
981
|
+
FLAG DESCRIPTIONS
|
|
982
|
+
-f, --file=file JSON file that contains values for the request header, body, method, and URL.
|
|
983
|
+
|
|
984
|
+
Use this flag instead of specifying the request details with individual flags, such as --body or --method. This
|
|
985
|
+
schema defines how to create the JSON file:
|
|
986
|
+
|
|
987
|
+
{
|
|
988
|
+
url: { raw: string } | string;
|
|
989
|
+
method: 'GET', 'POST', 'PUT', 'PATCH', 'HEAD', 'DELETE', 'OPTIONS', 'TRACE';
|
|
990
|
+
description?: string;
|
|
991
|
+
header: string | Array<Record<string, string>>;
|
|
992
|
+
body: { mode: 'raw' | 'formdata'; raw: string; formdata: FormData };
|
|
993
|
+
}
|
|
994
|
+
|
|
995
|
+
Salesforce CLI defined this schema to be mimic Postman schemas; both share similar properties. The CLI's schema also
|
|
996
|
+
supports Postman Collections to reuse and share requests. As a result, you can build an API call using Postman,
|
|
997
|
+
export and save it to a file, and then use the file as a value to this flag. For information about Postman, see
|
|
998
|
+
https://learning.postman.com/.
|
|
999
|
+
|
|
1000
|
+
Here's a simple example of a JSON file that contains values for the request URL, method, and body:
|
|
1001
|
+
|
|
1002
|
+
{
|
|
1003
|
+
"url": "sobjects/Account/<Account ID>",
|
|
1004
|
+
"method": "PATCH",
|
|
1005
|
+
"body" : {
|
|
1006
|
+
"mode": "raw",
|
|
1007
|
+
"raw": {
|
|
1008
|
+
"BillingCity": "Boise"
|
|
1009
|
+
}
|
|
1010
|
+
}
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
See more examples in the plugin-api test directory, including JSON files that use "formdata" to define collections:
|
|
1014
|
+
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
|
|
966
1015
|
```
|
|
967
1016
|
|
|
968
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.
|
|
1017
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.1/src/commands/api/request/rest.ts)_
|
|
969
1018
|
|
|
970
1019
|
## `sf autocomplete [SHELL]`
|
|
971
1020
|
|
|
@@ -996,7 +1045,7 @@ EXAMPLES
|
|
|
996
1045
|
$ sf autocomplete --refresh-cache
|
|
997
1046
|
```
|
|
998
1047
|
|
|
999
|
-
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.2.
|
|
1048
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.2.5/src/commands/autocomplete/index.ts)_
|
|
1000
1049
|
|
|
1001
1050
|
## `sf commands`
|
|
1002
1051
|
|
|
@@ -1025,7 +1074,7 @@ DESCRIPTION
|
|
|
1025
1074
|
List all sf commands.
|
|
1026
1075
|
```
|
|
1027
1076
|
|
|
1028
|
-
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.
|
|
1077
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.1.3/src/commands/commands.ts)_
|
|
1029
1078
|
|
|
1030
1079
|
## `sf config get`
|
|
1031
1080
|
|
|
@@ -1074,7 +1123,7 @@ CONFIGURATION VARIABLES
|
|
|
1074
1123
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1075
1124
|
```
|
|
1076
1125
|
|
|
1077
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
1126
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/config/get.ts)_
|
|
1078
1127
|
|
|
1079
1128
|
## `sf config list`
|
|
1080
1129
|
|
|
@@ -1114,7 +1163,7 @@ EXAMPLES
|
|
|
1114
1163
|
$ sf config list
|
|
1115
1164
|
```
|
|
1116
1165
|
|
|
1117
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
1166
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/config/list.ts)_
|
|
1118
1167
|
|
|
1119
1168
|
## `sf config set`
|
|
1120
1169
|
|
|
@@ -1183,7 +1232,7 @@ CONFIGURATION VARIABLES
|
|
|
1183
1232
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1184
1233
|
```
|
|
1185
1234
|
|
|
1186
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
1235
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/config/set.ts)_
|
|
1187
1236
|
|
|
1188
1237
|
## `sf config unset`
|
|
1189
1238
|
|
|
@@ -1233,7 +1282,7 @@ CONFIGURATION VARIABLES
|
|
|
1233
1282
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1234
1283
|
```
|
|
1235
1284
|
|
|
1236
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.
|
|
1285
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/config/unset.ts)_
|
|
1237
1286
|
|
|
1238
1287
|
## `sf data create file`
|
|
1239
1288
|
|
|
@@ -1282,7 +1331,7 @@ EXAMPLES
|
|
|
1282
1331
|
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
|
|
1283
1332
|
```
|
|
1284
1333
|
|
|
1285
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1334
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/create/file.ts)_
|
|
1286
1335
|
|
|
1287
1336
|
## `sf data create record`
|
|
1288
1337
|
|
|
@@ -1338,7 +1387,7 @@ EXAMPLES
|
|
|
1338
1387
|
TracedEntityId=01p17000000R6bLAAS"
|
|
1339
1388
|
```
|
|
1340
1389
|
|
|
1341
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1390
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/create/record.ts)_
|
|
1342
1391
|
|
|
1343
1392
|
## `sf data delete bulk`
|
|
1344
1393
|
|
|
@@ -1396,7 +1445,7 @@ FLAG DESCRIPTIONS
|
|
|
1396
1445
|
and can be enabled only by a system administrator.
|
|
1397
1446
|
```
|
|
1398
1447
|
|
|
1399
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1448
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/delete/bulk.ts)_
|
|
1400
1449
|
|
|
1401
1450
|
## `sf data delete record`
|
|
1402
1451
|
|
|
@@ -1457,7 +1506,7 @@ EXAMPLES
|
|
|
1457
1506
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1458
1507
|
```
|
|
1459
1508
|
|
|
1460
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1509
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/delete/record.ts)_
|
|
1461
1510
|
|
|
1462
1511
|
## `sf data delete resume`
|
|
1463
1512
|
|
|
@@ -1496,7 +1545,117 @@ EXAMPLES
|
|
|
1496
1545
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
1497
1546
|
```
|
|
1498
1547
|
|
|
1499
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1548
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/delete/resume.ts)_
|
|
1549
|
+
|
|
1550
|
+
## `sf data export bulk`
|
|
1551
|
+
|
|
1552
|
+
Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.
|
|
1553
|
+
|
|
1554
|
+
```
|
|
1555
|
+
USAGE
|
|
1556
|
+
$ sf data export bulk -o <value> --output-file <value> -r csv|json [--json] [--flags-dir <value>] [--api-version
|
|
1557
|
+
<value>] [-w <minutes> | --async] [-q <value> | --query-file <value>] [--all-rows] [--column-delimiter
|
|
1558
|
+
BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB] [--line-ending LF|CRLF]
|
|
1559
|
+
|
|
1560
|
+
FLAGS
|
|
1561
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1562
|
+
configuration variable is already set.
|
|
1563
|
+
-q, --query=<value> SOQL query to execute.
|
|
1564
|
+
-r, --result-format=<option> (required) [default: csv] Format to write the results.
|
|
1565
|
+
<options: csv|json>
|
|
1566
|
+
-w, --wait=<minutes> Time to wait for the command to finish, in minutes.
|
|
1567
|
+
--all-rows Include records that have been soft-deleted due to a merge or delete. By default,
|
|
1568
|
+
deleted records are not returned.
|
|
1569
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1570
|
+
--async Don't wait for the job to complete.
|
|
1571
|
+
--column-delimiter=<option> Column delimiter to be used when writing CSV output. Default is COMMA.
|
|
1572
|
+
<options: BACKQUOTE|CARET|COMMA|PIPE|SEMICOLON|TAB>
|
|
1573
|
+
--line-ending=<option> Line ending to be used when writing CSV output. Default value on Windows is is
|
|
1574
|
+
`CRLF`; on macOS and Linux it's `LR`.
|
|
1575
|
+
<options: LF|CRLF>
|
|
1576
|
+
--output-file=<value> (required) File where records are written.
|
|
1577
|
+
--query-file=<value> File that contains the SOQL query.
|
|
1578
|
+
|
|
1579
|
+
GLOBAL FLAGS
|
|
1580
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1581
|
+
--json Format output as json.
|
|
1582
|
+
|
|
1583
|
+
DESCRIPTION
|
|
1584
|
+
Bulk export records from an org into a file using a SOQL query. Uses Bulk API 2.0.
|
|
1585
|
+
|
|
1586
|
+
You can use this command to export millions of records from an org, either to migrate data or to back it up.
|
|
1587
|
+
|
|
1588
|
+
Use a SOQL query to specify the fields of a standard or custom object that you want to export. Specify the SOQL query
|
|
1589
|
+
either at the command line with the --query flag or read it from a file with the --query-file flag; you can't specify
|
|
1590
|
+
both flags. The --output-file flag is required, which means you can only write the records to a file, in either CSV or
|
|
1591
|
+
JSON format.
|
|
1592
|
+
|
|
1593
|
+
Bulk exports can take a while, depending on how many records are returned by the SOQL query. If the command times out,
|
|
1594
|
+
or you specified the --async flag, the command displays the job ID. To see the status and get the results of the job,
|
|
1595
|
+
run "sf data export resume" and pass the job ID to the --job-id flag.
|
|
1596
|
+
|
|
1597
|
+
IMPORTANT: This command uses Bulk API 2.0, which limits the type of SOQL queries you can run. For example, you can't
|
|
1598
|
+
use aggregate functions such as count(). For the complete list of limitations, see the "SOQL Considerations" section
|
|
1599
|
+
in the "Bulk API 2.0 and Bulk API Developer Guide"
|
|
1600
|
+
(https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm).
|
|
1601
|
+
|
|
1602
|
+
EXAMPLES
|
|
1603
|
+
Export the Id, Name, and Account.Name fields of the Contact object into a CSV-formatted file; if the export doesn't
|
|
1604
|
+
complete in 10 minutes, the command ends and displays a job ID. Use the org with alias "my-scratch":
|
|
1605
|
+
|
|
1606
|
+
$ sf data export bulk --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.csv \
|
|
1607
|
+
--wait 10 --target-org my-scratch
|
|
1608
|
+
|
|
1609
|
+
Similar to previous example, but use the default org, export the records into a JSON-formatted file, and include
|
|
1610
|
+
records that have been soft deleted:
|
|
1611
|
+
|
|
1612
|
+
$ sf data export bulk --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.json \
|
|
1613
|
+
--result-format json --wait 10 --all-rows
|
|
1614
|
+
|
|
1615
|
+
Export asynchronously; the command immediately returns a job ID that you then pass to the "sf data export resume"
|
|
1616
|
+
command:
|
|
1617
|
+
|
|
1618
|
+
$ sf data export bulk --query "SELECT Id, Name, Account.Name FROM Contact" --output-file export-accounts.json \
|
|
1619
|
+
--result-format json --async
|
|
1620
|
+
```
|
|
1621
|
+
|
|
1622
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/export/bulk.ts)_
|
|
1623
|
+
|
|
1624
|
+
## `sf data export resume`
|
|
1625
|
+
|
|
1626
|
+
Resume a bulk export job that you previously started.
|
|
1627
|
+
|
|
1628
|
+
```
|
|
1629
|
+
USAGE
|
|
1630
|
+
$ sf data export resume [--json] [--flags-dir <value>] [-i <value>] [--use-most-recent] [--api-version <value>]
|
|
1631
|
+
|
|
1632
|
+
FLAGS
|
|
1633
|
+
-i, --job-id=<value> Job ID of the bulk export.
|
|
1634
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1635
|
+
--use-most-recent Use the job ID of the bulk export job that was most recently run.
|
|
1636
|
+
|
|
1637
|
+
GLOBAL FLAGS
|
|
1638
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1639
|
+
--json Format output as json.
|
|
1640
|
+
|
|
1641
|
+
DESCRIPTION
|
|
1642
|
+
Resume a bulk export job that you previously started.
|
|
1643
|
+
|
|
1644
|
+
When the original "data export bulk" command either times out or is run with the --async flag, it displays a job ID.
|
|
1645
|
+
To see the status and get the results of the bulk export, run this command by either passing it the job ID or using
|
|
1646
|
+
the --use-most-recent flag to specify the most recent bulk export job.
|
|
1647
|
+
|
|
1648
|
+
EXAMPLES
|
|
1649
|
+
Resume a bulk export job run on your default org by specifying a job ID:
|
|
1650
|
+
|
|
1651
|
+
$ sf data export resume --job-id 750xx000000005sAAA
|
|
1652
|
+
|
|
1653
|
+
Resume the most recently-run bulk export job for an org with alias my-scratch:
|
|
1654
|
+
|
|
1655
|
+
$ sf data export resume --use-most-recent --target-org my-scratch
|
|
1656
|
+
```
|
|
1657
|
+
|
|
1658
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/export/resume.ts)_
|
|
1500
1659
|
|
|
1501
1660
|
## `sf data export tree`
|
|
1502
1661
|
|
|
@@ -1557,7 +1716,7 @@ EXAMPLES
|
|
|
1557
1716
|
my-scratch
|
|
1558
1717
|
```
|
|
1559
1718
|
|
|
1560
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1719
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/export/tree.ts)_
|
|
1561
1720
|
|
|
1562
1721
|
## `sf data get record`
|
|
1563
1722
|
|
|
@@ -1621,7 +1780,7 @@ EXAMPLES
|
|
|
1621
1780
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
1622
1781
|
```
|
|
1623
1782
|
|
|
1624
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1783
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/get/record.ts)_
|
|
1625
1784
|
|
|
1626
1785
|
## `sf data import tree`
|
|
1627
1786
|
|
|
@@ -1686,7 +1845,7 @@ FLAG DESCRIPTIONS
|
|
|
1686
1845
|
- files(array) - Files: An array of files paths to load
|
|
1687
1846
|
```
|
|
1688
1847
|
|
|
1689
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1848
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/import/tree.ts)_
|
|
1690
1849
|
|
|
1691
1850
|
## `sf data query`
|
|
1692
1851
|
|
|
@@ -1750,7 +1909,7 @@ EXAMPLES
|
|
|
1750
1909
|
$ sf data query --query "SELECT Id FROM Contact" --bulk --wait 0
|
|
1751
1910
|
```
|
|
1752
1911
|
|
|
1753
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1912
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/query.ts)_
|
|
1754
1913
|
|
|
1755
1914
|
## `sf data query resume`
|
|
1756
1915
|
|
|
@@ -1788,7 +1947,7 @@ EXAMPLES
|
|
|
1788
1947
|
$ sf data query resume --bulk-query-id 7500x000005BdFzXXX
|
|
1789
1948
|
```
|
|
1790
1949
|
|
|
1791
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1950
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/query/resume.ts)_
|
|
1792
1951
|
|
|
1793
1952
|
## `sf data resume`
|
|
1794
1953
|
|
|
@@ -1825,7 +1984,7 @@ EXAMPLES
|
|
|
1825
1984
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
1826
1985
|
```
|
|
1827
1986
|
|
|
1828
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
1987
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/resume.ts)_
|
|
1829
1988
|
|
|
1830
1989
|
## `sf data search`
|
|
1831
1990
|
|
|
@@ -1875,7 +2034,7 @@ EXAMPLES
|
|
|
1875
2034
|
$ sf data search --file query.txt --target-org my-scratch --result-format csv
|
|
1876
2035
|
```
|
|
1877
2036
|
|
|
1878
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2037
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/search.ts)_
|
|
1879
2038
|
|
|
1880
2039
|
## `sf data update record`
|
|
1881
2040
|
|
|
@@ -1937,7 +2096,7 @@ EXAMPLES
|
|
|
1937
2096
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
1938
2097
|
```
|
|
1939
2098
|
|
|
1940
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2099
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/update/record.ts)_
|
|
1941
2100
|
|
|
1942
2101
|
## `sf data upsert bulk`
|
|
1943
2102
|
|
|
@@ -1990,7 +2149,7 @@ EXAMPLES
|
|
|
1990
2149
|
my-scratch
|
|
1991
2150
|
```
|
|
1992
2151
|
|
|
1993
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2152
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/upsert/bulk.ts)_
|
|
1994
2153
|
|
|
1995
2154
|
## `sf data upsert resume`
|
|
1996
2155
|
|
|
@@ -2029,7 +2188,7 @@ EXAMPLES
|
|
|
2029
2188
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
2030
2189
|
```
|
|
2031
2190
|
|
|
2032
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2191
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/data/upsert/resume.ts)_
|
|
2033
2192
|
|
|
2034
2193
|
## `sf doctor`
|
|
2035
2194
|
|
|
@@ -2124,7 +2283,7 @@ EXAMPLES
|
|
|
2124
2283
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
2125
2284
|
```
|
|
2126
2285
|
|
|
2127
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2286
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/force/data/bulk/delete.ts)_
|
|
2128
2287
|
|
|
2129
2288
|
## `sf force data bulk status`
|
|
2130
2289
|
|
|
@@ -2161,7 +2320,7 @@ EXAMPLES
|
|
|
2161
2320
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
2162
2321
|
```
|
|
2163
2322
|
|
|
2164
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2323
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/force/data/bulk/status.ts)_
|
|
2165
2324
|
|
|
2166
2325
|
## `sf force data bulk upsert`
|
|
2167
2326
|
|
|
@@ -2219,7 +2378,7 @@ EXAMPLES
|
|
|
2219
2378
|
--target-org my-scratch
|
|
2220
2379
|
```
|
|
2221
2380
|
|
|
2222
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.
|
|
2381
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.7.0/src/commands/force/data/bulk/upsert.ts)_
|
|
2223
2382
|
|
|
2224
2383
|
## `sf help [COMMAND]`
|
|
2225
2384
|
|
|
@@ -2239,7 +2398,7 @@ DESCRIPTION
|
|
|
2239
2398
|
Display help for sf.
|
|
2240
2399
|
```
|
|
2241
2400
|
|
|
2242
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.
|
|
2401
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.14/src/commands/help.ts)_
|
|
2243
2402
|
|
|
2244
2403
|
## `sf info releasenotes display`
|
|
2245
2404
|
|
|
@@ -2334,7 +2493,7 @@ FLAG DESCRIPTIONS
|
|
|
2334
2493
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2335
2494
|
```
|
|
2336
2495
|
|
|
2337
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
2496
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/lightning/generate/app.ts)_
|
|
2338
2497
|
|
|
2339
2498
|
## `sf lightning generate component`
|
|
2340
2499
|
|
|
@@ -2403,7 +2562,7 @@ FLAG DESCRIPTIONS
|
|
|
2403
2562
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2404
2563
|
```
|
|
2405
2564
|
|
|
2406
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
2565
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/lightning/generate/component.ts)_
|
|
2407
2566
|
|
|
2408
2567
|
## `sf lightning generate event`
|
|
2409
2568
|
|
|
@@ -2458,7 +2617,7 @@ FLAG DESCRIPTIONS
|
|
|
2458
2617
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2459
2618
|
```
|
|
2460
2619
|
|
|
2461
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
2620
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/lightning/generate/event.ts)_
|
|
2462
2621
|
|
|
2463
2622
|
## `sf lightning generate interface`
|
|
2464
2623
|
|
|
@@ -2513,7 +2672,7 @@ FLAG DESCRIPTIONS
|
|
|
2513
2672
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2514
2673
|
```
|
|
2515
2674
|
|
|
2516
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
2675
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/lightning/generate/interface.ts)_
|
|
2517
2676
|
|
|
2518
2677
|
## `sf lightning generate test`
|
|
2519
2678
|
|
|
@@ -2568,7 +2727,7 @@ FLAG DESCRIPTIONS
|
|
|
2568
2727
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
2569
2728
|
```
|
|
2570
2729
|
|
|
2571
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
2730
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/lightning/generate/test.ts)_
|
|
2572
2731
|
|
|
2573
2732
|
## `sf org assign permset`
|
|
2574
2733
|
|
|
@@ -2613,7 +2772,7 @@ EXAMPLES
|
|
|
2613
2772
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
2614
2773
|
```
|
|
2615
2774
|
|
|
2616
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.
|
|
2775
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.32/src/commands/org/assign/permset.ts)_
|
|
2617
2776
|
|
|
2618
2777
|
## `sf org assign permsetlicense`
|
|
2619
2778
|
|
|
@@ -2659,7 +2818,7 @@ EXAMPLES
|
|
|
2659
2818
|
user3
|
|
2660
2819
|
```
|
|
2661
2820
|
|
|
2662
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.
|
|
2821
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.32/src/commands/org/assign/permsetlicense.ts)_
|
|
2663
2822
|
|
|
2664
2823
|
## `sf org create sandbox`
|
|
2665
2824
|
|
|
@@ -2776,7 +2935,7 @@ FLAG DESCRIPTIONS
|
|
|
2776
2935
|
sandbox.
|
|
2777
2936
|
```
|
|
2778
2937
|
|
|
2779
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
2938
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/create/sandbox.ts)_
|
|
2780
2939
|
|
|
2781
2940
|
## `sf org create scratch`
|
|
2782
2941
|
|
|
@@ -2930,7 +3089,7 @@ FLAG DESCRIPTIONS
|
|
|
2930
3089
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
2931
3090
|
```
|
|
2932
3091
|
|
|
2933
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3092
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/create/scratch.ts)_
|
|
2934
3093
|
|
|
2935
3094
|
## `sf org create user`
|
|
2936
3095
|
|
|
@@ -3038,7 +3197,7 @@ FLAG DESCRIPTIONS
|
|
|
3038
3197
|
might be different than what you specify in the definition file.
|
|
3039
3198
|
```
|
|
3040
3199
|
|
|
3041
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.
|
|
3200
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.32/src/commands/org/create/user.ts)_
|
|
3042
3201
|
|
|
3043
3202
|
## `sf org delete sandbox`
|
|
3044
3203
|
|
|
@@ -3084,7 +3243,7 @@ EXAMPLES
|
|
|
3084
3243
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
3085
3244
|
```
|
|
3086
3245
|
|
|
3087
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3246
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/delete/sandbox.ts)_
|
|
3088
3247
|
|
|
3089
3248
|
## `sf org delete scratch`
|
|
3090
3249
|
|
|
@@ -3128,7 +3287,7 @@ EXAMPLES
|
|
|
3128
3287
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
3129
3288
|
```
|
|
3130
3289
|
|
|
3131
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3290
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/delete/scratch.ts)_
|
|
3132
3291
|
|
|
3133
3292
|
## `sf org disable tracking`
|
|
3134
3293
|
|
|
@@ -3167,7 +3326,7 @@ EXAMPLES
|
|
|
3167
3326
|
$ sf org disable tracking
|
|
3168
3327
|
```
|
|
3169
3328
|
|
|
3170
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3329
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/disable/tracking.ts)_
|
|
3171
3330
|
|
|
3172
3331
|
## `sf org display`
|
|
3173
3332
|
|
|
@@ -3212,7 +3371,7 @@ EXAMPLES
|
|
|
3212
3371
|
$ sf org display --target-org TestOrg1 --verbose
|
|
3213
3372
|
```
|
|
3214
3373
|
|
|
3215
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3374
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/display.ts)_
|
|
3216
3375
|
|
|
3217
3376
|
## `sf org display user`
|
|
3218
3377
|
|
|
@@ -3251,7 +3410,7 @@ EXAMPLES
|
|
|
3251
3410
|
$ sf org display user --target-org me@my.org --json
|
|
3252
3411
|
```
|
|
3253
3412
|
|
|
3254
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.
|
|
3413
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.32/src/commands/org/display/user.ts)_
|
|
3255
3414
|
|
|
3256
3415
|
## `sf org enable tracking`
|
|
3257
3416
|
|
|
@@ -3293,7 +3452,7 @@ EXAMPLES
|
|
|
3293
3452
|
$ sf org enable tracking
|
|
3294
3453
|
```
|
|
3295
3454
|
|
|
3296
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3455
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/enable/tracking.ts)_
|
|
3297
3456
|
|
|
3298
3457
|
## `sf org generate password`
|
|
3299
3458
|
|
|
@@ -3360,7 +3519,7 @@ EXAMPLES
|
|
|
3360
3519
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
3361
3520
|
```
|
|
3362
3521
|
|
|
3363
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.
|
|
3522
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.32/src/commands/org/generate/password.ts)_
|
|
3364
3523
|
|
|
3365
3524
|
## `sf org list`
|
|
3366
3525
|
|
|
@@ -3399,7 +3558,7 @@ EXAMPLES
|
|
|
3399
3558
|
$ sf org list --clean
|
|
3400
3559
|
```
|
|
3401
3560
|
|
|
3402
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3561
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/list.ts)_
|
|
3403
3562
|
|
|
3404
3563
|
## `sf org list auth`
|
|
3405
3564
|
|
|
@@ -3431,7 +3590,7 @@ EXAMPLES
|
|
|
3431
3590
|
$ sf org list auth
|
|
3432
3591
|
```
|
|
3433
3592
|
|
|
3434
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3593
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.65/src/commands/org/list/auth.ts)_
|
|
3435
3594
|
|
|
3436
3595
|
## `sf org list limits`
|
|
3437
3596
|
|
|
@@ -3538,7 +3697,7 @@ FLAG DESCRIPTIONS
|
|
|
3538
3697
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
3539
3698
|
```
|
|
3540
3699
|
|
|
3541
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3700
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/list/metadata.ts)_
|
|
3542
3701
|
|
|
3543
3702
|
## `sf org list metadata-types`
|
|
3544
3703
|
|
|
@@ -3593,7 +3752,7 @@ FLAG DESCRIPTIONS
|
|
|
3593
3752
|
Override the api version used for api requests made by this command
|
|
3594
3753
|
```
|
|
3595
3754
|
|
|
3596
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
3755
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/list/metadata-types.ts)_
|
|
3597
3756
|
|
|
3598
3757
|
## `sf org list sobject record-counts`
|
|
3599
3758
|
|
|
@@ -3677,7 +3836,7 @@ EXAMPLES
|
|
|
3677
3836
|
$ sf org list users --target-org me@my.org
|
|
3678
3837
|
```
|
|
3679
3838
|
|
|
3680
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.
|
|
3839
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.5.32/src/commands/org/list/users.ts)_
|
|
3681
3840
|
|
|
3682
3841
|
## `sf org login access-token`
|
|
3683
3842
|
|
|
@@ -3731,7 +3890,7 @@ FLAG DESCRIPTIONS
|
|
|
3731
3890
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3732
3891
|
```
|
|
3733
3892
|
|
|
3734
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3893
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.65/src/commands/org/login/access-token.ts)_
|
|
3735
3894
|
|
|
3736
3895
|
## `sf org login device`
|
|
3737
3896
|
|
|
@@ -3791,7 +3950,7 @@ FLAG DESCRIPTIONS
|
|
|
3791
3950
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3792
3951
|
```
|
|
3793
3952
|
|
|
3794
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
3953
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.65/src/commands/org/login/device.ts)_
|
|
3795
3954
|
|
|
3796
3955
|
## `sf org login jwt`
|
|
3797
3956
|
|
|
@@ -3882,7 +4041,7 @@ FLAG DESCRIPTIONS
|
|
|
3882
4041
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
3883
4042
|
```
|
|
3884
4043
|
|
|
3885
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
4044
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.65/src/commands/org/login/jwt.ts)_
|
|
3886
4045
|
|
|
3887
4046
|
## `sf org login sfdx-url`
|
|
3888
4047
|
|
|
@@ -3952,7 +4111,7 @@ EXAMPLES
|
|
|
3952
4111
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
3953
4112
|
```
|
|
3954
4113
|
|
|
3955
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
4114
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.65/src/commands/org/login/sfdx-url.ts)_
|
|
3956
4115
|
|
|
3957
4116
|
## `sf org login web`
|
|
3958
4117
|
|
|
@@ -4039,7 +4198,7 @@ FLAG DESCRIPTIONS
|
|
|
4039
4198
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
4040
4199
|
```
|
|
4041
4200
|
|
|
4042
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
4201
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.65/src/commands/org/login/web.ts)_
|
|
4043
4202
|
|
|
4044
4203
|
## `sf org logout`
|
|
4045
4204
|
|
|
@@ -4100,7 +4259,7 @@ FLAG DESCRIPTIONS
|
|
|
4100
4259
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
4101
4260
|
```
|
|
4102
4261
|
|
|
4103
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.
|
|
4262
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.6.65/src/commands/org/logout.ts)_
|
|
4104
4263
|
|
|
4105
4264
|
## `sf org open`
|
|
4106
4265
|
|
|
@@ -4172,7 +4331,7 @@ EXAMPLES
|
|
|
4172
4331
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
4173
4332
|
```
|
|
4174
4333
|
|
|
4175
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4334
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/open.ts)_
|
|
4176
4335
|
|
|
4177
4336
|
## `sf org refresh sandbox`
|
|
4178
4337
|
|
|
@@ -4249,7 +4408,7 @@ FLAG DESCRIPTIONS
|
|
|
4249
4408
|
By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
|
|
4250
4409
|
```
|
|
4251
4410
|
|
|
4252
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4411
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/refresh/sandbox.ts)_
|
|
4253
4412
|
|
|
4254
4413
|
## `sf org resume sandbox`
|
|
4255
4414
|
|
|
@@ -4312,7 +4471,7 @@ FLAG DESCRIPTIONS
|
|
|
4312
4471
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
4313
4472
|
```
|
|
4314
4473
|
|
|
4315
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4474
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/resume/sandbox.ts)_
|
|
4316
4475
|
|
|
4317
4476
|
## `sf org resume scratch`
|
|
4318
4477
|
|
|
@@ -4359,7 +4518,7 @@ FLAG DESCRIPTIONS
|
|
|
4359
4518
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
4360
4519
|
```
|
|
4361
4520
|
|
|
4362
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.
|
|
4521
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/resume/scratch.ts)_
|
|
4363
4522
|
|
|
4364
4523
|
## `sf package create`
|
|
4365
4524
|
|
|
@@ -4438,7 +4597,7 @@ FLAG DESCRIPTIONS
|
|
|
4438
4597
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
4439
4598
|
```
|
|
4440
4599
|
|
|
4441
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4600
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/create.ts)_
|
|
4442
4601
|
|
|
4443
4602
|
## `sf package delete`
|
|
4444
4603
|
|
|
@@ -4480,7 +4639,7 @@ EXAMPLES
|
|
|
4480
4639
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
4481
4640
|
```
|
|
4482
4641
|
|
|
4483
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4642
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/delete.ts)_
|
|
4484
4643
|
|
|
4485
4644
|
## `sf package install`
|
|
4486
4645
|
|
|
@@ -4579,7 +4738,7 @@ FLAG DESCRIPTIONS
|
|
|
4579
4738
|
- Delete: Delete all removed components that can be safely deleted, and deprecate the other components.
|
|
4580
4739
|
```
|
|
4581
4740
|
|
|
4582
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4741
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/install.ts)_
|
|
4583
4742
|
|
|
4584
4743
|
## `sf package install report`
|
|
4585
4744
|
|
|
@@ -4612,7 +4771,7 @@ EXAMPLES
|
|
|
4612
4771
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
4613
4772
|
```
|
|
4614
4773
|
|
|
4615
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4774
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/install/report.ts)_
|
|
4616
4775
|
|
|
4617
4776
|
## `sf package installed list`
|
|
4618
4777
|
|
|
@@ -4644,7 +4803,7 @@ EXAMPLES
|
|
|
4644
4803
|
$ sf package installed list --target-org me@example.com
|
|
4645
4804
|
```
|
|
4646
4805
|
|
|
4647
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4806
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/installed/list.ts)_
|
|
4648
4807
|
|
|
4649
4808
|
## `sf package list`
|
|
4650
4809
|
|
|
@@ -4682,7 +4841,7 @@ EXAMPLES
|
|
|
4682
4841
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
4683
4842
|
```
|
|
4684
4843
|
|
|
4685
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4844
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/list.ts)_
|
|
4686
4845
|
|
|
4687
4846
|
## `sf package uninstall`
|
|
4688
4847
|
|
|
@@ -4730,7 +4889,7 @@ EXAMPLES
|
|
|
4730
4889
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
4731
4890
|
```
|
|
4732
4891
|
|
|
4733
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4892
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/uninstall.ts)_
|
|
4734
4893
|
|
|
4735
4894
|
## `sf package uninstall report`
|
|
4736
4895
|
|
|
@@ -4763,7 +4922,7 @@ EXAMPLES
|
|
|
4763
4922
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
4764
4923
|
```
|
|
4765
4924
|
|
|
4766
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4925
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/uninstall/report.ts)_
|
|
4767
4926
|
|
|
4768
4927
|
## `sf package update`
|
|
4769
4928
|
|
|
@@ -4818,7 +4977,7 @@ FLAG DESCRIPTIONS
|
|
|
4818
4977
|
associated with your package.
|
|
4819
4978
|
```
|
|
4820
4979
|
|
|
4821
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
4980
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/update.ts)_
|
|
4822
4981
|
|
|
4823
4982
|
## `sf package version create`
|
|
4824
4983
|
|
|
@@ -4993,7 +5152,7 @@ FLAG DESCRIPTIONS
|
|
|
4993
5152
|
periods of no output from commands.
|
|
4994
5153
|
```
|
|
4995
5154
|
|
|
4996
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5155
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/create.ts)_
|
|
4997
5156
|
|
|
4998
5157
|
## `sf package version create list`
|
|
4999
5158
|
|
|
@@ -5054,7 +5213,7 @@ EXAMPLES
|
|
|
5054
5213
|
$ sf package version create list --created-last-days 0 --status Success
|
|
5055
5214
|
```
|
|
5056
5215
|
|
|
5057
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5216
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/create/list.ts)_
|
|
5058
5217
|
|
|
5059
5218
|
## `sf package version create report`
|
|
5060
5219
|
|
|
@@ -5097,7 +5256,7 @@ EXAMPLES
|
|
|
5097
5256
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
5098
5257
|
```
|
|
5099
5258
|
|
|
5100
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5259
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/create/report.ts)_
|
|
5101
5260
|
|
|
5102
5261
|
## `sf package version delete`
|
|
5103
5262
|
|
|
@@ -5138,7 +5297,7 @@ EXAMPLES
|
|
|
5138
5297
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
5139
5298
|
```
|
|
5140
5299
|
|
|
5141
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5300
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/delete.ts)_
|
|
5142
5301
|
|
|
5143
5302
|
## `sf package version displayancestry`
|
|
5144
5303
|
|
|
@@ -5198,7 +5357,7 @@ FLAG DESCRIPTIONS
|
|
|
5198
5357
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
5199
5358
|
```
|
|
5200
5359
|
|
|
5201
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5360
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/displayancestry.ts)_
|
|
5202
5361
|
|
|
5203
5362
|
## `sf package version list`
|
|
5204
5363
|
|
|
@@ -5274,7 +5433,7 @@ EXAMPLES
|
|
|
5274
5433
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
5275
5434
|
```
|
|
5276
5435
|
|
|
5277
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5436
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/list.ts)_
|
|
5278
5437
|
|
|
5279
5438
|
## `sf package version promote`
|
|
5280
5439
|
|
|
@@ -5318,7 +5477,7 @@ EXAMPLES
|
|
|
5318
5477
|
$ sf package version promote --package "Awesome Package Alias"
|
|
5319
5478
|
```
|
|
5320
5479
|
|
|
5321
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5480
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/promote.ts)_
|
|
5322
5481
|
|
|
5323
5482
|
## `sf package version report`
|
|
5324
5483
|
|
|
@@ -5358,7 +5517,7 @@ EXAMPLES
|
|
|
5358
5517
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
5359
5518
|
```
|
|
5360
5519
|
|
|
5361
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5520
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/report.ts)_
|
|
5362
5521
|
|
|
5363
5522
|
## `sf package version update`
|
|
5364
5523
|
|
|
@@ -5411,7 +5570,7 @@ EXAMPLES
|
|
|
5411
5570
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
5412
5571
|
```
|
|
5413
5572
|
|
|
5414
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5573
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package/version/update.ts)_
|
|
5415
5574
|
|
|
5416
5575
|
## `sf package1 version create`
|
|
5417
5576
|
|
|
@@ -5478,7 +5637,7 @@ FLAG DESCRIPTIONS
|
|
|
5478
5637
|
subscribers.
|
|
5479
5638
|
```
|
|
5480
5639
|
|
|
5481
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5640
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package1/version/create.ts)_
|
|
5482
5641
|
|
|
5483
5642
|
## `sf package1 version create get`
|
|
5484
5643
|
|
|
@@ -5511,7 +5670,7 @@ EXAMPLES
|
|
|
5511
5670
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
5512
5671
|
```
|
|
5513
5672
|
|
|
5514
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5673
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package1/version/create/get.ts)_
|
|
5515
5674
|
|
|
5516
5675
|
## `sf package1 version display`
|
|
5517
5676
|
|
|
@@ -5545,7 +5704,7 @@ EXAMPLES
|
|
|
5545
5704
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
5546
5705
|
```
|
|
5547
5706
|
|
|
5548
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5707
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package1/version/display.ts)_
|
|
5549
5708
|
|
|
5550
5709
|
## `sf package1 version list`
|
|
5551
5710
|
|
|
@@ -5583,7 +5742,7 @@ FLAG DESCRIPTIONS
|
|
|
5583
5742
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
5584
5743
|
```
|
|
5585
5744
|
|
|
5586
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.
|
|
5745
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.8.11/src/commands/package1/version/list.ts)_
|
|
5587
5746
|
|
|
5588
5747
|
## `sf plugins`
|
|
5589
5748
|
|
|
@@ -5606,7 +5765,7 @@ EXAMPLES
|
|
|
5606
5765
|
$ sf plugins
|
|
5607
5766
|
```
|
|
5608
5767
|
|
|
5609
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
5768
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.14/src/commands/plugins/index.ts)_
|
|
5610
5769
|
|
|
5611
5770
|
## `sf plugins discover`
|
|
5612
5771
|
|
|
@@ -5651,7 +5810,7 @@ EXAMPLES
|
|
|
5651
5810
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
5652
5811
|
```
|
|
5653
5812
|
|
|
5654
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
5813
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.14/src/commands/plugins/inspect.ts)_
|
|
5655
5814
|
|
|
5656
5815
|
## `sf plugins install PLUGIN`
|
|
5657
5816
|
|
|
@@ -5700,7 +5859,7 @@ EXAMPLES
|
|
|
5700
5859
|
$ sf plugins install someuser/someplugin
|
|
5701
5860
|
```
|
|
5702
5861
|
|
|
5703
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
5862
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.14/src/commands/plugins/install.ts)_
|
|
5704
5863
|
|
|
5705
5864
|
## `sf plugins link PATH`
|
|
5706
5865
|
|
|
@@ -5720,6 +5879,7 @@ FLAGS
|
|
|
5720
5879
|
|
|
5721
5880
|
DESCRIPTION
|
|
5722
5881
|
Links a plugin into the CLI for development.
|
|
5882
|
+
|
|
5723
5883
|
Installation of a linked plugin will override a user-installed or core plugin.
|
|
5724
5884
|
|
|
5725
5885
|
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
@@ -5730,7 +5890,7 @@ EXAMPLES
|
|
|
5730
5890
|
$ sf plugins link @salesforce/plugin-packaging
|
|
5731
5891
|
```
|
|
5732
5892
|
|
|
5733
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
5893
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.14/src/commands/plugins/link.ts)_
|
|
5734
5894
|
|
|
5735
5895
|
## `sf plugins reset`
|
|
5736
5896
|
|
|
@@ -5745,7 +5905,7 @@ FLAGS
|
|
|
5745
5905
|
--reinstall Reinstall all plugins after uninstalling.
|
|
5746
5906
|
```
|
|
5747
5907
|
|
|
5748
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
5908
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.14/src/commands/plugins/reset.ts)_
|
|
5749
5909
|
|
|
5750
5910
|
## `sf plugins trust verify`
|
|
5751
5911
|
|
|
@@ -5774,7 +5934,7 @@ EXAMPLES
|
|
|
5774
5934
|
$ sf plugins trust verify --npm @scope/npmName
|
|
5775
5935
|
```
|
|
5776
5936
|
|
|
5777
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.7.
|
|
5937
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.7.33/src/commands/plugins/trust/verify.ts)_
|
|
5778
5938
|
|
|
5779
5939
|
## `sf plugins uninstall [PLUGIN]`
|
|
5780
5940
|
|
|
@@ -5802,7 +5962,7 @@ EXAMPLES
|
|
|
5802
5962
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
5803
5963
|
```
|
|
5804
5964
|
|
|
5805
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
5965
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.14/src/commands/plugins/uninstall.ts)_
|
|
5806
5966
|
|
|
5807
5967
|
## `sf plugins update`
|
|
5808
5968
|
|
|
@@ -5820,7 +5980,7 @@ DESCRIPTION
|
|
|
5820
5980
|
Update installed plugins.
|
|
5821
5981
|
```
|
|
5822
5982
|
|
|
5823
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
5983
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.14/src/commands/plugins/update.ts)_
|
|
5824
5984
|
|
|
5825
5985
|
## `sf project convert mdapi`
|
|
5826
5986
|
|
|
@@ -5883,7 +6043,7 @@ FLAG DESCRIPTIONS
|
|
|
5883
6043
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
5884
6044
|
```
|
|
5885
6045
|
|
|
5886
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6046
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/convert/mdapi.ts)_
|
|
5887
6047
|
|
|
5888
6048
|
## `sf project convert source`
|
|
5889
6049
|
|
|
@@ -5956,7 +6116,7 @@ FLAG DESCRIPTIONS
|
|
|
5956
6116
|
Override the api version used for api requests made by this command
|
|
5957
6117
|
```
|
|
5958
6118
|
|
|
5959
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6119
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/convert/source.ts)_
|
|
5960
6120
|
|
|
5961
6121
|
## `sf project convert source-behavior`
|
|
5962
6122
|
|
|
@@ -5965,14 +6125,15 @@ Enable a behavior of your project source files, and then update your Salesforce
|
|
|
5965
6125
|
```
|
|
5966
6126
|
USAGE
|
|
5967
6127
|
$ sf project convert source-behavior -b
|
|
5968
|
-
decomposeCustomLabelsBeta2|decomposeCustomLabelsBeta|decomposePermissionSetBeta|
|
|
5969
|
-
|
|
6128
|
+
decomposeCustomLabelsBeta2|decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposePermissionSetBeta2|decompos
|
|
6129
|
+
eSharingRulesBeta|decomposeWorkflowBeta [--json] [--flags-dir <value>] [--dry-run] [--preserve-temp-dir] [-o
|
|
6130
|
+
<value>]
|
|
5970
6131
|
|
|
5971
6132
|
FLAGS
|
|
5972
6133
|
-b, --behavior=<option> (required) Behavior to enable; the values correspond to the possible values of the
|
|
5973
6134
|
"sourceBehaviorOption" option in the "sfdx-project.json" file.
|
|
5974
6135
|
<options: decomposeCustomLabelsBeta2|decomposeCustomLabelsBeta|decomposePermissionSetBeta|de
|
|
5975
|
-
|
|
6136
|
+
composePermissionSetBeta2|decomposeSharingRulesBeta|decomposeWorkflowBeta>
|
|
5976
6137
|
-o, --target-org=<value> Username or alias of the target org.
|
|
5977
6138
|
--dry-run Display what the command would do, but don't make any actual changes.
|
|
5978
6139
|
--preserve-temp-dir Don't delete the metadata API format temporary directory that this command creates. Useful
|
|
@@ -6013,7 +6174,7 @@ EXAMPLES
|
|
|
6013
6174
|
$ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
|
|
6014
6175
|
```
|
|
6015
6176
|
|
|
6016
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6177
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/convert/source-behavior.ts)_
|
|
6017
6178
|
|
|
6018
6179
|
## `sf project delete source`
|
|
6019
6180
|
|
|
@@ -6153,7 +6314,7 @@ FLAG DESCRIPTIONS
|
|
|
6153
6314
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
6154
6315
|
```
|
|
6155
6316
|
|
|
6156
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6317
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/delete/source.ts)_
|
|
6157
6318
|
|
|
6158
6319
|
## `sf project delete tracking`
|
|
6159
6320
|
|
|
@@ -6190,7 +6351,7 @@ EXAMPLES
|
|
|
6190
6351
|
$ sf project delete tracking --target-org my-scratch
|
|
6191
6352
|
```
|
|
6192
6353
|
|
|
6193
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6354
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/delete/tracking.ts)_
|
|
6194
6355
|
|
|
6195
6356
|
## `sf project deploy cancel`
|
|
6196
6357
|
|
|
@@ -6262,7 +6423,7 @@ FLAG DESCRIPTIONS
|
|
|
6262
6423
|
project deploy report".
|
|
6263
6424
|
```
|
|
6264
6425
|
|
|
6265
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6426
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/deploy/cancel.ts)_
|
|
6266
6427
|
|
|
6267
6428
|
## `sf project deploy preview`
|
|
6268
6429
|
|
|
@@ -6345,7 +6506,7 @@ FLAG DESCRIPTIONS
|
|
|
6345
6506
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
6346
6507
|
```
|
|
6347
6508
|
|
|
6348
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6509
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/deploy/preview.ts)_
|
|
6349
6510
|
|
|
6350
6511
|
## `sf project deploy quick`
|
|
6351
6512
|
|
|
@@ -6438,7 +6599,7 @@ ERROR CODES
|
|
|
6438
6599
|
Canceling (69) The deploy is being canceled.
|
|
6439
6600
|
```
|
|
6440
6601
|
|
|
6441
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6602
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/deploy/quick.ts)_
|
|
6442
6603
|
|
|
6443
6604
|
## `sf project deploy report`
|
|
6444
6605
|
|
|
@@ -6530,7 +6691,7 @@ FLAG DESCRIPTIONS
|
|
|
6530
6691
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6531
6692
|
```
|
|
6532
6693
|
|
|
6533
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6694
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/deploy/report.ts)_
|
|
6534
6695
|
|
|
6535
6696
|
## `sf project deploy resume`
|
|
6536
6697
|
|
|
@@ -6627,7 +6788,7 @@ ERROR CODES
|
|
|
6627
6788
|
Canceling (69) The deploy is being canceled.
|
|
6628
6789
|
```
|
|
6629
6790
|
|
|
6630
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
6791
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/deploy/resume.ts)_
|
|
6631
6792
|
|
|
6632
6793
|
## `sf project deploy start`
|
|
6633
6794
|
|
|
@@ -6880,7 +7041,7 @@ ERROR CODES
|
|
|
6880
7041
|
Canceling (69) The deploy is being canceled.
|
|
6881
7042
|
```
|
|
6882
7043
|
|
|
6883
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
7044
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/deploy/start.ts)_
|
|
6884
7045
|
|
|
6885
7046
|
## `sf project deploy validate`
|
|
6886
7047
|
|
|
@@ -7070,7 +7231,7 @@ ERROR CODES
|
|
|
7070
7231
|
Canceling (69) The deploy is being canceled.
|
|
7071
7232
|
```
|
|
7072
7233
|
|
|
7073
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
7234
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/deploy/validate.ts)_
|
|
7074
7235
|
|
|
7075
7236
|
## `sf project generate`
|
|
7076
7237
|
|
|
@@ -7175,7 +7336,7 @@ FLAG DESCRIPTIONS
|
|
|
7175
7336
|
Override the api version used for api requests made by this command
|
|
7176
7337
|
```
|
|
7177
7338
|
|
|
7178
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
7339
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/project/generate.ts)_
|
|
7179
7340
|
|
|
7180
7341
|
## `sf project generate manifest`
|
|
7181
7342
|
|
|
@@ -7252,7 +7413,7 @@ EXAMPLES
|
|
|
7252
7413
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
7253
7414
|
```
|
|
7254
7415
|
|
|
7255
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
7416
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/generate/manifest.ts)_
|
|
7256
7417
|
|
|
7257
7418
|
## `sf project list ignored`
|
|
7258
7419
|
|
|
@@ -7294,7 +7455,7 @@ EXAMPLES
|
|
|
7294
7455
|
$ sf project list ignored --source-dir package.xml
|
|
7295
7456
|
```
|
|
7296
7457
|
|
|
7297
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
7458
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/list/ignored.ts)_
|
|
7298
7459
|
|
|
7299
7460
|
## `sf project reset tracking`
|
|
7300
7461
|
|
|
@@ -7343,7 +7504,7 @@ EXAMPLES
|
|
|
7343
7504
|
$ sf project reset tracking --revision 30
|
|
7344
7505
|
```
|
|
7345
7506
|
|
|
7346
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
7507
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/reset/tracking.ts)_
|
|
7347
7508
|
|
|
7348
7509
|
## `sf project retrieve preview`
|
|
7349
7510
|
|
|
@@ -7397,7 +7558,7 @@ FLAG DESCRIPTIONS
|
|
|
7397
7558
|
production orgs.
|
|
7398
7559
|
```
|
|
7399
7560
|
|
|
7400
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
7561
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/retrieve/preview.ts)_
|
|
7401
7562
|
|
|
7402
7563
|
## `sf project retrieve start`
|
|
7403
7564
|
|
|
@@ -7574,7 +7735,7 @@ ENVIRONMENT VARIABLES
|
|
|
7574
7735
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7575
7736
|
```
|
|
7576
7737
|
|
|
7577
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.
|
|
7738
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.12.17/src/commands/project/retrieve/start.ts)_
|
|
7578
7739
|
|
|
7579
7740
|
## `sf schema generate field`
|
|
7580
7741
|
|
|
@@ -7628,7 +7789,7 @@ FLAG DESCRIPTIONS
|
|
|
7628
7789
|
If you don't specify this flag, the command prompts you to choose from your local objects.
|
|
7629
7790
|
```
|
|
7630
7791
|
|
|
7631
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
7792
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.41/src/commands/schema/generate/field.ts)_
|
|
7632
7793
|
|
|
7633
7794
|
## `sf schema generate platformevent`
|
|
7634
7795
|
|
|
@@ -7660,7 +7821,7 @@ EXAMPLES
|
|
|
7660
7821
|
$ sf schema generate platformevent --label "My Platform Event"
|
|
7661
7822
|
```
|
|
7662
7823
|
|
|
7663
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
7824
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.41/src/commands/schema/generate/platformevent.ts)_
|
|
7664
7825
|
|
|
7665
7826
|
## `sf schema generate sobject`
|
|
7666
7827
|
|
|
@@ -7717,7 +7878,7 @@ FLAG DESCRIPTIONS
|
|
|
7717
7878
|
- Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
|
|
7718
7879
|
```
|
|
7719
7880
|
|
|
7720
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
7881
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.41/src/commands/schema/generate/sobject.ts)_
|
|
7721
7882
|
|
|
7722
7883
|
## `sf schema generate tab`
|
|
7723
7884
|
|
|
@@ -7765,7 +7926,7 @@ FLAG DESCRIPTIONS
|
|
|
7765
7926
|
The API name for a custom object always ends in `__c`, such as `MyObject__c`.
|
|
7766
7927
|
```
|
|
7767
7928
|
|
|
7768
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
7929
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.41/src/commands/schema/generate/tab.ts)_
|
|
7769
7930
|
|
|
7770
7931
|
## `sf search`
|
|
7771
7932
|
|
|
@@ -7781,7 +7942,7 @@ DESCRIPTION
|
|
|
7781
7942
|
Once you select a command, hit enter and it will show the help for that command.
|
|
7782
7943
|
```
|
|
7783
7944
|
|
|
7784
|
-
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.2.
|
|
7945
|
+
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.2.11/src/commands/search.ts)_
|
|
7785
7946
|
|
|
7786
7947
|
## `sf sobject describe`
|
|
7787
7948
|
|
|
@@ -7828,7 +7989,7 @@ EXAMPLES
|
|
|
7828
7989
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
7829
7990
|
```
|
|
7830
7991
|
|
|
7831
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
7992
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.34/src/commands/sobject/describe.ts)_
|
|
7832
7993
|
|
|
7833
7994
|
## `sf sobject list`
|
|
7834
7995
|
|
|
@@ -7867,7 +8028,7 @@ EXAMPLES
|
|
|
7867
8028
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
7868
8029
|
```
|
|
7869
8030
|
|
|
7870
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
8031
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.34/src/commands/sobject/list.ts)_
|
|
7871
8032
|
|
|
7872
8033
|
## `sf static-resource generate`
|
|
7873
8034
|
|
|
@@ -7929,7 +8090,7 @@ FLAG DESCRIPTIONS
|
|
|
7929
8090
|
etc.
|
|
7930
8091
|
```
|
|
7931
8092
|
|
|
7932
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
8093
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/static-resource/generate.ts)_
|
|
7933
8094
|
|
|
7934
8095
|
## `sf update [CHANNEL]`
|
|
7935
8096
|
|
|
@@ -7937,10 +8098,11 @@ update the sf CLI
|
|
|
7937
8098
|
|
|
7938
8099
|
```
|
|
7939
8100
|
USAGE
|
|
7940
|
-
$ sf update [CHANNEL] [--force | | [-a | -v <value> | -i]]
|
|
8101
|
+
$ sf update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
|
|
7941
8102
|
|
|
7942
8103
|
FLAGS
|
|
7943
8104
|
-a, --available See available versions.
|
|
8105
|
+
-b, --verbose Show more details about the available versions.
|
|
7944
8106
|
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
|
|
7945
8107
|
-v, --version=<value> Install a specific version.
|
|
7946
8108
|
--force Force a re-download of the requested version.
|
|
@@ -7966,7 +8128,7 @@ EXAMPLES
|
|
|
7966
8128
|
$ sf update --available
|
|
7967
8129
|
```
|
|
7968
8130
|
|
|
7969
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.
|
|
8131
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.6.3/src/commands/update.ts)_
|
|
7970
8132
|
|
|
7971
8133
|
## `sf version`
|
|
7972
8134
|
|
|
@@ -7986,7 +8148,7 @@ FLAG DESCRIPTIONS
|
|
|
7986
8148
|
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
|
|
7987
8149
|
```
|
|
7988
8150
|
|
|
7989
|
-
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.
|
|
8151
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.14/src/commands/version.ts)_
|
|
7990
8152
|
|
|
7991
8153
|
## `sf visualforce generate component`
|
|
7992
8154
|
|
|
@@ -8042,7 +8204,7 @@ FLAG DESCRIPTIONS
|
|
|
8042
8204
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
8043
8205
|
```
|
|
8044
8206
|
|
|
8045
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
8207
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/visualforce/generate/component.ts)_
|
|
8046
8208
|
|
|
8047
8209
|
## `sf visualforce generate page`
|
|
8048
8210
|
|
|
@@ -8092,7 +8254,7 @@ FLAG DESCRIPTIONS
|
|
|
8092
8254
|
The name can be up to 40 characters and must start with a letter.
|
|
8093
8255
|
```
|
|
8094
8256
|
|
|
8095
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
8257
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/visualforce/generate/page.ts)_
|
|
8096
8258
|
|
|
8097
8259
|
## `sf which`
|
|
8098
8260
|
|
|
@@ -8126,7 +8288,7 @@ EXAMPLES
|
|
|
8126
8288
|
$ sf which "foo bar baz"
|
|
8127
8289
|
```
|
|
8128
8290
|
|
|
8129
|
-
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.2.
|
|
8291
|
+
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/3.2.15/src/commands/which.ts)_
|
|
8130
8292
|
|
|
8131
8293
|
<!-- commandsstop -->
|
|
8132
8294
|
|