@salesforce/cli 1.45.0 → 1.46.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 CHANGED
@@ -2,6 +2,8 @@
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.46.0](https://github.com/salesforcecli/cli/compare/v1.45.0...v1.46.0) (2022-09-14)
6
+
5
7
  ## [1.45.0](https://github.com/salesforcecli/cli/compare/v1.44.0...v1.45.0) (2022-09-07)
6
8
 
7
9
  ## [1.44.0](https://github.com/salesforcecli/cli/compare/v1.43.0...v1.44.0) (2022-08-31)
package/README.md CHANGED
@@ -32,7 +32,7 @@ $ npm install -g @salesforce/cli
32
32
  $ sf COMMAND
33
33
  running command...
34
34
  $ sf (--version|-v)
35
- @salesforce/cli/1.45.0 linux-x64 node-v14.20.0
35
+ @salesforce/cli/1.46.0 linux-x64 node-v14.20.0
36
36
  $ sf --help [COMMAND]
37
37
  USAGE
38
38
  $ sf COMMAND
@@ -352,7 +352,7 @@ EXAMPLES
352
352
  $ sf deploy --interactive
353
353
  ```
354
354
 
355
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.6.0/src/commands/deploy.ts)_
355
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.6.1/src/commands/deploy.ts)_
356
356
 
357
357
  ## `sf deploy functions`
358
358
 
@@ -394,7 +394,7 @@ EXAMPLES
394
394
 
395
395
  ## `sf deploy metadata`
396
396
 
397
- Deploy metadata in source format to an org from your local project.
397
+ Deploy metadata to an org from your local project.
398
398
 
399
399
  ```
400
400
  USAGE
@@ -427,10 +427,14 @@ GLOBAL FLAGS
427
427
  --json Format output as json.
428
428
 
429
429
  DESCRIPTION
430
- Deploy metadata in source format to an org from your local project.
430
+ Deploy metadata to an org from your local project.
431
431
 
432
432
  You must run this command from within a project.
433
433
 
434
+ Metadata components are deployed in source format by default. Deploy them in metadata format by specifying the
435
+ --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you
436
+ want to deploy.
437
+
434
438
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
435
439
  org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox
436
440
  org to disable source tracking.
@@ -2841,7 +2845,7 @@ DESCRIPTION
2841
2845
 
2842
2846
  ## `sf retrieve metadata`
2843
2847
 
2844
- Retrieve metadata in source format from an org to your local project.
2848
+ Retrieve metadata from an org to your local project.
2845
2849
 
2846
2850
  ```
2847
2851
  USAGE
@@ -2856,7 +2860,7 @@ FLAGS
2856
2860
  -m, --metadata=<value>... Metadata component names to retrieve.
2857
2861
  -n, --package-name=<value>... Package names to retrieve.
2858
2862
  -o, --target-org=<value> Login username or alias for the target org.
2859
- -t, --target-metadata-dir=<value> Directory root for the retrieved files.
2863
+ -t, --target-metadata-dir=<value> Directory that will contain the retrieved metadata format files or ZIP.
2860
2864
  -w, --wait=<value> Number of minutes to wait for the command to complete and display results to the
2861
2865
  terminal window.
2862
2866
  -x, --manifest=<value> File path for the manifest (package.xml) that specifies the components to retrieve.
@@ -2868,10 +2872,13 @@ GLOBAL FLAGS
2868
2872
  --json Format output as json.
2869
2873
 
2870
2874
  DESCRIPTION
2871
- Retrieve metadata in source format from an org to your local project.
2875
+ Retrieve metadata from an org to your local project.
2872
2876
 
2873
2877
  You must run this command from within a project.
2874
2878
 
2879
+ Metadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the
2880
+ --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
2881
+
2875
2882
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
2876
2883
  org, never allow source tracking. You can also use the "--no-track-source" flag when you create a scratch or sandbox
2877
2884
  org to disable source tracking.
@@ -2920,11 +2927,12 @@ EXAMPLES
2920
2927
  $ sf retrieve metadata --package-name Package1 "PackageName With Spaces" Package3
2921
2928
  $ sf retrieve metadata --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
2922
2929
 
2923
- Retrieve using Metadata API
2930
+ Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP
2931
+ file in the "output" directory:
2924
2932
 
2925
2933
  $ sf retrieve metadata --source-dir force-app --target-metadata-dir output
2926
2934
 
2927
- Retrieve using Metadata API and automatically unzip the contents
2935
+ Retrieve in metadata format and automatically extract the contents into the "output" directory:
2928
2936
 
2929
2937
  $ sf retrieve metadata --source-dir force-app --target-metadata-dir output --unzip
2930
2938