@salesforce/cli 1.32.0 → 1.35.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/CHANGELOG.md +6 -0
- package/README.md +88 -25
- package/npm-shrinkwrap.json +411 -245
- package/oclif.manifest.json +1 -1
- package/package.json +9 -9
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
## [1.35.0](https://github.com/salesforcecli/cli/compare/v1.34.0...v1.35.0) (2022-06-29)
|
|
6
|
+
|
|
7
|
+
## [1.34.0](https://github.com/salesforcecli/cli/compare/v1.33.0...v1.34.0) (2022-06-22)
|
|
8
|
+
|
|
9
|
+
## [1.33.0](https://github.com/salesforcecli/cli/compare/v1.32.0...v1.33.0) (2022-06-15)
|
|
10
|
+
|
|
5
11
|
## [1.32.0](https://github.com/salesforcecli/cli/compare/v1.31.0...v1.32.0) (2022-06-08)
|
|
6
12
|
|
|
7
13
|
## [1.31.0](https://github.com/salesforcecli/cli/compare/v1.30.0...v1.31.0) (2022-06-02)
|
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@ $ npm install -g @salesforce/cli
|
|
|
31
31
|
$ sf COMMAND
|
|
32
32
|
running command...
|
|
33
33
|
$ sf (--version|-v)
|
|
34
|
-
@salesforce/cli/1.
|
|
34
|
+
@salesforce/cli/1.35.0 linux-x64 node-v14.19.3
|
|
35
35
|
$ sf --help [COMMAND]
|
|
36
36
|
USAGE
|
|
37
37
|
$ sf COMMAND
|
|
@@ -338,7 +338,7 @@ EXAMPLES
|
|
|
338
338
|
$ sf deploy --interactive
|
|
339
339
|
```
|
|
340
340
|
|
|
341
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.
|
|
341
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.5.2/src/commands/deploy.ts)_
|
|
342
342
|
|
|
343
343
|
## `sf deploy functions`
|
|
344
344
|
|
|
@@ -360,12 +360,13 @@ Deploy metadata in source format to an org from your local project.
|
|
|
360
360
|
|
|
361
361
|
```
|
|
362
362
|
USAGE
|
|
363
|
-
$ sf deploy metadata [--json] [-a <value>] [--async | -w <value>] [--concise | --verbose] [--dry-run] [-
|
|
364
|
-
<value>
|
|
365
|
-
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg]
|
|
363
|
+
$ sf deploy metadata [--json] [-a <value>] [--async | -w <value>] [--concise | --verbose] [--dry-run] [-c] [-r]
|
|
364
|
+
[-g] [-x <value> | -d <value> | -m <value> | --metadata-dir <value>] [--single-package ] [-o <value>] [-t <value>]
|
|
365
|
+
[-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg]
|
|
366
366
|
|
|
367
367
|
FLAGS
|
|
368
368
|
-a, --api-version=<value> Target API version for the deploy.
|
|
369
|
+
-c, --ignore-conflicts Ignore conflicts and deploy local files, even if they overwrite changes in the org.
|
|
369
370
|
-d, --source-dir=<value>... Path to the local source files to deploy.
|
|
370
371
|
-g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
|
|
371
372
|
-l, --test-level=<option> [default: NoTestRun] Deployment Apex testing level.
|
|
@@ -393,14 +394,19 @@ DESCRIPTION
|
|
|
393
394
|
|
|
394
395
|
You must run this command from within a project.
|
|
395
396
|
|
|
396
|
-
|
|
397
|
-
|
|
397
|
+
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
|
|
398
|
+
org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox
|
|
399
|
+
org to disable source tracking.
|
|
398
400
|
|
|
399
401
|
To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with
|
|
400
402
|
multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax
|
|
401
403
|
applies to --manifest and --source-dir.
|
|
402
404
|
|
|
403
405
|
EXAMPLES
|
|
406
|
+
Deploy local changes not in the org:
|
|
407
|
+
|
|
408
|
+
$ sf deploy metadata
|
|
409
|
+
|
|
404
410
|
Deploy the source files in a directory:
|
|
405
411
|
|
|
406
412
|
$ sf deploy metadata --source-dir path/to/source
|
|
@@ -441,6 +447,11 @@ FLAG DESCRIPTIONS
|
|
|
441
447
|
Use this flag to override the default API version, which is the latest version supported the CLI, with the API
|
|
442
448
|
version of your package.xml file.
|
|
443
449
|
|
|
450
|
+
-c, --ignore-conflicts Ignore conflicts and deploy local files, even if they overwrite changes in the org.
|
|
451
|
+
|
|
452
|
+
This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as
|
|
453
|
+
production orgs.
|
|
454
|
+
|
|
444
455
|
-d, --source-dir=<value>... Path to the local source files to deploy.
|
|
445
456
|
|
|
446
457
|
The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder
|
|
@@ -988,7 +999,7 @@ Create a sandbox org.
|
|
|
988
999
|
```
|
|
989
1000
|
USAGE
|
|
990
1001
|
$ sf env create sandbox [--json] [-f <value> | -n <value> | -l Developer|Developer_Pro|Partial|Full] [-s] [-a <value>]
|
|
991
|
-
[-w <value> | --async] [-i <value> | ] [-c <value> | ] [-o <value>] [--no-prompt]
|
|
1002
|
+
[-w <value> | --async] [-i <value> | ] [-c <value> | ] [-o <value>] [--no-prompt] [--no-track-source]
|
|
992
1003
|
|
|
993
1004
|
FLAGS
|
|
994
1005
|
-a, --alias=<value> Alias for the sandbox org.
|
|
@@ -1007,6 +1018,7 @@ FLAGS
|
|
|
1007
1018
|
complete.
|
|
1008
1019
|
--no-prompt Don't prompt for confirmation about the sandbox
|
|
1009
1020
|
configuration.
|
|
1021
|
+
--no-track-source Do not use source tracking for this sandbox.
|
|
1010
1022
|
|
|
1011
1023
|
GLOBAL FLAGS
|
|
1012
1024
|
--json Format output as json.
|
|
@@ -1047,8 +1059,8 @@ FLAG DESCRIPTIONS
|
|
|
1047
1059
|
|
|
1048
1060
|
The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each
|
|
1049
1061
|
sandbox type that you use in the development process. See
|
|
1050
|
-
https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm for all
|
|
1051
|
-
options you can specify in the defintion file.
|
|
1062
|
+
<https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all
|
|
1063
|
+
the options you can specify in the defintion file.
|
|
1052
1064
|
|
|
1053
1065
|
-n, --name=<value> Name of the sandbox org.
|
|
1054
1066
|
|
|
@@ -1070,6 +1082,18 @@ FLAG DESCRIPTIONS
|
|
|
1070
1082
|
|
|
1071
1083
|
The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue
|
|
1072
1084
|
to use the CLI. To check the status of the sandbox creation, run "sf env resume sandbox".
|
|
1085
|
+
|
|
1086
|
+
--no-track-source Do not use source tracking for this sandbox.
|
|
1087
|
+
|
|
1088
|
+
We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default
|
|
1089
|
+
behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and
|
|
1090
|
+
in the sandbox, and to detect any conflicts between the two.
|
|
1091
|
+
|
|
1092
|
+
To disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source
|
|
1093
|
+
tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your
|
|
1094
|
+
CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the
|
|
1095
|
+
SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the
|
|
1096
|
+
sandbox.
|
|
1073
1097
|
```
|
|
1074
1098
|
|
|
1075
1099
|
## `sf env create scratch`
|
|
@@ -1080,7 +1104,7 @@ Create a scratch org.
|
|
|
1080
1104
|
USAGE
|
|
1081
1105
|
$ sf env create scratch [--json] [-a <value>] [--async] [-d] [-f <value>] [-v <value>] [-c] [-e
|
|
1082
1106
|
developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
|
|
1083
|
-
[-m] [-y <value>] [-w <value>] [--api-version <value>] [-i <value>]
|
|
1107
|
+
[-m] [-y <value>] [-w <value>] [--api-version <value>] [-i <value>] [-t]
|
|
1084
1108
|
|
|
1085
1109
|
FLAGS
|
|
1086
1110
|
-a, --alias=<value> Alias for the scratch org.
|
|
@@ -1090,6 +1114,8 @@ FLAGS
|
|
|
1090
1114
|
partner-group|partner-professional>
|
|
1091
1115
|
-f, --definition-file=<value> Path to a scratch org definition file.
|
|
1092
1116
|
-i, --client-id=<value> Consumer key of the Dev Hub connected app.
|
|
1117
|
+
-t, --[no-]track-source Use source tracking for this scratch org. Set --no-track-source to disable source
|
|
1118
|
+
tracking.
|
|
1093
1119
|
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
1094
1120
|
-w, --wait=<minutes> [default: [object Object]] Number of minutes to wait for the scratch org to be ready.
|
|
1095
1121
|
-y, --duration-days=<days> [default: [object Object]] Number of days before the org expires.
|
|
@@ -1144,6 +1170,18 @@ FLAG DESCRIPTIONS
|
|
|
1144
1170
|
<https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for
|
|
1145
1171
|
all the option you can specify in the definition file.
|
|
1146
1172
|
|
|
1173
|
+
-t, --[no-]track-source Use source tracking for this scratch org. Set --no-track-source to disable source tracking.
|
|
1174
|
+
|
|
1175
|
+
We recommend you enable source tracking in scratch orgs, which is why it's the default behavior. Source tracking
|
|
1176
|
+
allows you to track the changes you make to your metadata, both in your local project and in the scratch org, and to
|
|
1177
|
+
detect any conflicts between the two.
|
|
1178
|
+
|
|
1179
|
+
To disable source tracking in the new scratch org, specify the --no-track-source flag. The main reason to disable
|
|
1180
|
+
source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in
|
|
1181
|
+
your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the
|
|
1182
|
+
SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the
|
|
1183
|
+
scratch org.
|
|
1184
|
+
|
|
1147
1185
|
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
1148
1186
|
|
|
1149
1187
|
Overrides the value of the target-dev-hub configuration variable, if set.
|
|
@@ -1904,7 +1942,7 @@ EXAMPLES
|
|
|
1904
1942
|
$ sf login
|
|
1905
1943
|
```
|
|
1906
1944
|
|
|
1907
|
-
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.
|
|
1945
|
+
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.1.1/src/commands/login.ts)_
|
|
1908
1946
|
|
|
1909
1947
|
## `sf login functions`
|
|
1910
1948
|
|
|
@@ -2039,8 +2077,8 @@ FLAG DESCRIPTIONS
|
|
|
2039
2077
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
2040
2078
|
|
|
2041
2079
|
CONFIGURATION VARIABLES
|
|
2042
|
-
apiVersion API version of your project. Default: API version of your Dev Hub org.
|
|
2043
|
-
instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com.
|
|
2080
|
+
apiVersion API version of your project. Default: API version of your Dev Hub org. (sfdx only)
|
|
2081
|
+
instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)
|
|
2044
2082
|
|
|
2045
2083
|
ENVIRONMENT VARIABLES
|
|
2046
2084
|
SFDX_INSTANCE_URL URL of the Salesforce instance that is hosting your org. Default value is
|
|
@@ -2130,8 +2168,8 @@ FLAG DESCRIPTIONS
|
|
|
2130
2168
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
2131
2169
|
|
|
2132
2170
|
CONFIGURATION VARIABLES
|
|
2133
|
-
apiVersion API version of your project. Default: API version of your Dev Hub org.
|
|
2134
|
-
instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com.
|
|
2171
|
+
apiVersion API version of your project. Default: API version of your Dev Hub org. (sfdx only)
|
|
2172
|
+
instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)
|
|
2135
2173
|
|
|
2136
2174
|
ENVIRONMENT VARIABLES
|
|
2137
2175
|
SFDX_INSTANCE_URL URL of the Salesforce instance that is hosting your org. Default value is
|
|
@@ -2171,7 +2209,7 @@ EXAMPLES
|
|
|
2171
2209
|
$ sf logout --no-prompt
|
|
2172
2210
|
```
|
|
2173
2211
|
|
|
2174
|
-
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.
|
|
2212
|
+
_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.1.1/src/commands/logout.ts)_
|
|
2175
2213
|
|
|
2176
2214
|
## `sf logout functions`
|
|
2177
2215
|
|
|
@@ -2221,8 +2259,8 @@ EXAMPLES
|
|
|
2221
2259
|
$ sf logout org --target-org jdoe@example.org
|
|
2222
2260
|
|
|
2223
2261
|
CONFIGURATION VARIABLES
|
|
2224
|
-
apiVersion API version of your project. Default: API version of your Dev Hub org.
|
|
2225
|
-
instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com.
|
|
2262
|
+
apiVersion API version of your project. Default: API version of your Dev Hub org. (sfdx only)
|
|
2263
|
+
instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)
|
|
2226
2264
|
target-org Username or alias of the org that all commands run against by default. (sf only)
|
|
2227
2265
|
```
|
|
2228
2266
|
|
|
@@ -2462,11 +2500,13 @@ Retrieve metadata in source format from an org to your local project.
|
|
|
2462
2500
|
|
|
2463
2501
|
```
|
|
2464
2502
|
USAGE
|
|
2465
|
-
$ sf retrieve metadata [--json] [-a <value>] [-x <value> | -m <value> | -d <value>] [-n <value>] [-o <value>]
|
|
2466
|
-
<value>]
|
|
2503
|
+
$ sf retrieve metadata [--json] [-a <value>] [-c] [-x <value> | -m <value> | -d <value>] [-n <value>] [-o <value>]
|
|
2504
|
+
[-w <value>]
|
|
2467
2505
|
|
|
2468
2506
|
FLAGS
|
|
2469
2507
|
-a, --api-version=<value> Target API version for the retrieve.
|
|
2508
|
+
-c, --ignore-conflicts Ignore conflicts and retrieve and save files to your local filesystem, even if they
|
|
2509
|
+
overwrite your local changes.
|
|
2470
2510
|
-d, --source-dir=<value>... File paths for source to retrieve from the org.
|
|
2471
2511
|
-m, --metadata=<value>... Metadata component names to retrieve.
|
|
2472
2512
|
-n, --package-name=<value>... Package names to retrieve.
|
|
@@ -2483,14 +2523,19 @@ DESCRIPTION
|
|
|
2483
2523
|
|
|
2484
2524
|
You must run this command from within a project.
|
|
2485
2525
|
|
|
2486
|
-
|
|
2487
|
-
|
|
2526
|
+
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
|
|
2527
|
+
org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox
|
|
2528
|
+
org to disable source tracking.
|
|
2488
2529
|
|
|
2489
2530
|
To retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag
|
|
2490
2531
|
with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same
|
|
2491
2532
|
syntax applies to --manifest and --source-dir.
|
|
2492
2533
|
|
|
2493
2534
|
EXAMPLES
|
|
2535
|
+
Retrieve remote changes:
|
|
2536
|
+
|
|
2537
|
+
$ sf retrieve metadata
|
|
2538
|
+
|
|
2494
2539
|
Retrieve the source files in a directory:
|
|
2495
2540
|
|
|
2496
2541
|
$ sf retrieve metadata --source-dir path/to/source
|
|
@@ -2532,6 +2577,13 @@ FLAG DESCRIPTIONS
|
|
|
2532
2577
|
Use this flag to override the default API version, which is the latest version supported the CLI, with the API
|
|
2533
2578
|
version in your package.xml file.
|
|
2534
2579
|
|
|
2580
|
+
-c, --ignore-conflicts
|
|
2581
|
+
|
|
2582
|
+
Ignore conflicts and retrieve and save files to your local filesystem, even if they overwrite your local changes.
|
|
2583
|
+
|
|
2584
|
+
This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as
|
|
2585
|
+
production orgs.
|
|
2586
|
+
|
|
2535
2587
|
-d, --source-dir=<value>... File paths for source to retrieve from the org.
|
|
2536
2588
|
|
|
2537
2589
|
The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
|
|
@@ -2724,10 +2776,21 @@ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3
|
|
|
2724
2776
|
|
|
2725
2777
|
```
|
|
2726
2778
|
USAGE
|
|
2727
|
-
$ sf version
|
|
2779
|
+
$ sf version [--json] [--verbose]
|
|
2780
|
+
|
|
2781
|
+
FLAGS
|
|
2782
|
+
--verbose Show additional information about the CLI.
|
|
2783
|
+
|
|
2784
|
+
GLOBAL FLAGS
|
|
2785
|
+
--json Format output as json.
|
|
2786
|
+
|
|
2787
|
+
FLAG DESCRIPTIONS
|
|
2788
|
+
--verbose Show additional information about the CLI.
|
|
2789
|
+
|
|
2790
|
+
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
|
|
2728
2791
|
```
|
|
2729
2792
|
|
|
2730
|
-
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.
|
|
2793
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.1.1/src/commands/version.ts)_
|
|
2731
2794
|
|
|
2732
2795
|
## `sf whatsnew [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
|
2733
2796
|
|