@salesforce/cli 2.23.20 → 2.24.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 +40 -1111
- package/npm-shrinkwrap.json +46 -46
- package/oclif.manifest.json +6 -1
- package/package.json +5 -5
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.
|
|
27
|
+
@salesforce/cli/2.24.0 linux-x64 node-v20.10.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -76,18 +76,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
76
76
|
- [`sf force data bulk delete`](#sf-force-data-bulk-delete)
|
|
77
77
|
- [`sf force data bulk status`](#sf-force-data-bulk-status)
|
|
78
78
|
- [`sf force data bulk upsert`](#sf-force-data-bulk-upsert)
|
|
79
|
-
- [`sf force mdapi deploy`](#sf-force-mdapi-deploy)
|
|
80
|
-
- [`sf force mdapi deploy cancel`](#sf-force-mdapi-deploy-cancel)
|
|
81
|
-
- [`sf force mdapi deploy report`](#sf-force-mdapi-deploy-report)
|
|
82
|
-
- [`sf force mdapi retrieve`](#sf-force-mdapi-retrieve)
|
|
83
|
-
- [`sf force mdapi retrieve report`](#sf-force-mdapi-retrieve-report)
|
|
84
|
-
- [`sf force source deploy`](#sf-force-source-deploy)
|
|
85
|
-
- [`sf force source deploy cancel`](#sf-force-source-deploy-cancel)
|
|
86
|
-
- [`sf force source deploy report`](#sf-force-source-deploy-report)
|
|
87
|
-
- [`sf force source pull`](#sf-force-source-pull)
|
|
88
|
-
- [`sf force source push`](#sf-force-source-push)
|
|
89
|
-
- [`sf force source retrieve`](#sf-force-source-retrieve)
|
|
90
|
-
- [`sf force source status`](#sf-force-source-status)
|
|
91
79
|
- [`sf help [COMMANDS]`](#sf-help-commands)
|
|
92
80
|
- [`sf info releasenotes display`](#sf-info-releasenotes-display)
|
|
93
81
|
- [`sf lightning generate app`](#sf-lightning-generate-app)
|
|
@@ -1904,1065 +1892,6 @@ EXAMPLES
|
|
|
1904
1892
|
|
|
1905
1893
|
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.13/src/commands/force/data/bulk/upsert.ts)_
|
|
1906
1894
|
|
|
1907
|
-
## `sf force mdapi deploy`
|
|
1908
|
-
|
|
1909
|
-
Deploy metadata to an org using Metadata API.
|
|
1910
|
-
|
|
1911
|
-
```
|
|
1912
|
-
USAGE
|
|
1913
|
-
$ sf force mdapi deploy -u <value> [--json] [--api-version <value>] [-d <value>] [-w <value>] [-o] [-g] [-q <value> |
|
|
1914
|
-
-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <value> | -c] [--verbose] [-f <value>] [-s]
|
|
1915
|
-
[--soapdeploy] [--purgeondelete] [--concise] [--resultsdir <value>] [--coverageformatters
|
|
1916
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
1917
|
-
|
|
1918
|
-
FLAGS
|
|
1919
|
-
-c, --checkonly
|
|
1920
|
-
Validates the deployed metadata and runs all Apex tests, but prevents the deployment from being saved to the org.
|
|
1921
|
-
|
|
1922
|
-
-d, --deploydir=<value>
|
|
1923
|
-
Root of directory tree that contains the files you want to deploy.
|
|
1924
|
-
|
|
1925
|
-
-f, --zipfile=<value>
|
|
1926
|
-
Path to .zip file of metadata to deploy.
|
|
1927
|
-
|
|
1928
|
-
-g, --ignorewarnings
|
|
1929
|
-
Ignore any warnings and don't roll back the deployment.
|
|
1930
|
-
|
|
1931
|
-
-l, --testlevel=<option>
|
|
1932
|
-
Level of deployment tests to run.
|
|
1933
|
-
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
1934
|
-
|
|
1935
|
-
-o, --ignoreerrors
|
|
1936
|
-
Ignore any errors and don't roll back the deployment.
|
|
1937
|
-
|
|
1938
|
-
-q, --validateddeployrequestid=<value>
|
|
1939
|
-
Request ID of the validated deployment to run a Quick Deploy.
|
|
1940
|
-
|
|
1941
|
-
-r, --runtests=<value>...
|
|
1942
|
-
Apex test classes to run if --testlevel is RunSpecifiedTests.
|
|
1943
|
-
|
|
1944
|
-
-s, --singlepackage
|
|
1945
|
-
Indicates that the zip file points to a directory structure for a single package.
|
|
1946
|
-
|
|
1947
|
-
-u, --target-org=<value>
|
|
1948
|
-
(required) Username or alias of the target org.
|
|
1949
|
-
|
|
1950
|
-
-w, --wait=<value>
|
|
1951
|
-
[default: [object Object]] Number of minutes to wait for the command to finish; specify -1 to wait indefinitely.
|
|
1952
|
-
|
|
1953
|
-
--api-version=<value>
|
|
1954
|
-
Override the api version used for api requests made by this command
|
|
1955
|
-
|
|
1956
|
-
--concise
|
|
1957
|
-
Omit success messages for smaller JSON output.
|
|
1958
|
-
|
|
1959
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
1960
|
-
Format of the code coverage results.
|
|
1961
|
-
|
|
1962
|
-
--junit
|
|
1963
|
-
Output JUnit test results.
|
|
1964
|
-
|
|
1965
|
-
--purgeondelete
|
|
1966
|
-
Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion
|
|
1967
|
-
rather than being stored in the Recycle Bin.
|
|
1968
|
-
|
|
1969
|
-
--resultsdir=<value>
|
|
1970
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
1971
|
-
|
|
1972
|
-
--soapdeploy
|
|
1973
|
-
Deploy metadata with SOAP API instead of REST API.
|
|
1974
|
-
|
|
1975
|
-
--verbose
|
|
1976
|
-
Display verbose output of the deploy results.
|
|
1977
|
-
|
|
1978
|
-
GLOBAL FLAGS
|
|
1979
|
-
--json Format output as json.
|
|
1980
|
-
|
|
1981
|
-
EXAMPLES
|
|
1982
|
-
Return a job ID you can use to check the deploy status:
|
|
1983
|
-
|
|
1984
|
-
$ sf force mdapi deploy --deploydir some/path
|
|
1985
|
-
|
|
1986
|
-
Deploy and poll for 1000 minutes:
|
|
1987
|
-
|
|
1988
|
-
$ sf force mdapi deploy --deploydir some/path --wait 1000
|
|
1989
|
-
|
|
1990
|
-
Deploy a ZIP file:
|
|
1991
|
-
|
|
1992
|
-
$ sf force mdapi deploy --zipfile stuff.zip
|
|
1993
|
-
|
|
1994
|
-
Validate a deployment so the ID can be used for a quick deploy:
|
|
1995
|
-
|
|
1996
|
-
$ sf force mdapi deploy --deploydir some/path --wait 1000 --checkonly --testlevel RunAllTestsInOrg
|
|
1997
|
-
|
|
1998
|
-
Quick deploy using a previously validated deployment:
|
|
1999
|
-
|
|
2000
|
-
$ sf force mdapi deploy --validateddeployrequestid MyValidatedId
|
|
2001
|
-
|
|
2002
|
-
FLAG DESCRIPTIONS
|
|
2003
|
-
-c, --checkonly
|
|
2004
|
-
|
|
2005
|
-
Validates the deployed metadata and runs all Apex tests, but prevents the deployment from being saved to the org.
|
|
2006
|
-
|
|
2007
|
-
IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained
|
|
2008
|
-
certain terms to avoid any effect on customer implementations.
|
|
2009
|
-
|
|
2010
|
-
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the
|
|
2011
|
-
--checkonly parameter to test a deployment (validation). This kind of change isn’t supported for test deployments to
|
|
2012
|
-
avoid the risk of data loss or corruption. If a change that isn’t supported for test deployments is included in a
|
|
2013
|
-
deployment package, the test deployment fails and issues an error.
|
|
2014
|
-
|
|
2015
|
-
If your deployment package changes a field type from Master-Detail to Lookup or vice versa, you can still validate
|
|
2016
|
-
the changes prior to deploying to Production by performing a full deployment to another test Sandbox. A full
|
|
2017
|
-
deployment includes a validation of the changes as part of the deployment process.
|
|
2018
|
-
|
|
2019
|
-
Note: A Metadata API deployment that includes Master-Detail relationships deletes all detail records in the Recycle
|
|
2020
|
-
Bin in the following cases.
|
|
2021
|
-
|
|
2022
|
-
1. For a deployment with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before
|
|
2023
|
-
proceeding to deploy the Master-Detail field, or the deployment fails. During the deployment, detail records are
|
|
2024
|
-
permanently deleted from the Recycle Bin and cannot be recovered.
|
|
2025
|
-
2. For a deployment that converts a Lookup field relationship to a Master-Detail relationship, detail records must
|
|
2026
|
-
reference a master record or be soft-deleted (sent to the Recycle Bin) for the deployment to succeed. However, a
|
|
2027
|
-
successful deployment permanently deletes any detail records in the Recycle Bin.
|
|
2028
|
-
|
|
2029
|
-
-d, --deploydir=<value> Root of directory tree that contains the files you want to deploy.
|
|
2030
|
-
|
|
2031
|
-
The root must contain a valid package.xml file describing the entities in the directory structure. Required to
|
|
2032
|
-
initiate a deployment if you don’t use --zipfile. If you specify both --zipfile and --deploydir, a zip file of the
|
|
2033
|
-
contents of the --deploydir directory is written to the location specified by --zipfile.
|
|
2034
|
-
|
|
2035
|
-
-f, --zipfile=<value> Path to .zip file of metadata to deploy.
|
|
2036
|
-
|
|
2037
|
-
You must indicate this option or --deploydir. If you specify both --zipfile and --deploydir, a .zip file of the
|
|
2038
|
-
contents of the deploy directory is created at the path specified for the .zip file.
|
|
2039
|
-
|
|
2040
|
-
-g, --ignorewarnings Ignore any warnings and don't roll back the deployment.
|
|
2041
|
-
|
|
2042
|
-
If a warning occurs and ignoreWarnings is set to true, the success field in DeployMessage is true. When
|
|
2043
|
-
ignoreWarnings is set to false, success is set to false, and the warning is treated like an error.
|
|
2044
|
-
This field is available in API version 18.0 and later. Prior to version 18.0, there was no distinction between
|
|
2045
|
-
warnings and errors. All problems were treated as errors and prevented a successful deployment.
|
|
2046
|
-
|
|
2047
|
-
-l, --testlevel=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Level of deployment tests to run.
|
|
2048
|
-
|
|
2049
|
-
Valid values are:
|
|
2050
|
-
|
|
2051
|
-
* NoTestRun—No tests are run. This test level applies only to deployments to development environments, such as
|
|
2052
|
-
sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
|
|
2053
|
-
* RunSpecifiedTests—Runs only the tests that you specify in the --runtests option. Code coverage requirements differ
|
|
2054
|
-
from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
|
|
2055
|
-
code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
|
|
2056
|
-
trigger individually and is different than the overall coverage percentage.
|
|
2057
|
-
* RunLocalTests—All tests in your org are run, except the ones that originate from installed managed and unlocked
|
|
2058
|
-
packages. This test level is the default for production deployments that include Apex classes or triggers.
|
|
2059
|
-
* RunAllTestsInOrg—All tests in your org are run, including tests of managed packages.
|
|
2060
|
-
|
|
2061
|
-
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
|
|
2062
|
-
information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.
|
|
2063
|
-
|
|
2064
|
-
-o, --ignoreerrors Ignore any errors and don't roll back the deployment.
|
|
2065
|
-
|
|
2066
|
-
The default is false. Keep this parameter set to false when deploying to a production org. If set to true,
|
|
2067
|
-
components without errors are deployed, and components with errors are skipped.
|
|
2068
|
-
|
|
2069
|
-
-q, --validateddeployrequestid=<value> Request ID of the validated deployment to run a Quick Deploy.
|
|
2070
|
-
|
|
2071
|
-
Deploying a validation helps you shorten your deployment time because tests aren’t rerun. If you have a recent
|
|
2072
|
-
successful validation, you can deploy the validated components without running tests. A validation doesn’t save any
|
|
2073
|
-
components in the org. You use a validation only to check the success or failure messages that you would receive
|
|
2074
|
-
with an actual deployment. To validate your components, add the -c | --checkonly flag when you run 'force mdapi
|
|
2075
|
-
deploy'. This flag sets the checkOnly='true' parameter for your deployment. Before deploying a recent validation,
|
|
2076
|
-
ensure that the following requirements are met:
|
|
2077
|
-
|
|
2078
|
-
1. The components have been validated successfully for the target environment within the last 10 days.
|
|
2079
|
-
2. As part of the validation, Apex tests in the target org have passed.
|
|
2080
|
-
3. Code coverage requirements are met.
|
|
2081
|
-
- If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have
|
|
2082
|
-
some coverage.
|
|
2083
|
-
- If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is
|
|
2084
|
-
covered by at least 75% individually.
|
|
2085
|
-
|
|
2086
|
-
-s, --singlepackage Indicates that the zip file points to a directory structure for a single package.
|
|
2087
|
-
|
|
2088
|
-
By default, the CLI assumes the directory is structured for a set of packages.
|
|
2089
|
-
|
|
2090
|
-
-w, --wait=<value> Number of minutes to wait for the command to finish; specify -1 to wait indefinitely.
|
|
2091
|
-
|
|
2092
|
-
The default is 0 (returns immediately).
|
|
2093
|
-
|
|
2094
|
-
--soapdeploy Deploy metadata with SOAP API instead of REST API.
|
|
2095
|
-
|
|
2096
|
-
Because SOAP API has a lower .ZIP file size limit (400 MB uncompressed, 39 MB compressed), Salesforce recommends
|
|
2097
|
-
REST API deployment. This flag provides backwards compatibility with API version 50.0 and earlier when deploy used
|
|
2098
|
-
SOAP API by default.
|
|
2099
|
-
|
|
2100
|
-
--verbose Display verbose output of the deploy results.
|
|
2101
|
-
|
|
2102
|
-
Indicates that you want verbose output from the deploy operation.
|
|
2103
|
-
```
|
|
2104
|
-
|
|
2105
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/deploy.ts)_
|
|
2106
|
-
|
|
2107
|
-
## `sf force mdapi deploy cancel`
|
|
2108
|
-
|
|
2109
|
-
Cancel a metadata deployment.
|
|
2110
|
-
|
|
2111
|
-
```
|
|
2112
|
-
USAGE
|
|
2113
|
-
$ sf force mdapi deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2114
|
-
|
|
2115
|
-
FLAGS
|
|
2116
|
-
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment.
|
|
2117
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2118
|
-
configuration variable is already set.
|
|
2119
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes for the command to complete and display
|
|
2120
|
-
results to the terminal window.
|
|
2121
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2122
|
-
|
|
2123
|
-
GLOBAL FLAGS
|
|
2124
|
-
--json Format output as json.
|
|
2125
|
-
|
|
2126
|
-
DESCRIPTION
|
|
2127
|
-
Cancel a metadata deployment.
|
|
2128
|
-
|
|
2129
|
-
Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes)
|
|
2130
|
-
to check for updates to the canceled deploy status.
|
|
2131
|
-
|
|
2132
|
-
Cancels an asynchronous metadata deployment.
|
|
2133
|
-
|
|
2134
|
-
EXAMPLES
|
|
2135
|
-
Cancel a deployment and wait two minutes:
|
|
2136
|
-
|
|
2137
|
-
$ sf force mdapi deploy cancel --wait 2
|
|
2138
|
-
|
|
2139
|
-
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID:
|
|
2140
|
-
|
|
2141
|
-
$ sf force mdapi deploy cancel --jobid <jobid>
|
|
2142
|
-
|
|
2143
|
-
FLAG DESCRIPTIONS
|
|
2144
|
-
-w, --wait=<value> Number of minutes for the command to complete and display results to the terminal window.
|
|
2145
|
-
|
|
2146
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2147
|
-
```
|
|
2148
|
-
|
|
2149
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/deploy/cancel.ts)_
|
|
2150
|
-
|
|
2151
|
-
## `sf force mdapi deploy report`
|
|
2152
|
-
|
|
2153
|
-
Check the status of a metadata deployment.
|
|
2154
|
-
|
|
2155
|
-
```
|
|
2156
|
-
USAGE
|
|
2157
|
-
$ sf force mdapi deploy report -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>] [--verbose] [--concise]
|
|
2158
|
-
[--resultsdir <value>] [--coverageformatters
|
|
2159
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2160
|
-
|
|
2161
|
-
FLAGS
|
|
2162
|
-
-i, --jobid=<value>
|
|
2163
|
-
Job ID of the deployment to check; required if you’ve never deployed using Salesforce CLI; defaults to your most
|
|
2164
|
-
recent CLI deployment.
|
|
2165
|
-
|
|
2166
|
-
-o, --target-org=<value>
|
|
2167
|
-
(required) Username or alias of the target org. Not required if the `target-org` configuration variable is already
|
|
2168
|
-
set.
|
|
2169
|
-
|
|
2170
|
-
-w, --wait=<value>
|
|
2171
|
-
[default: [object Object]] Number of minutes to wait for the command to finish; use -1 to poll indefinitely.
|
|
2172
|
-
|
|
2173
|
-
--api-version=<value>
|
|
2174
|
-
Override the api version used for api requests made by this command
|
|
2175
|
-
|
|
2176
|
-
--concise
|
|
2177
|
-
Omit success messages for smaller JSON output.
|
|
2178
|
-
|
|
2179
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
2180
|
-
Format of the code coverage results.
|
|
2181
|
-
|
|
2182
|
-
--junit
|
|
2183
|
-
Output JUnit test results.
|
|
2184
|
-
|
|
2185
|
-
--resultsdir=<value>
|
|
2186
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
2187
|
-
|
|
2188
|
-
--verbose
|
|
2189
|
-
Verbose output of deploy results.
|
|
2190
|
-
|
|
2191
|
-
GLOBAL FLAGS
|
|
2192
|
-
--json Format output as json.
|
|
2193
|
-
|
|
2194
|
-
DESCRIPTION
|
|
2195
|
-
Check the status of a metadata deployment.
|
|
2196
|
-
|
|
2197
|
-
Specify the job ID for the deploy you want to check. The job ID is returned by the "force mdapi deploy" command when
|
|
2198
|
-
run without the --wait parameter. You can also specify a wait time (minutes) to check for updates to the deploy
|
|
2199
|
-
status.
|
|
2200
|
-
|
|
2201
|
-
EXAMPLES
|
|
2202
|
-
Check the status of the most recent deployment
|
|
2203
|
-
|
|
2204
|
-
$ sf force mdapi deploy report
|
|
2205
|
-
|
|
2206
|
-
Check the status of a deploy with job ID 1234 and wait for 10 minutes for the result:
|
|
2207
|
-
|
|
2208
|
-
$ sf force mdapi deploy report --jobid 1234 --wait 10
|
|
2209
|
-
|
|
2210
|
-
FLAG DESCRIPTIONS
|
|
2211
|
-
-i, --jobid=<value>
|
|
2212
|
-
|
|
2213
|
-
Job ID of the deployment to check; required if you’ve never deployed using Salesforce CLI; defaults to your most
|
|
2214
|
-
recent CLI deployment.
|
|
2215
|
-
|
|
2216
|
-
The job ID (id field value for AsyncResult) of the deployment you want to check. The job ID is required if you
|
|
2217
|
-
haven’t previously deployed using Salesforce CLI. If you deploy using Salesforce CLI and don’t specify a job ID, we
|
|
2218
|
-
use the ID of the most recent metadata deployment.
|
|
2219
|
-
```
|
|
2220
|
-
|
|
2221
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/deploy/report.ts)_
|
|
2222
|
-
|
|
2223
|
-
## `sf force mdapi retrieve`
|
|
2224
|
-
|
|
2225
|
-
Retrieve metadata from an org using Metadata API.
|
|
2226
|
-
|
|
2227
|
-
```
|
|
2228
|
-
USAGE
|
|
2229
|
-
$ sf force mdapi retrieve -o <value> -r <value> [--json] [-k <value> | -d <value> | -p <value>] [-s] [-n <value>] [-z]
|
|
2230
|
-
[-w <value>] [-a <value>] [--verbose]
|
|
2231
|
-
|
|
2232
|
-
FLAGS
|
|
2233
|
-
-a, --apiversion=<value> Target API version for the retrieve.
|
|
2234
|
-
-d, --sourcedir=<value> Source directory to use instead of the default package directory specified in
|
|
2235
|
-
sfdx-project.json.
|
|
2236
|
-
-k, --unpackaged=<value> Complete path for the manifest file that specifies the components to retrieve.
|
|
2237
|
-
-n, --zipfilename=<value> File name to use for the retrieved zip file.
|
|
2238
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2239
|
-
configuration variable is already set.
|
|
2240
|
-
-p, --packagenames=<value>... Comma-separated list of packages to retrieve.
|
|
2241
|
-
-r, --retrievetargetdir=<value> (required) Root of the directory structure where the retrieved .zip or metadata files
|
|
2242
|
-
are retrieved.
|
|
2243
|
-
-s, --singlepackage Specify that the zip file points to a directory structure for a single package.
|
|
2244
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete.
|
|
2245
|
-
-z, --unzip Extract all files from the retrieved zip file.
|
|
2246
|
-
--verbose Display verbose output of retrieve result.
|
|
2247
|
-
|
|
2248
|
-
GLOBAL FLAGS
|
|
2249
|
-
--json Format output as json.
|
|
2250
|
-
|
|
2251
|
-
DESCRIPTION
|
|
2252
|
-
Retrieve metadata from an org using Metadata API.
|
|
2253
|
-
|
|
2254
|
-
This command uses Metadata API to retrieve a .zip of XML files that represent metadata from the targeted org. You can
|
|
2255
|
-
retrieve and deploy up to 10,000 files or 400 MB (39 MB compressed) at one time.
|
|
2256
|
-
|
|
2257
|
-
EXAMPLES
|
|
2258
|
-
Retrieve metadata in the default project directory into the target directory:
|
|
2259
|
-
|
|
2260
|
-
$ sf force mdapi retrieve --retrievetargetdir path/to/retrieve/dir
|
|
2261
|
-
|
|
2262
|
-
Retrieve metadata defined in the specified manifest into the target directory:
|
|
2263
|
-
|
|
2264
|
-
$ sf force mdapi retrieve --retrievetargetdir path/to/retrieve/dir --unpackaged package.xml
|
|
2265
|
-
|
|
2266
|
-
Retrieve metadata defined by the specified directory, name the retrieved zipfile and extract all contents
|
|
2267
|
-
|
|
2268
|
-
$ sf force mdapi retrieve --sourcedir path/to/apexClasses --retrievetargetdir path/to/retrieve/dir --unzip \
|
|
2269
|
-
--zipfilename apexClasses.zip
|
|
2270
|
-
|
|
2271
|
-
Enqueue a retrieve request but do not wait for the metadata to be retrieved:
|
|
2272
|
-
|
|
2273
|
-
$ sf force mdapi retrieve --retrievetargetdir path/to/retrieve/dir --wait 0
|
|
2274
|
-
|
|
2275
|
-
FLAG DESCRIPTIONS
|
|
2276
|
-
-a, --apiversion=<value> Target API version for the retrieve.
|
|
2277
|
-
|
|
2278
|
-
Use to override the default, which is the latest version supported by your CLI plug-in, with the version in your
|
|
2279
|
-
package.xml file.
|
|
2280
|
-
|
|
2281
|
-
-s, --singlepackage Specify that the zip file points to a directory structure for a single package.
|
|
2282
|
-
|
|
2283
|
-
By default, the CLI assumes the directory is structured for a set of packages.
|
|
2284
|
-
```
|
|
2285
|
-
|
|
2286
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/retrieve.ts)_
|
|
2287
|
-
|
|
2288
|
-
## `sf force mdapi retrieve report`
|
|
2289
|
-
|
|
2290
|
-
Check the status of a metadata retrieval.
|
|
2291
|
-
|
|
2292
|
-
```
|
|
2293
|
-
USAGE
|
|
2294
|
-
$ sf force mdapi retrieve report -o <value> [--json] [--api-version <value>] [-r <value>] [-i <value>] [-n <value>] [-z] [-w
|
|
2295
|
-
<value>] [--verbose]
|
|
2296
|
-
|
|
2297
|
-
FLAGS
|
|
2298
|
-
-i, --jobid=<value> Job ID of the retrieve you want to check; defaults to your most recent CLI retrieval.
|
|
2299
|
-
-n, --zipfilename=<value> File name to use for the retrieved zip file.
|
|
2300
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2301
|
-
configuration variable is already set.
|
|
2302
|
-
-r, --retrievetargetdir=<value> Root of the directory structure where the retrieved .zip or metadata files are
|
|
2303
|
-
retrieved.
|
|
2304
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete.
|
|
2305
|
-
-z, --unzip Extract all files from the retrieved zip file.
|
|
2306
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2307
|
-
--verbose Display verbose output of retrieve result.
|
|
2308
|
-
|
|
2309
|
-
GLOBAL FLAGS
|
|
2310
|
-
--json Format output as json.
|
|
2311
|
-
|
|
2312
|
-
DESCRIPTION
|
|
2313
|
-
Check the status of a metadata retrieval.
|
|
2314
|
-
|
|
2315
|
-
Specify the job ID and a target directory for the retrieve you want to check. You can also specify a wait time
|
|
2316
|
-
(minutes) to check for updates to the retrieve status. If the retrieve was successful, the resulting zip file will be
|
|
2317
|
-
saved to the location passed in with the retrieve target parameter.
|
|
2318
|
-
|
|
2319
|
-
EXAMPLES
|
|
2320
|
-
Poll until the metadata is retrieved (or timeout is reached) using data from the last force:mdapi:retrieve command:
|
|
2321
|
-
|
|
2322
|
-
$ sf force mdapi retrieve report
|
|
2323
|
-
|
|
2324
|
-
Report the current status of the last retrieve command. If the retrieve is complete the zip file of metadata is
|
|
2325
|
-
written to the target directoy:
|
|
2326
|
-
|
|
2327
|
-
$ sf force mdapi retrieve report --retrievetargetdir path/to/retrieve/dir --wait 0
|
|
2328
|
-
|
|
2329
|
-
Poll until the metadata is retrieved (or timeout is reached) using the provided RetrieveID, naming the zip file and
|
|
2330
|
-
extracting all contents:
|
|
2331
|
-
|
|
2332
|
-
$ sf force mdapi retrieve report -i retrieveId --retrievetargetdir path/to/retrieve/dir --unzip --zipfilename \
|
|
2333
|
-
apexClasses.zip
|
|
2334
|
-
|
|
2335
|
-
FLAG DESCRIPTIONS
|
|
2336
|
-
-i, --jobid=<value> Job ID of the retrieve you want to check; defaults to your most recent CLI retrieval.
|
|
2337
|
-
|
|
2338
|
-
You must specify a --retrievetargetdir. Use with --wait to resume waiting.
|
|
2339
|
-
```
|
|
2340
|
-
|
|
2341
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/retrieve/report.ts)_
|
|
2342
|
-
|
|
2343
|
-
## `sf force source deploy`
|
|
2344
|
-
|
|
2345
|
-
Deploy source to an org.
|
|
2346
|
-
|
|
2347
|
-
```
|
|
2348
|
-
USAGE
|
|
2349
|
-
$ sf force source deploy -u <value> [--json] [--api-version <value>] [--soapdeploy] [-w <value>] [-o] [-g]
|
|
2350
|
-
[--purgeondelete -x <value>] [-q <value> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r
|
|
2351
|
-
<value> | -t] [--verbose] [-m <value>] [-p <value>] [--predestructivechanges <value> ] [--postdestructivechanges
|
|
2352
|
-
<value> ] [-f ] [--resultsdir <value>] [--coverageformatters
|
|
2353
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2354
|
-
|
|
2355
|
-
FLAGS
|
|
2356
|
-
-c, --checkonly
|
|
2357
|
-
Validate the deployed metadata and run all Apex tests, but don't save to the org.
|
|
2358
|
-
|
|
2359
|
-
-f, --forceoverwrite
|
|
2360
|
-
Ignore conflict warnings and overwrite changes to the org.
|
|
2361
|
-
|
|
2362
|
-
-g, --ignorewarnings
|
|
2363
|
-
Allow a deployment to complete successfully even if there are warnings.
|
|
2364
|
-
|
|
2365
|
-
-l, --testlevel=<option>
|
|
2366
|
-
Deployment testing level.
|
|
2367
|
-
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
2368
|
-
|
|
2369
|
-
-m, --metadata=<value>...
|
|
2370
|
-
Comma-separated list of metadata component names.
|
|
2371
|
-
|
|
2372
|
-
-o, --ignoreerrors
|
|
2373
|
-
Ignore any errors and don't roll back deployment.
|
|
2374
|
-
|
|
2375
|
-
-p, --sourcepath=<value>...
|
|
2376
|
-
Comma-separated list of source file paths to deploy.
|
|
2377
|
-
|
|
2378
|
-
-q, --validateddeployrequestid=<value>
|
|
2379
|
-
Deploy request ID of the validated deployment to run a Quick Deploy.
|
|
2380
|
-
|
|
2381
|
-
-r, --runtests=<value>...
|
|
2382
|
-
Apex test classes to run if --testlevel RunSpecifiedTests.
|
|
2383
|
-
|
|
2384
|
-
-t, --tracksource
|
|
2385
|
-
If the deploy succeeds, update source tracking information.
|
|
2386
|
-
|
|
2387
|
-
-u, --target-org=<value>
|
|
2388
|
-
(required) Username or alias of the target org.
|
|
2389
|
-
|
|
2390
|
-
-w, --wait=<value>
|
|
2391
|
-
[default: [object Object]] Wait time for command to finish in minutes.
|
|
2392
|
-
|
|
2393
|
-
-x, --manifest=<value>
|
|
2394
|
-
Complete path for the manifest (package.xml) file that specifies the components to deploy.
|
|
2395
|
-
|
|
2396
|
-
--api-version=<value>
|
|
2397
|
-
Override the api version used for api requests made by this command
|
|
2398
|
-
|
|
2399
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
2400
|
-
Format of the code coverage results.
|
|
2401
|
-
|
|
2402
|
-
--junit
|
|
2403
|
-
Output JUnit test results.
|
|
2404
|
-
|
|
2405
|
-
--postdestructivechanges=<value>
|
|
2406
|
-
File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.
|
|
2407
|
-
|
|
2408
|
-
--predestructivechanges=<value>
|
|
2409
|
-
File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.
|
|
2410
|
-
|
|
2411
|
-
--purgeondelete
|
|
2412
|
-
Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion
|
|
2413
|
-
rather than being stored in the Recycle Bin.
|
|
2414
|
-
|
|
2415
|
-
--resultsdir=<value>
|
|
2416
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
2417
|
-
|
|
2418
|
-
--soapdeploy
|
|
2419
|
-
Deploy metadata with SOAP API instead of REST API.
|
|
2420
|
-
|
|
2421
|
-
--verbose
|
|
2422
|
-
Specify verbose output about the deploy result.
|
|
2423
|
-
|
|
2424
|
-
GLOBAL FLAGS
|
|
2425
|
-
--json Format output as json.
|
|
2426
|
-
|
|
2427
|
-
DESCRIPTION
|
|
2428
|
-
Deploy source to an org.
|
|
2429
|
-
|
|
2430
|
-
Use this command to deploy source (metadata that’s in source format) to an org. To take advantage of change tracking
|
|
2431
|
-
with scratch orgs, use "force source push". To deploy metadata that’s in metadata format, use "force mdapi deploy".
|
|
2432
|
-
|
|
2433
|
-
The source you deploy overwrites the corresponding metadata in your org. This command does not attempt to merge your
|
|
2434
|
-
source with the versions in your org.
|
|
2435
|
-
|
|
2436
|
-
To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
|
|
2437
|
-
to use the CLI. To check the status of the job, use "force source deploy report".
|
|
2438
|
-
|
|
2439
|
-
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of
|
|
2440
|
-
double quotes. On Windows, if the list contains commas, also enclose the entire list in one set of double quotes.
|
|
2441
|
-
|
|
2442
|
-
If you use the --manifest, --predestructivechanges, or --postdestructivechanges parameters, run the "force source
|
|
2443
|
-
manifest create" command to easily generate the different types of manifest files.
|
|
2444
|
-
|
|
2445
|
-
EXAMPLES
|
|
2446
|
-
Deploy the source files in a directory:
|
|
2447
|
-
|
|
2448
|
-
$ sf force source deploy --sourcepath path/to/source
|
|
2449
|
-
|
|
2450
|
-
Deploy a specific Apex class and the objects whose source is in a directory:
|
|
2451
|
-
|
|
2452
|
-
$ sf force source deploy --sourcepath "path/to/apex/classes/MyClass.cls,path/to/source/objects"
|
|
2453
|
-
|
|
2454
|
-
Deploy source files in a comma-separated list that contains spaces:
|
|
2455
|
-
|
|
2456
|
-
$ sf force source deploy --sourcepath "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, \
|
|
2457
|
-
path/to/apex/classes"
|
|
2458
|
-
|
|
2459
|
-
Deploy all Apex classes:
|
|
2460
|
-
|
|
2461
|
-
$ sf force source deploy --metadata ApexClass
|
|
2462
|
-
|
|
2463
|
-
Deploy a specific Apex class:
|
|
2464
|
-
|
|
2465
|
-
$ sf force source deploy --metadata ApexClass:MyApexClass
|
|
2466
|
-
|
|
2467
|
-
Deploy a specific Apex class and update source tracking files :
|
|
2468
|
-
|
|
2469
|
-
$ sf force source deploy --metadata ApexClass:MyApexClass --tracksource
|
|
2470
|
-
|
|
2471
|
-
Deploy all custom objects and Apex classes:
|
|
2472
|
-
|
|
2473
|
-
$ sf force source deploy --metadata "CustomObject,ApexClass"
|
|
2474
|
-
|
|
2475
|
-
Deploy all Apex classes and two specific profiles (one of which has a space in its name):
|
|
2476
|
-
|
|
2477
|
-
$ sf force source deploy --metadata "ApexClass, Profile:My Profile, Profile: AnotherProfile"
|
|
2478
|
-
|
|
2479
|
-
Deploy all components listed in a manifest:
|
|
2480
|
-
|
|
2481
|
-
$ sf force source deploy --manifest path/to/package.xml
|
|
2482
|
-
|
|
2483
|
-
Run the tests that aren’t in any managed packages as part of a deployment:
|
|
2484
|
-
|
|
2485
|
-
$ sf force source deploy --metadata ApexClass --testlevel RunLocalTests
|
|
2486
|
-
|
|
2487
|
-
Check whether a deployment would succeed (to prepare for Quick Deploy):
|
|
2488
|
-
|
|
2489
|
-
$ sf force source deploy --metadata ApexClass --testlevel RunAllTestsInOrg -c
|
|
2490
|
-
|
|
2491
|
-
Deploy an already validated deployment (Quick Deploy):
|
|
2492
|
-
|
|
2493
|
-
$ sf force source deploy --validateddeployrequestid 0Af9A00000FTM6pSAH`
|
|
2494
|
-
|
|
2495
|
-
Run a destructive operation before the deploy occurs:
|
|
2496
|
-
|
|
2497
|
-
$ sf force source deploy --manifest package.xml --predestructivechanges destructiveChangesPre.xml
|
|
2498
|
-
|
|
2499
|
-
Run a destructive operation after the deploy occurs:
|
|
2500
|
-
|
|
2501
|
-
$ sf force source deploy --manifest package.xml --postdestructivechanges destructiveChangesPost.xml
|
|
2502
|
-
|
|
2503
|
-
FLAG DESCRIPTIONS
|
|
2504
|
-
-c, --checkonly Validate the deployed metadata and run all Apex tests, but don't save to the org.
|
|
2505
|
-
|
|
2506
|
-
IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained
|
|
2507
|
-
certain terms to avoid any effect on customer implementations.
|
|
2508
|
-
|
|
2509
|
-
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the
|
|
2510
|
-
--checkonly parameter to test a deployment (validation). This kind of change isn’t supported for test deployments to
|
|
2511
|
-
avoid the risk of data loss or corruption. If a change that isn’t supported for test deployments is included in a
|
|
2512
|
-
deployment package, the test deployment fails and issues an error.
|
|
2513
|
-
|
|
2514
|
-
If your deployment package changes a field type from Master-Detail to Lookup or vice versa, you can still validate
|
|
2515
|
-
the changes prior to deploying to Production by performing a full deployment to another test Sandbox. A full
|
|
2516
|
-
deployment includes a validation of the changes as part of the deployment process.
|
|
2517
|
-
|
|
2518
|
-
Note: A Metadata API deployment that includes Master-Detail relationships deletes all detail records in the Recycle
|
|
2519
|
-
Bin in the following cases.
|
|
2520
|
-
|
|
2521
|
-
1. For a deployment with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before
|
|
2522
|
-
proceeding to deploy the Master-Detail field, or the deployment fails. During the deployment, detail records are
|
|
2523
|
-
permanently deleted from the Recycle Bin and cannot be recovered.
|
|
2524
|
-
|
|
2525
|
-
2. For a deployment that converts a Lookup field relationship to a Master-Detail relationship, detail records must
|
|
2526
|
-
reference a master record or be soft-deleted (sent to the Recycle Bin) for the deployment to succeed. However, a
|
|
2527
|
-
successful deployment permanently deletes any detail records in the Recycle Bin.
|
|
2528
|
-
|
|
2529
|
-
-g, --ignorewarnings Allow a deployment to complete successfully even if there are warnings.
|
|
2530
|
-
|
|
2531
|
-
If a warning occurs and ignoreWarnings is set to true, the success field in DeployMessage is true. When
|
|
2532
|
-
ignoreWarnings is set to false, success is set to false, and the warning is treated like an error.
|
|
2533
|
-
|
|
2534
|
-
-l, --testlevel=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment testing level.
|
|
2535
|
-
|
|
2536
|
-
Valid values are:
|
|
2537
|
-
|
|
2538
|
-
- NoTestRun—No tests are run. This test level applies only to deployments to development environments, such as
|
|
2539
|
-
sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
|
|
2540
|
-
|
|
2541
|
-
- RunSpecifiedTests—Runs only the tests that you specify in the --runtests option. Code coverage requirements differ
|
|
2542
|
-
from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
|
|
2543
|
-
code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
|
|
2544
|
-
trigger individually and is different than the overall coverage percentage.
|
|
2545
|
-
|
|
2546
|
-
- RunLocalTests—All tests in your org are run, except the ones that originate from installed managed and unlocked
|
|
2547
|
-
packages. This test level is the default for production deployments that include Apex classes or triggers.
|
|
2548
|
-
|
|
2549
|
-
- RunAllTestsInOrg—All tests in your org are run, including tests of managed packages.
|
|
2550
|
-
|
|
2551
|
-
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
|
|
2552
|
-
information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.
|
|
2553
|
-
|
|
2554
|
-
-m, --metadata=<value>... Comma-separated list of metadata component names.
|
|
2555
|
-
|
|
2556
|
-
If you specify this parameter, don’t specify --manifest or --sourcepath.
|
|
2557
|
-
|
|
2558
|
-
-o, --ignoreerrors Ignore any errors and don't roll back deployment.
|
|
2559
|
-
|
|
2560
|
-
Keep this parameter set to false when deploying to a production org. If set to true, components without errors are
|
|
2561
|
-
deployed, and components with errors are skipped.
|
|
2562
|
-
|
|
2563
|
-
-p, --sourcepath=<value>... Comma-separated list of source file paths to deploy.
|
|
2564
|
-
|
|
2565
|
-
The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
|
|
2566
|
-
(in which case the operation is applied to all metadata types in the directory and its sub-directories).
|
|
2567
|
-
|
|
2568
|
-
If you specify this parameter, don’t specify --manifest or --metadata.
|
|
2569
|
-
|
|
2570
|
-
-q, --validateddeployrequestid=<value> Deploy request ID of the validated deployment to run a Quick Deploy.
|
|
2571
|
-
|
|
2572
|
-
Deploying a validation helps you shorten your deployment time because tests aren’t rerun. If you have a recent
|
|
2573
|
-
successful validation, you can deploy the validated components without running tests. A validation doesn’t save any
|
|
2574
|
-
components in the org. You use a validation only to check the success or failure messages that you would receive
|
|
2575
|
-
with an actual deployment. To validate your components, add the -c | --checkonly flag when you run "force mdapi
|
|
2576
|
-
deploy". This flag sets the checkOnly="true" parameter for your deployment. Before deploying a recent validation,
|
|
2577
|
-
ensure that the following requirements are met:
|
|
2578
|
-
|
|
2579
|
-
1. The components have been validated successfully for the target environment within the last 10 days.
|
|
2580
|
-
|
|
2581
|
-
2. As part of the validation, Apex tests in the target org have passed.
|
|
2582
|
-
|
|
2583
|
-
3. Code coverage requirements are met.
|
|
2584
|
-
|
|
2585
|
-
* If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have
|
|
2586
|
-
some coverage.
|
|
2587
|
-
|
|
2588
|
-
* If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is
|
|
2589
|
-
covered by at least 75% individually.
|
|
2590
|
-
|
|
2591
|
-
-t, --tracksource If the deploy succeeds, update source tracking information.
|
|
2592
|
-
|
|
2593
|
-
Doesn't delete locally deleted files from org unless you also specify --predestructivechanges or
|
|
2594
|
-
--postdestructivechanges.
|
|
2595
|
-
|
|
2596
|
-
-w, --wait=<value> Wait time for command to finish in minutes.
|
|
2597
|
-
|
|
2598
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2599
|
-
|
|
2600
|
-
-x, --manifest=<value> Complete path for the manifest (package.xml) file that specifies the components to deploy.
|
|
2601
|
-
|
|
2602
|
-
All child components are included.
|
|
2603
|
-
|
|
2604
|
-
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
2605
|
-
```
|
|
2606
|
-
|
|
2607
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/deploy.ts)_
|
|
2608
|
-
|
|
2609
|
-
## `sf force source deploy cancel`
|
|
2610
|
-
|
|
2611
|
-
Cancel a source deployment.
|
|
2612
|
-
|
|
2613
|
-
```
|
|
2614
|
-
USAGE
|
|
2615
|
-
$ sf force source deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2616
|
-
|
|
2617
|
-
FLAGS
|
|
2618
|
-
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment if
|
|
2619
|
-
not specified.
|
|
2620
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2621
|
-
configuration variable is already set.
|
|
2622
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2623
|
-
display results.
|
|
2624
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2625
|
-
|
|
2626
|
-
GLOBAL FLAGS
|
|
2627
|
-
--json Format output as json.
|
|
2628
|
-
|
|
2629
|
-
DESCRIPTION
|
|
2630
|
-
Cancel a source deployment.
|
|
2631
|
-
|
|
2632
|
-
Use this command to cancel a specified asynchronous source deployment. You can also specify a wait time (in minutes)
|
|
2633
|
-
to check for updates to the canceled deploy status.
|
|
2634
|
-
|
|
2635
|
-
To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
|
|
2636
|
-
to use the CLI. To check the status of the job, use "force source deploy report".
|
|
2637
|
-
|
|
2638
|
-
EXAMPLES
|
|
2639
|
-
Cancel a deployment and wait two minutes:
|
|
2640
|
-
|
|
2641
|
-
$ sf force source deploy cancel --wait 2
|
|
2642
|
-
|
|
2643
|
-
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID:
|
|
2644
|
-
|
|
2645
|
-
$ sf force source deploy cancel --jobid <jobid>
|
|
2646
|
-
|
|
2647
|
-
FLAG DESCRIPTIONS
|
|
2648
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results.
|
|
2649
|
-
|
|
2650
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2651
|
-
```
|
|
2652
|
-
|
|
2653
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/deploy/cancel.ts)_
|
|
2654
|
-
|
|
2655
|
-
## `sf force source deploy report`
|
|
2656
|
-
|
|
2657
|
-
Check the status of a metadata deployment.
|
|
2658
|
-
|
|
2659
|
-
```
|
|
2660
|
-
USAGE
|
|
2661
|
-
$ sf force source deploy report -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>] [--verbose]
|
|
2662
|
-
[--resultsdir <value>] [--coverageformatters
|
|
2663
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2664
|
-
|
|
2665
|
-
FLAGS
|
|
2666
|
-
-i, --jobid=<value>
|
|
2667
|
-
Job ID of the deployment you want to check; defaults to your most recent CLI deployment.
|
|
2668
|
-
|
|
2669
|
-
-o, --target-org=<value>
|
|
2670
|
-
(required) Username or alias of the target org. Not required if the `target-org` configuration variable is already
|
|
2671
|
-
set.
|
|
2672
|
-
|
|
2673
|
-
-w, --wait=<value>
|
|
2674
|
-
[default: [object Object]] Number of minutes to wait for the command to complete and display results to the terminal
|
|
2675
|
-
window.
|
|
2676
|
-
|
|
2677
|
-
--api-version=<value>
|
|
2678
|
-
Override the api version used for api requests made by this command
|
|
2679
|
-
|
|
2680
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
2681
|
-
Format of the code coverage results.
|
|
2682
|
-
|
|
2683
|
-
--junit
|
|
2684
|
-
Output JUnit test results.
|
|
2685
|
-
|
|
2686
|
-
--resultsdir=<value>
|
|
2687
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
2688
|
-
|
|
2689
|
-
--verbose
|
|
2690
|
-
Verbose output of deploy result.
|
|
2691
|
-
|
|
2692
|
-
GLOBAL FLAGS
|
|
2693
|
-
--json Format output as json.
|
|
2694
|
-
|
|
2695
|
-
DESCRIPTION
|
|
2696
|
-
Check the status of a metadata deployment.
|
|
2697
|
-
|
|
2698
|
-
Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates
|
|
2699
|
-
to the deploy status.
|
|
2700
|
-
|
|
2701
|
-
EXAMPLES
|
|
2702
|
-
Check the status of the most recent deployment on your default org:
|
|
2703
|
-
|
|
2704
|
-
$ sf force source deploy report
|
|
2705
|
-
|
|
2706
|
-
Check the status using the job ID; output JUnit test results and format code coverage results in the specified
|
|
2707
|
-
format:
|
|
2708
|
-
|
|
2709
|
-
$ sf force source deploy report --jobid <id> --junit --coverageformatters cobertura
|
|
2710
|
-
|
|
2711
|
-
FLAG DESCRIPTIONS
|
|
2712
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
2713
|
-
|
|
2714
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2715
|
-
```
|
|
2716
|
-
|
|
2717
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/deploy/report.ts)_
|
|
2718
|
-
|
|
2719
|
-
## `sf force source pull`
|
|
2720
|
-
|
|
2721
|
-
Pull changed source from the org to your project to keep them in sync.
|
|
2722
|
-
|
|
2723
|
-
```
|
|
2724
|
-
USAGE
|
|
2725
|
-
$ sf force source pull -o <value> [--json] [--verbose] [--api-version <value>] [-f] [-w <value>]
|
|
2726
|
-
|
|
2727
|
-
FLAGS
|
|
2728
|
-
-f, --forceoverwrite Ignore conflict warnings; changes in the org overwrite changes in the project.
|
|
2729
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2730
|
-
configuration variable is already set.
|
|
2731
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2732
|
-
display results to the terminal window.
|
|
2733
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2734
|
-
--verbose Display additional details about the command results.
|
|
2735
|
-
|
|
2736
|
-
GLOBAL FLAGS
|
|
2737
|
-
--json Format output as json.
|
|
2738
|
-
|
|
2739
|
-
DESCRIPTION
|
|
2740
|
-
Pull changed source from the org to your project to keep them in sync.
|
|
2741
|
-
|
|
2742
|
-
If the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the
|
|
2743
|
-
conflict, rerun the command with the --forceoverwrite parameter.
|
|
2744
|
-
|
|
2745
|
-
EXAMPLES
|
|
2746
|
-
Pull source from your default org:
|
|
2747
|
-
|
|
2748
|
-
$ sf force source pull
|
|
2749
|
-
|
|
2750
|
-
Pull source from the org with alias "myscratch"; ignore any conflicts and overwrite the local project files with org
|
|
2751
|
-
changes; wait for only 5 minutes:
|
|
2752
|
-
|
|
2753
|
-
$ sf force source pull --target-org myscratch --wait 5 --forceoverwrite
|
|
2754
|
-
|
|
2755
|
-
FLAG DESCRIPTIONS
|
|
2756
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
2757
|
-
|
|
2758
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2759
|
-
```
|
|
2760
|
-
|
|
2761
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/pull.ts)_
|
|
2762
|
-
|
|
2763
|
-
## `sf force source push`
|
|
2764
|
-
|
|
2765
|
-
Push changed source from your project to an org to keep them in sync.
|
|
2766
|
-
|
|
2767
|
-
```
|
|
2768
|
-
USAGE
|
|
2769
|
-
$ sf force source push -o <value> [--json] [--api-version <value>] [-f] [-w <value>] [-g] [--quiet]
|
|
2770
|
-
|
|
2771
|
-
FLAGS
|
|
2772
|
-
-f, --forceoverwrite Ignore conflict warnings and push source anyway; changes in the project overwrite changes
|
|
2773
|
-
in the org.
|
|
2774
|
-
-g, --ignorewarnings Deploy changes even if warnings are generated.
|
|
2775
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2776
|
-
configuration variable is already set.
|
|
2777
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2778
|
-
display results to the terminal window.
|
|
2779
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2780
|
-
--quiet Minimize JSON and sdtout output on success.
|
|
2781
|
-
|
|
2782
|
-
GLOBAL FLAGS
|
|
2783
|
-
--json Format output as json.
|
|
2784
|
-
|
|
2785
|
-
DESCRIPTION
|
|
2786
|
-
Push changed source from your project to an org to keep them in sync.
|
|
2787
|
-
|
|
2788
|
-
If the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the
|
|
2789
|
-
conflict, rerun the command with the --forceoverwrite parameter.
|
|
2790
|
-
|
|
2791
|
-
EXAMPLES
|
|
2792
|
-
Push source to your default org:
|
|
2793
|
-
|
|
2794
|
-
$ sf force source push
|
|
2795
|
-
|
|
2796
|
-
Push source to the org with alias "myscratch"; ignore any conflicts and overwrite with org with the local project
|
|
2797
|
-
changes; wait for only 5 minutes:
|
|
2798
|
-
|
|
2799
|
-
$ sf force source push --target-org myscratch --wait 5 --forceoverwrite
|
|
2800
|
-
|
|
2801
|
-
FLAG DESCRIPTIONS
|
|
2802
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
2803
|
-
|
|
2804
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2805
|
-
```
|
|
2806
|
-
|
|
2807
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/push.ts)_
|
|
2808
|
-
|
|
2809
|
-
## `sf force source retrieve`
|
|
2810
|
-
|
|
2811
|
-
Retrieve source from an org.
|
|
2812
|
-
|
|
2813
|
-
```
|
|
2814
|
-
USAGE
|
|
2815
|
-
$ sf force source retrieve -o <value> [--json] [-a <value>] [-r <value> | -n <value> | -p <value>] [-w <value>] [-x
|
|
2816
|
-
<value> | -m <value> | ] [-f -t] [--verbose]
|
|
2817
|
-
|
|
2818
|
-
FLAGS
|
|
2819
|
-
-a, --api-version=<value> Override the api version used for api requests made by this command
|
|
2820
|
-
-f, --forceoverwrite Ignore conflict warnings and overwrite changes to the project.
|
|
2821
|
-
-m, --metadata=<value>... Comma-separated list of names of metadata components to retrieve from the org.
|
|
2822
|
-
-n, --packagenames=<value>... Comma-separated list of packages to retrieve.
|
|
2823
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2824
|
-
configuration variable is already set.
|
|
2825
|
-
-p, --sourcepath=<value>... Comma-separated list of file paths for source to retrieve from the org.
|
|
2826
|
-
-r, --retrievetargetdir=<value> Root of the directory structure into which the source files are retrieved.
|
|
2827
|
-
-t, --tracksource If the retrieve succeeds, update source tracking information; doesn't delete local
|
|
2828
|
-
files that were deleted in the org.
|
|
2829
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2830
|
-
display results to the terminal window.
|
|
2831
|
-
-x, --manifest=<value> Complete path for the manifest (package.xml) file that specifies the components to
|
|
2832
|
-
retrieve.
|
|
2833
|
-
--verbose Verbose output of retrieve result.
|
|
2834
|
-
|
|
2835
|
-
GLOBAL FLAGS
|
|
2836
|
-
--json Format output as json.
|
|
2837
|
-
|
|
2838
|
-
DESCRIPTION
|
|
2839
|
-
Retrieve source from an org.
|
|
2840
|
-
|
|
2841
|
-
Use this command to retrieve source (metadata that’s in source format) from an org. To take advantage of change
|
|
2842
|
-
tracking with scratch orgs, use "force source pull". To retrieve metadata that’s in metadata format, use "force mdapi
|
|
2843
|
-
retrieve".
|
|
2844
|
-
|
|
2845
|
-
The source you retrieve overwrites the corresponding source files in your local project. This command does not attempt
|
|
2846
|
-
to merge the source from your org with your local source files.
|
|
2847
|
-
|
|
2848
|
-
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of
|
|
2849
|
-
double quotes. On Windows, if the list contains commas, also enclose it in one set of double quotes.
|
|
2850
|
-
|
|
2851
|
-
EXAMPLES
|
|
2852
|
-
Retrieve the source files in a directory from your default org:
|
|
2853
|
-
|
|
2854
|
-
$ sf force source retrieve --sourcepath path/to/source
|
|
2855
|
-
|
|
2856
|
-
Retrieve a specific Apex class and the objects whose source is in a directory from an org with alias "myscratch":
|
|
2857
|
-
|
|
2858
|
-
$ sf force source retrieve --sourcepath "path/to/apex/classes/MyClass.cls,path/to/source/objects" --target-org \
|
|
2859
|
-
myscratch
|
|
2860
|
-
|
|
2861
|
-
Retrieve source files in a comma-separated list that contains spaces:
|
|
2862
|
-
|
|
2863
|
-
$ sf force source retrieve --sourcepath "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, \
|
|
2864
|
-
path/to/apex/classes"
|
|
2865
|
-
|
|
2866
|
-
Retrieve all Apex classes:
|
|
2867
|
-
|
|
2868
|
-
$ sf force source retrieve --metadata ApexClass
|
|
2869
|
-
|
|
2870
|
-
Retrieve a specific Apex class:
|
|
2871
|
-
|
|
2872
|
-
$ sf force source retrieve --metadata ApexClass:MyApexClass
|
|
2873
|
-
|
|
2874
|
-
Retrieve a specific Apex class and update source tracking files:
|
|
2875
|
-
|
|
2876
|
-
$ sf force source retrieve --metadata ApexClass:MyApexClass --tracksource
|
|
2877
|
-
|
|
2878
|
-
Retrieve all custom objects and Apex classes:
|
|
2879
|
-
|
|
2880
|
-
$ sf force source retrieve --metadata "CustomObject,ApexClass"
|
|
2881
|
-
|
|
2882
|
-
Retrieve all Apex classes and two specific profiles (one of which has a space in its name):
|
|
2883
|
-
|
|
2884
|
-
$ sf force source retrieve --metadata "ApexClass, Profile:My Profile, Profile: AnotherProfile"
|
|
2885
|
-
|
|
2886
|
-
Retrieve all metadata components listed in a manifest:
|
|
2887
|
-
|
|
2888
|
-
$ sf force source retrieve --manifest path/to/package.xml
|
|
2889
|
-
|
|
2890
|
-
Retrieve metadata from a package or multiple packages:
|
|
2891
|
-
|
|
2892
|
-
$ sf force source retrieve --packagenames MyPackageName
|
|
2893
|
-
$ sf force source retrieve --packagenames "Package1, PackageName With Spaces, Package3"
|
|
2894
|
-
|
|
2895
|
-
Retrieve all metadata from a package and specific components that aren’t in the package, specify both -n |
|
|
2896
|
-
--packagenames and one other scoping parameter:
|
|
2897
|
-
|
|
2898
|
-
$ sf force source retrieve --packagenames MyPackageName --sourcepath path/to/apex/classes
|
|
2899
|
-
$ sf force source retrieve --packagenames MyPackageName --metadata ApexClass:MyApexClass
|
|
2900
|
-
$ sf force source retrieve --packagenames MyPackageName --manifest path/to/package.xml
|
|
2901
|
-
|
|
2902
|
-
Retrieve source files to a given directory instead of the default package directory specified in sfdx-project.json:
|
|
2903
|
-
|
|
2904
|
-
$ sf force source retrieve --metadata "StandardValueSet:TaskStatus" --retrievetargetdir path/to/unpackaged
|
|
2905
|
-
|
|
2906
|
-
FLAG DESCRIPTIONS
|
|
2907
|
-
-m, --metadata=<value>... Comma-separated list of names of metadata components to retrieve from the org.
|
|
2908
|
-
|
|
2909
|
-
If you specify this parameter, don’t specify --manifest or --sourcepath.
|
|
2910
|
-
|
|
2911
|
-
-p, --sourcepath=<value>... Comma-separated list of file paths for source to retrieve from the org.
|
|
2912
|
-
|
|
2913
|
-
The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
|
|
2914
|
-
(in which case the operation is applied to all source files in the directory and its sub-directories).
|
|
2915
|
-
|
|
2916
|
-
If you specify this parameter, don’t specify --manifest or --metadata.
|
|
2917
|
-
|
|
2918
|
-
-r, --retrievetargetdir=<value> Root of the directory structure into which the source files are retrieved.
|
|
2919
|
-
|
|
2920
|
-
If the target directory matches one of the package directories in your sfdx-project.json file, the command fails.
|
|
2921
|
-
|
|
2922
|
-
Running the command multiple times with the same target adds new files and overwrites existing files.
|
|
2923
|
-
|
|
2924
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
2925
|
-
|
|
2926
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2927
|
-
|
|
2928
|
-
-x, --manifest=<value> Complete path for the manifest (package.xml) file that specifies the components to retrieve.
|
|
2929
|
-
|
|
2930
|
-
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
2931
|
-
```
|
|
2932
|
-
|
|
2933
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/retrieve.ts)_
|
|
2934
|
-
|
|
2935
|
-
## `sf force source status`
|
|
2936
|
-
|
|
2937
|
-
List changes that have been made locally, in an org, or both.
|
|
2938
|
-
|
|
2939
|
-
```
|
|
2940
|
-
USAGE
|
|
2941
|
-
$ sf force source status -o <value> [--json] [--api-version <value>] [-l | -r] [--concise]
|
|
2942
|
-
|
|
2943
|
-
FLAGS
|
|
2944
|
-
-l, --local List the changes that have been made locally.
|
|
2945
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2946
|
-
configuration variable is already set.
|
|
2947
|
-
-r, --remote List the changes that have been made in the org.
|
|
2948
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2949
|
-
--concise Show only the changes that will be pushed or pulled; omits files that are forceignored.
|
|
2950
|
-
|
|
2951
|
-
GLOBAL FLAGS
|
|
2952
|
-
--json Format output as json.
|
|
2953
|
-
|
|
2954
|
-
EXAMPLES
|
|
2955
|
-
List changes that have been made locally but not in the org with alias "myscratch":
|
|
2956
|
-
|
|
2957
|
-
$ sf force source status --local --target-org myscratch
|
|
2958
|
-
|
|
2959
|
-
List changes that have been made in your default org but aren't reflected in your local project:
|
|
2960
|
-
|
|
2961
|
-
$ sf force source status --remote
|
|
2962
|
-
```
|
|
2963
|
-
|
|
2964
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/status.ts)_
|
|
2965
|
-
|
|
2966
1895
|
## `sf help [COMMANDS]`
|
|
2967
1896
|
|
|
2968
1897
|
Display help for sf.
|
|
@@ -5009,7 +3938,7 @@ FLAG DESCRIPTIONS
|
|
|
5009
3938
|
subscribers.
|
|
5010
3939
|
```
|
|
5011
3940
|
|
|
5012
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
3941
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package1/version/create.ts)_
|
|
5013
3942
|
|
|
5014
3943
|
## `sf package1 version create get`
|
|
5015
3944
|
|
|
@@ -5041,7 +3970,7 @@ EXAMPLES
|
|
|
5041
3970
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
5042
3971
|
```
|
|
5043
3972
|
|
|
5044
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
3973
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package1/version/create/get.ts)_
|
|
5045
3974
|
|
|
5046
3975
|
## `sf package1 version display`
|
|
5047
3976
|
|
|
@@ -5074,7 +4003,7 @@ EXAMPLES
|
|
|
5074
4003
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
5075
4004
|
```
|
|
5076
4005
|
|
|
5077
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4006
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package1/version/display.ts)_
|
|
5078
4007
|
|
|
5079
4008
|
## `sf package1 version list`
|
|
5080
4009
|
|
|
@@ -5111,7 +4040,7 @@ FLAG DESCRIPTIONS
|
|
|
5111
4040
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
5112
4041
|
```
|
|
5113
4042
|
|
|
5114
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4043
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package1/version/list.ts)_
|
|
5115
4044
|
|
|
5116
4045
|
## `sf package create`
|
|
5117
4046
|
|
|
@@ -5189,7 +4118,7 @@ FLAG DESCRIPTIONS
|
|
|
5189
4118
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
5190
4119
|
```
|
|
5191
4120
|
|
|
5192
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4121
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/create.ts)_
|
|
5193
4122
|
|
|
5194
4123
|
## `sf package delete`
|
|
5195
4124
|
|
|
@@ -5230,7 +4159,7 @@ EXAMPLES
|
|
|
5230
4159
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
5231
4160
|
```
|
|
5232
4161
|
|
|
5233
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4162
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/delete.ts)_
|
|
5234
4163
|
|
|
5235
4164
|
## `sf package install`
|
|
5236
4165
|
|
|
@@ -5328,7 +4257,7 @@ FLAG DESCRIPTIONS
|
|
|
5328
4257
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
5329
4258
|
```
|
|
5330
4259
|
|
|
5331
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4260
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/install.ts)_
|
|
5332
4261
|
|
|
5333
4262
|
## `sf package install report`
|
|
5334
4263
|
|
|
@@ -5360,7 +4289,7 @@ EXAMPLES
|
|
|
5360
4289
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
5361
4290
|
```
|
|
5362
4291
|
|
|
5363
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4292
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/install/report.ts)_
|
|
5364
4293
|
|
|
5365
4294
|
## `sf package installed list`
|
|
5366
4295
|
|
|
@@ -5391,7 +4320,7 @@ EXAMPLES
|
|
|
5391
4320
|
$ sf package installed list --target-org me@example.com
|
|
5392
4321
|
```
|
|
5393
4322
|
|
|
5394
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4323
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/installed/list.ts)_
|
|
5395
4324
|
|
|
5396
4325
|
## `sf package list`
|
|
5397
4326
|
|
|
@@ -5428,7 +4357,7 @@ EXAMPLES
|
|
|
5428
4357
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
5429
4358
|
```
|
|
5430
4359
|
|
|
5431
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4360
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/list.ts)_
|
|
5432
4361
|
|
|
5433
4362
|
## `sf package uninstall`
|
|
5434
4363
|
|
|
@@ -5475,7 +4404,7 @@ EXAMPLES
|
|
|
5475
4404
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
5476
4405
|
```
|
|
5477
4406
|
|
|
5478
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4407
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/uninstall.ts)_
|
|
5479
4408
|
|
|
5480
4409
|
## `sf package uninstall report`
|
|
5481
4410
|
|
|
@@ -5507,7 +4436,7 @@ EXAMPLES
|
|
|
5507
4436
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
5508
4437
|
```
|
|
5509
4438
|
|
|
5510
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4439
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/uninstall/report.ts)_
|
|
5511
4440
|
|
|
5512
4441
|
## `sf package update`
|
|
5513
4442
|
|
|
@@ -5561,7 +4490,7 @@ FLAG DESCRIPTIONS
|
|
|
5561
4490
|
associated with your package.
|
|
5562
4491
|
```
|
|
5563
4492
|
|
|
5564
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4493
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/update.ts)_
|
|
5565
4494
|
|
|
5566
4495
|
## `sf package version create`
|
|
5567
4496
|
|
|
@@ -5716,7 +4645,7 @@ FLAG DESCRIPTIONS
|
|
|
5716
4645
|
periods of no output from commands.
|
|
5717
4646
|
```
|
|
5718
4647
|
|
|
5719
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4648
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/create.ts)_
|
|
5720
4649
|
|
|
5721
4650
|
## `sf package version create list`
|
|
5722
4651
|
|
|
@@ -5776,7 +4705,7 @@ EXAMPLES
|
|
|
5776
4705
|
$ sf package version create list --created-last-days 0 --status Success
|
|
5777
4706
|
```
|
|
5778
4707
|
|
|
5779
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4708
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/create/list.ts)_
|
|
5780
4709
|
|
|
5781
4710
|
## `sf package version create report`
|
|
5782
4711
|
|
|
@@ -5818,7 +4747,7 @@ EXAMPLES
|
|
|
5818
4747
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
5819
4748
|
```
|
|
5820
4749
|
|
|
5821
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4750
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/create/report.ts)_
|
|
5822
4751
|
|
|
5823
4752
|
## `sf package version delete`
|
|
5824
4753
|
|
|
@@ -5856,7 +4785,7 @@ EXAMPLES
|
|
|
5856
4785
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
5857
4786
|
```
|
|
5858
4787
|
|
|
5859
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4788
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/delete.ts)_
|
|
5860
4789
|
|
|
5861
4790
|
## `sf package version displayancestry`
|
|
5862
4791
|
|
|
@@ -5914,7 +4843,7 @@ FLAG DESCRIPTIONS
|
|
|
5914
4843
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
5915
4844
|
```
|
|
5916
4845
|
|
|
5917
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4846
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/displayancestry.ts)_
|
|
5918
4847
|
|
|
5919
4848
|
## `sf package version list`
|
|
5920
4849
|
|
|
@@ -5982,7 +4911,7 @@ EXAMPLES
|
|
|
5982
4911
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
5983
4912
|
```
|
|
5984
4913
|
|
|
5985
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4914
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/list.ts)_
|
|
5986
4915
|
|
|
5987
4916
|
## `sf package version promote`
|
|
5988
4917
|
|
|
@@ -6025,7 +4954,7 @@ EXAMPLES
|
|
|
6025
4954
|
$ sf package version promote --package "Awesome Package Alias"
|
|
6026
4955
|
```
|
|
6027
4956
|
|
|
6028
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4957
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/promote.ts)_
|
|
6029
4958
|
|
|
6030
4959
|
## `sf package version report`
|
|
6031
4960
|
|
|
@@ -6064,7 +4993,7 @@ EXAMPLES
|
|
|
6064
4993
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
6065
4994
|
```
|
|
6066
4995
|
|
|
6067
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
4996
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/report.ts)_
|
|
6068
4997
|
|
|
6069
4998
|
## `sf package version update`
|
|
6070
4999
|
|
|
@@ -6116,7 +5045,7 @@ EXAMPLES
|
|
|
6116
5045
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
6117
5046
|
```
|
|
6118
5047
|
|
|
6119
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.
|
|
5048
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.0.2/src/commands/package/version/update.ts)_
|
|
6120
5049
|
|
|
6121
5050
|
## `sf plugins`
|
|
6122
5051
|
|
|
@@ -6404,7 +5333,7 @@ FLAG DESCRIPTIONS
|
|
|
6404
5333
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
6405
5334
|
```
|
|
6406
5335
|
|
|
6407
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5336
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/convert/mdapi.ts)_
|
|
6408
5337
|
|
|
6409
5338
|
## `sf project convert source`
|
|
6410
5339
|
|
|
@@ -6416,7 +5345,7 @@ USAGE
|
|
|
6416
5345
|
<value> | -m <value>]
|
|
6417
5346
|
|
|
6418
5347
|
FLAGS
|
|
6419
|
-
-d, --output-dir=<value> [default:
|
|
5348
|
+
-d, --output-dir=<value> [default: metadataPackage_1704318036676] Output directory to store the Metadata
|
|
6420
5349
|
API–formatted files in.
|
|
6421
5350
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
6422
5351
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -6476,7 +5405,7 @@ FLAG DESCRIPTIONS
|
|
|
6476
5405
|
Override the api version used for api requests made by this command
|
|
6477
5406
|
```
|
|
6478
5407
|
|
|
6479
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5408
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/convert/source.ts)_
|
|
6480
5409
|
|
|
6481
5410
|
## `sf project delete source`
|
|
6482
5411
|
|
|
@@ -6615,7 +5544,7 @@ FLAG DESCRIPTIONS
|
|
|
6615
5544
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
6616
5545
|
```
|
|
6617
5546
|
|
|
6618
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5547
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/delete/source.ts)_
|
|
6619
5548
|
|
|
6620
5549
|
## `sf project delete tracking`
|
|
6621
5550
|
|
|
@@ -6651,7 +5580,7 @@ EXAMPLES
|
|
|
6651
5580
|
$ sf project delete tracking --target-org my-scratch
|
|
6652
5581
|
```
|
|
6653
5582
|
|
|
6654
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5583
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/delete/tracking.ts)_
|
|
6655
5584
|
|
|
6656
5585
|
## `sf project deploy cancel`
|
|
6657
5586
|
|
|
@@ -6721,7 +5650,7 @@ FLAG DESCRIPTIONS
|
|
|
6721
5650
|
project deploy report".
|
|
6722
5651
|
```
|
|
6723
5652
|
|
|
6724
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5653
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/deploy/cancel.ts)_
|
|
6725
5654
|
|
|
6726
5655
|
## `sf project deploy preview`
|
|
6727
5656
|
|
|
@@ -6804,7 +5733,7 @@ FLAG DESCRIPTIONS
|
|
|
6804
5733
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
6805
5734
|
```
|
|
6806
5735
|
|
|
6807
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5736
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/deploy/preview.ts)_
|
|
6808
5737
|
|
|
6809
5738
|
## `sf project deploy quick`
|
|
6810
5739
|
|
|
@@ -6897,7 +5826,7 @@ ERROR CODES
|
|
|
6897
5826
|
Canceling (69) The deploy is being canceled.
|
|
6898
5827
|
```
|
|
6899
5828
|
|
|
6900
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5829
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/deploy/quick.ts)_
|
|
6901
5830
|
|
|
6902
5831
|
## `sf project deploy report`
|
|
6903
5832
|
|
|
@@ -6992,7 +5921,7 @@ FLAG DESCRIPTIONS
|
|
|
6992
5921
|
--coverage-formatters lcov --coverage-formatters clover
|
|
6993
5922
|
```
|
|
6994
5923
|
|
|
6995
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
5924
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/deploy/report.ts)_
|
|
6996
5925
|
|
|
6997
5926
|
## `sf project deploy resume`
|
|
6998
5927
|
|
|
@@ -7088,7 +6017,7 @@ ERROR CODES
|
|
|
7088
6017
|
Canceling (69) The deploy is being canceled.
|
|
7089
6018
|
```
|
|
7090
6019
|
|
|
7091
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6020
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/deploy/resume.ts)_
|
|
7092
6021
|
|
|
7093
6022
|
## `sf project deploy start`
|
|
7094
6023
|
|
|
@@ -7317,7 +6246,7 @@ ERROR CODES
|
|
|
7317
6246
|
Canceling (69) The deploy is being canceled.
|
|
7318
6247
|
```
|
|
7319
6248
|
|
|
7320
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6249
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/deploy/start.ts)_
|
|
7321
6250
|
|
|
7322
6251
|
## `sf project deploy validate`
|
|
7323
6252
|
|
|
@@ -7496,7 +6425,7 @@ ERROR CODES
|
|
|
7496
6425
|
Canceling (69) The deploy is being canceled.
|
|
7497
6426
|
```
|
|
7498
6427
|
|
|
7499
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6428
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/deploy/validate.ts)_
|
|
7500
6429
|
|
|
7501
6430
|
## `sf project generate`
|
|
7502
6431
|
|
|
@@ -7675,7 +6604,7 @@ EXAMPLES
|
|
|
7675
6604
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
7676
6605
|
```
|
|
7677
6606
|
|
|
7678
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6607
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/generate/manifest.ts)_
|
|
7679
6608
|
|
|
7680
6609
|
## `sf project list ignored`
|
|
7681
6610
|
|
|
@@ -7716,7 +6645,7 @@ EXAMPLES
|
|
|
7716
6645
|
$ sf project list ignored --source-dir package.xml
|
|
7717
6646
|
```
|
|
7718
6647
|
|
|
7719
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6648
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/list/ignored.ts)_
|
|
7720
6649
|
|
|
7721
6650
|
## `sf project reset tracking`
|
|
7722
6651
|
|
|
@@ -7764,7 +6693,7 @@ EXAMPLES
|
|
|
7764
6693
|
$ sf project reset tracking --revision 30
|
|
7765
6694
|
```
|
|
7766
6695
|
|
|
7767
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6696
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/reset/tracking.ts)_
|
|
7768
6697
|
|
|
7769
6698
|
## `sf project retrieve preview`
|
|
7770
6699
|
|
|
@@ -7820,7 +6749,7 @@ FLAG DESCRIPTIONS
|
|
|
7820
6749
|
Overrides your default org.
|
|
7821
6750
|
```
|
|
7822
6751
|
|
|
7823
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6752
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/retrieve/preview.ts)_
|
|
7824
6753
|
|
|
7825
6754
|
## `sf project retrieve start`
|
|
7826
6755
|
|
|
@@ -7974,7 +6903,7 @@ ENVIRONMENT VARIABLES
|
|
|
7974
6903
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
7975
6904
|
```
|
|
7976
6905
|
|
|
7977
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.
|
|
6906
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/2.2.13/src/commands/project/retrieve/start.ts)_
|
|
7978
6907
|
|
|
7979
6908
|
## `sf schema generate field`
|
|
7980
6909
|
|