@salesforce/cli 2.23.19 → 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 +82 -1390
- package/npm-shrinkwrap.json +13350 -15508
- package/oclif.manifest.json +6 -1
- package/package.json +13 -13
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,23 +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 org clone`](#sf-force-org-clone)
|
|
85
|
-
- [`sf force org create`](#sf-force-org-create)
|
|
86
|
-
- [`sf force org delete`](#sf-force-org-delete)
|
|
87
|
-
- [`sf force org status`](#sf-force-org-status)
|
|
88
|
-
- [`sf force source deploy`](#sf-force-source-deploy)
|
|
89
|
-
- [`sf force source deploy cancel`](#sf-force-source-deploy-cancel)
|
|
90
|
-
- [`sf force source deploy report`](#sf-force-source-deploy-report)
|
|
91
|
-
- [`sf force source pull`](#sf-force-source-pull)
|
|
92
|
-
- [`sf force source push`](#sf-force-source-push)
|
|
93
|
-
- [`sf force source retrieve`](#sf-force-source-retrieve)
|
|
94
|
-
- [`sf force source status`](#sf-force-source-status)
|
|
95
|
-
- [`sf force user password generate`](#sf-force-user-password-generate)
|
|
96
79
|
- [`sf help [COMMANDS]`](#sf-help-commands)
|
|
97
80
|
- [`sf info releasenotes display`](#sf-info-releasenotes-display)
|
|
98
81
|
- [`sf lightning generate app`](#sf-lightning-generate-app)
|
|
@@ -844,14 +827,15 @@ list all the commands
|
|
|
844
827
|
|
|
845
828
|
```
|
|
846
829
|
USAGE
|
|
847
|
-
$ sf commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter <value>]
|
|
848
|
-
[--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
|
|
830
|
+
$ sf commands [--json] [--deprecated] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter <value>]
|
|
831
|
+
[--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
|
|
849
832
|
|
|
850
833
|
FLAGS
|
|
851
834
|
-h, --help Show CLI help.
|
|
852
835
|
-x, --extended show extra columns
|
|
853
836
|
--columns=<value> only show provided columns (comma-separated)
|
|
854
837
|
--csv output is csv format [alias: --output=csv]
|
|
838
|
+
--deprecated show deprecated commands
|
|
855
839
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
856
840
|
--hidden show hidden commands
|
|
857
841
|
--no-header hide table header from output
|
|
@@ -868,7 +852,7 @@ DESCRIPTION
|
|
|
868
852
|
list all the commands
|
|
869
853
|
```
|
|
870
854
|
|
|
871
|
-
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.0
|
|
855
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.1.0/src/commands/commands.ts)_
|
|
872
856
|
|
|
873
857
|
## `sf config get`
|
|
874
858
|
|
|
@@ -1908,1298 +1892,6 @@ EXAMPLES
|
|
|
1908
1892
|
|
|
1909
1893
|
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/3.0.13/src/commands/force/data/bulk/upsert.ts)_
|
|
1910
1894
|
|
|
1911
|
-
## `sf force mdapi deploy`
|
|
1912
|
-
|
|
1913
|
-
Deploy metadata to an org using Metadata API.
|
|
1914
|
-
|
|
1915
|
-
```
|
|
1916
|
-
USAGE
|
|
1917
|
-
$ sf force mdapi deploy -u <value> [--json] [--api-version <value>] [-d <value>] [-w <value>] [-o] [-g] [-q <value> |
|
|
1918
|
-
-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <value> | -c] [--verbose] [-f <value>] [-s]
|
|
1919
|
-
[--soapdeploy] [--purgeondelete] [--concise] [--resultsdir <value>] [--coverageformatters
|
|
1920
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
1921
|
-
|
|
1922
|
-
FLAGS
|
|
1923
|
-
-c, --checkonly
|
|
1924
|
-
Validates the deployed metadata and runs all Apex tests, but prevents the deployment from being saved to the org.
|
|
1925
|
-
|
|
1926
|
-
-d, --deploydir=<value>
|
|
1927
|
-
Root of directory tree that contains the files you want to deploy.
|
|
1928
|
-
|
|
1929
|
-
-f, --zipfile=<value>
|
|
1930
|
-
Path to .zip file of metadata to deploy.
|
|
1931
|
-
|
|
1932
|
-
-g, --ignorewarnings
|
|
1933
|
-
Ignore any warnings and don't roll back the deployment.
|
|
1934
|
-
|
|
1935
|
-
-l, --testlevel=<option>
|
|
1936
|
-
Level of deployment tests to run.
|
|
1937
|
-
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
1938
|
-
|
|
1939
|
-
-o, --ignoreerrors
|
|
1940
|
-
Ignore any errors and don't roll back the deployment.
|
|
1941
|
-
|
|
1942
|
-
-q, --validateddeployrequestid=<value>
|
|
1943
|
-
Request ID of the validated deployment to run a Quick Deploy.
|
|
1944
|
-
|
|
1945
|
-
-r, --runtests=<value>...
|
|
1946
|
-
Apex test classes to run if --testlevel is RunSpecifiedTests.
|
|
1947
|
-
|
|
1948
|
-
-s, --singlepackage
|
|
1949
|
-
Indicates that the zip file points to a directory structure for a single package.
|
|
1950
|
-
|
|
1951
|
-
-u, --target-org=<value>
|
|
1952
|
-
(required) Username or alias of the target org.
|
|
1953
|
-
|
|
1954
|
-
-w, --wait=<value>
|
|
1955
|
-
[default: [object Object]] Number of minutes to wait for the command to finish; specify -1 to wait indefinitely.
|
|
1956
|
-
|
|
1957
|
-
--api-version=<value>
|
|
1958
|
-
Override the api version used for api requests made by this command
|
|
1959
|
-
|
|
1960
|
-
--concise
|
|
1961
|
-
Omit success messages for smaller JSON output.
|
|
1962
|
-
|
|
1963
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
1964
|
-
Format of the code coverage results.
|
|
1965
|
-
|
|
1966
|
-
--junit
|
|
1967
|
-
Output JUnit test results.
|
|
1968
|
-
|
|
1969
|
-
--purgeondelete
|
|
1970
|
-
Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion
|
|
1971
|
-
rather than being stored in the Recycle Bin.
|
|
1972
|
-
|
|
1973
|
-
--resultsdir=<value>
|
|
1974
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
1975
|
-
|
|
1976
|
-
--soapdeploy
|
|
1977
|
-
Deploy metadata with SOAP API instead of REST API.
|
|
1978
|
-
|
|
1979
|
-
--verbose
|
|
1980
|
-
Display verbose output of the deploy results.
|
|
1981
|
-
|
|
1982
|
-
GLOBAL FLAGS
|
|
1983
|
-
--json Format output as json.
|
|
1984
|
-
|
|
1985
|
-
EXAMPLES
|
|
1986
|
-
Return a job ID you can use to check the deploy status:
|
|
1987
|
-
|
|
1988
|
-
$ sf force mdapi deploy --deploydir some/path
|
|
1989
|
-
|
|
1990
|
-
Deploy and poll for 1000 minutes:
|
|
1991
|
-
|
|
1992
|
-
$ sf force mdapi deploy --deploydir some/path --wait 1000
|
|
1993
|
-
|
|
1994
|
-
Deploy a ZIP file:
|
|
1995
|
-
|
|
1996
|
-
$ sf force mdapi deploy --zipfile stuff.zip
|
|
1997
|
-
|
|
1998
|
-
Validate a deployment so the ID can be used for a quick deploy:
|
|
1999
|
-
|
|
2000
|
-
$ sf force mdapi deploy --deploydir some/path --wait 1000 --checkonly --testlevel RunAllTestsInOrg
|
|
2001
|
-
|
|
2002
|
-
Quick deploy using a previously validated deployment:
|
|
2003
|
-
|
|
2004
|
-
$ sf force mdapi deploy --validateddeployrequestid MyValidatedId
|
|
2005
|
-
|
|
2006
|
-
FLAG DESCRIPTIONS
|
|
2007
|
-
-c, --checkonly
|
|
2008
|
-
|
|
2009
|
-
Validates the deployed metadata and runs all Apex tests, but prevents the deployment from being saved to the org.
|
|
2010
|
-
|
|
2011
|
-
IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained
|
|
2012
|
-
certain terms to avoid any effect on customer implementations.
|
|
2013
|
-
|
|
2014
|
-
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the
|
|
2015
|
-
--checkonly parameter to test a deployment (validation). This kind of change isn’t supported for test deployments to
|
|
2016
|
-
avoid the risk of data loss or corruption. If a change that isn’t supported for test deployments is included in a
|
|
2017
|
-
deployment package, the test deployment fails and issues an error.
|
|
2018
|
-
|
|
2019
|
-
If your deployment package changes a field type from Master-Detail to Lookup or vice versa, you can still validate
|
|
2020
|
-
the changes prior to deploying to Production by performing a full deployment to another test Sandbox. A full
|
|
2021
|
-
deployment includes a validation of the changes as part of the deployment process.
|
|
2022
|
-
|
|
2023
|
-
Note: A Metadata API deployment that includes Master-Detail relationships deletes all detail records in the Recycle
|
|
2024
|
-
Bin in the following cases.
|
|
2025
|
-
|
|
2026
|
-
1. For a deployment with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before
|
|
2027
|
-
proceeding to deploy the Master-Detail field, or the deployment fails. During the deployment, detail records are
|
|
2028
|
-
permanently deleted from the Recycle Bin and cannot be recovered.
|
|
2029
|
-
2. For a deployment that converts a Lookup field relationship to a Master-Detail relationship, detail records must
|
|
2030
|
-
reference a master record or be soft-deleted (sent to the Recycle Bin) for the deployment to succeed. However, a
|
|
2031
|
-
successful deployment permanently deletes any detail records in the Recycle Bin.
|
|
2032
|
-
|
|
2033
|
-
-d, --deploydir=<value> Root of directory tree that contains the files you want to deploy.
|
|
2034
|
-
|
|
2035
|
-
The root must contain a valid package.xml file describing the entities in the directory structure. Required to
|
|
2036
|
-
initiate a deployment if you don’t use --zipfile. If you specify both --zipfile and --deploydir, a zip file of the
|
|
2037
|
-
contents of the --deploydir directory is written to the location specified by --zipfile.
|
|
2038
|
-
|
|
2039
|
-
-f, --zipfile=<value> Path to .zip file of metadata to deploy.
|
|
2040
|
-
|
|
2041
|
-
You must indicate this option or --deploydir. If you specify both --zipfile and --deploydir, a .zip file of the
|
|
2042
|
-
contents of the deploy directory is created at the path specified for the .zip file.
|
|
2043
|
-
|
|
2044
|
-
-g, --ignorewarnings Ignore any warnings and don't roll back the deployment.
|
|
2045
|
-
|
|
2046
|
-
If a warning occurs and ignoreWarnings is set to true, the success field in DeployMessage is true. When
|
|
2047
|
-
ignoreWarnings is set to false, success is set to false, and the warning is treated like an error.
|
|
2048
|
-
This field is available in API version 18.0 and later. Prior to version 18.0, there was no distinction between
|
|
2049
|
-
warnings and errors. All problems were treated as errors and prevented a successful deployment.
|
|
2050
|
-
|
|
2051
|
-
-l, --testlevel=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Level of deployment tests to run.
|
|
2052
|
-
|
|
2053
|
-
Valid values are:
|
|
2054
|
-
|
|
2055
|
-
* NoTestRun—No tests are run. This test level applies only to deployments to development environments, such as
|
|
2056
|
-
sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
|
|
2057
|
-
* RunSpecifiedTests—Runs only the tests that you specify in the --runtests option. Code coverage requirements differ
|
|
2058
|
-
from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
|
|
2059
|
-
code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
|
|
2060
|
-
trigger individually and is different than the overall coverage percentage.
|
|
2061
|
-
* RunLocalTests—All tests in your org are run, except the ones that originate from installed managed and unlocked
|
|
2062
|
-
packages. This test level is the default for production deployments that include Apex classes or triggers.
|
|
2063
|
-
* RunAllTestsInOrg—All tests in your org are run, including tests of managed packages.
|
|
2064
|
-
|
|
2065
|
-
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
|
|
2066
|
-
information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.
|
|
2067
|
-
|
|
2068
|
-
-o, --ignoreerrors Ignore any errors and don't roll back the deployment.
|
|
2069
|
-
|
|
2070
|
-
The default is false. Keep this parameter set to false when deploying to a production org. If set to true,
|
|
2071
|
-
components without errors are deployed, and components with errors are skipped.
|
|
2072
|
-
|
|
2073
|
-
-q, --validateddeployrequestid=<value> Request ID of the validated deployment to run a Quick Deploy.
|
|
2074
|
-
|
|
2075
|
-
Deploying a validation helps you shorten your deployment time because tests aren’t rerun. If you have a recent
|
|
2076
|
-
successful validation, you can deploy the validated components without running tests. A validation doesn’t save any
|
|
2077
|
-
components in the org. You use a validation only to check the success or failure messages that you would receive
|
|
2078
|
-
with an actual deployment. To validate your components, add the -c | --checkonly flag when you run 'force mdapi
|
|
2079
|
-
deploy'. This flag sets the checkOnly='true' parameter for your deployment. Before deploying a recent validation,
|
|
2080
|
-
ensure that the following requirements are met:
|
|
2081
|
-
|
|
2082
|
-
1. The components have been validated successfully for the target environment within the last 10 days.
|
|
2083
|
-
2. As part of the validation, Apex tests in the target org have passed.
|
|
2084
|
-
3. Code coverage requirements are met.
|
|
2085
|
-
- If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have
|
|
2086
|
-
some coverage.
|
|
2087
|
-
- If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is
|
|
2088
|
-
covered by at least 75% individually.
|
|
2089
|
-
|
|
2090
|
-
-s, --singlepackage Indicates that the zip file points to a directory structure for a single package.
|
|
2091
|
-
|
|
2092
|
-
By default, the CLI assumes the directory is structured for a set of packages.
|
|
2093
|
-
|
|
2094
|
-
-w, --wait=<value> Number of minutes to wait for the command to finish; specify -1 to wait indefinitely.
|
|
2095
|
-
|
|
2096
|
-
The default is 0 (returns immediately).
|
|
2097
|
-
|
|
2098
|
-
--soapdeploy Deploy metadata with SOAP API instead of REST API.
|
|
2099
|
-
|
|
2100
|
-
Because SOAP API has a lower .ZIP file size limit (400 MB uncompressed, 39 MB compressed), Salesforce recommends
|
|
2101
|
-
REST API deployment. This flag provides backwards compatibility with API version 50.0 and earlier when deploy used
|
|
2102
|
-
SOAP API by default.
|
|
2103
|
-
|
|
2104
|
-
--verbose Display verbose output of the deploy results.
|
|
2105
|
-
|
|
2106
|
-
Indicates that you want verbose output from the deploy operation.
|
|
2107
|
-
```
|
|
2108
|
-
|
|
2109
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/deploy.ts)_
|
|
2110
|
-
|
|
2111
|
-
## `sf force mdapi deploy cancel`
|
|
2112
|
-
|
|
2113
|
-
Cancel a metadata deployment.
|
|
2114
|
-
|
|
2115
|
-
```
|
|
2116
|
-
USAGE
|
|
2117
|
-
$ sf force mdapi deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2118
|
-
|
|
2119
|
-
FLAGS
|
|
2120
|
-
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment.
|
|
2121
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2122
|
-
configuration variable is already set.
|
|
2123
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes for the command to complete and display
|
|
2124
|
-
results to the terminal window.
|
|
2125
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2126
|
-
|
|
2127
|
-
GLOBAL FLAGS
|
|
2128
|
-
--json Format output as json.
|
|
2129
|
-
|
|
2130
|
-
DESCRIPTION
|
|
2131
|
-
Cancel a metadata deployment.
|
|
2132
|
-
|
|
2133
|
-
Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes)
|
|
2134
|
-
to check for updates to the canceled deploy status.
|
|
2135
|
-
|
|
2136
|
-
Cancels an asynchronous metadata deployment.
|
|
2137
|
-
|
|
2138
|
-
EXAMPLES
|
|
2139
|
-
Cancel a deployment and wait two minutes:
|
|
2140
|
-
|
|
2141
|
-
$ sf force mdapi deploy cancel --wait 2
|
|
2142
|
-
|
|
2143
|
-
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID:
|
|
2144
|
-
|
|
2145
|
-
$ sf force mdapi deploy cancel --jobid <jobid>
|
|
2146
|
-
|
|
2147
|
-
FLAG DESCRIPTIONS
|
|
2148
|
-
-w, --wait=<value> Number of minutes for the command to complete and display results to the terminal window.
|
|
2149
|
-
|
|
2150
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2151
|
-
```
|
|
2152
|
-
|
|
2153
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/deploy/cancel.ts)_
|
|
2154
|
-
|
|
2155
|
-
## `sf force mdapi deploy report`
|
|
2156
|
-
|
|
2157
|
-
Check the status of a metadata deployment.
|
|
2158
|
-
|
|
2159
|
-
```
|
|
2160
|
-
USAGE
|
|
2161
|
-
$ sf force mdapi deploy report -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>] [--verbose] [--concise]
|
|
2162
|
-
[--resultsdir <value>] [--coverageformatters
|
|
2163
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2164
|
-
|
|
2165
|
-
FLAGS
|
|
2166
|
-
-i, --jobid=<value>
|
|
2167
|
-
Job ID of the deployment to check; required if you’ve never deployed using Salesforce CLI; defaults to your most
|
|
2168
|
-
recent CLI deployment.
|
|
2169
|
-
|
|
2170
|
-
-o, --target-org=<value>
|
|
2171
|
-
(required) Username or alias of the target org. Not required if the `target-org` configuration variable is already
|
|
2172
|
-
set.
|
|
2173
|
-
|
|
2174
|
-
-w, --wait=<value>
|
|
2175
|
-
[default: [object Object]] Number of minutes to wait for the command to finish; use -1 to poll indefinitely.
|
|
2176
|
-
|
|
2177
|
-
--api-version=<value>
|
|
2178
|
-
Override the api version used for api requests made by this command
|
|
2179
|
-
|
|
2180
|
-
--concise
|
|
2181
|
-
Omit success messages for smaller JSON output.
|
|
2182
|
-
|
|
2183
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
2184
|
-
Format of the code coverage results.
|
|
2185
|
-
|
|
2186
|
-
--junit
|
|
2187
|
-
Output JUnit test results.
|
|
2188
|
-
|
|
2189
|
-
--resultsdir=<value>
|
|
2190
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
2191
|
-
|
|
2192
|
-
--verbose
|
|
2193
|
-
Verbose output of deploy results.
|
|
2194
|
-
|
|
2195
|
-
GLOBAL FLAGS
|
|
2196
|
-
--json Format output as json.
|
|
2197
|
-
|
|
2198
|
-
DESCRIPTION
|
|
2199
|
-
Check the status of a metadata deployment.
|
|
2200
|
-
|
|
2201
|
-
Specify the job ID for the deploy you want to check. The job ID is returned by the "force mdapi deploy" command when
|
|
2202
|
-
run without the --wait parameter. You can also specify a wait time (minutes) to check for updates to the deploy
|
|
2203
|
-
status.
|
|
2204
|
-
|
|
2205
|
-
EXAMPLES
|
|
2206
|
-
Check the status of the most recent deployment
|
|
2207
|
-
|
|
2208
|
-
$ sf force mdapi deploy report
|
|
2209
|
-
|
|
2210
|
-
Check the status of a deploy with job ID 1234 and wait for 10 minutes for the result:
|
|
2211
|
-
|
|
2212
|
-
$ sf force mdapi deploy report --jobid 1234 --wait 10
|
|
2213
|
-
|
|
2214
|
-
FLAG DESCRIPTIONS
|
|
2215
|
-
-i, --jobid=<value>
|
|
2216
|
-
|
|
2217
|
-
Job ID of the deployment to check; required if you’ve never deployed using Salesforce CLI; defaults to your most
|
|
2218
|
-
recent CLI deployment.
|
|
2219
|
-
|
|
2220
|
-
The job ID (id field value for AsyncResult) of the deployment you want to check. The job ID is required if you
|
|
2221
|
-
haven’t previously deployed using Salesforce CLI. If you deploy using Salesforce CLI and don’t specify a job ID, we
|
|
2222
|
-
use the ID of the most recent metadata deployment.
|
|
2223
|
-
```
|
|
2224
|
-
|
|
2225
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/deploy/report.ts)_
|
|
2226
|
-
|
|
2227
|
-
## `sf force mdapi retrieve`
|
|
2228
|
-
|
|
2229
|
-
Retrieve metadata from an org using Metadata API.
|
|
2230
|
-
|
|
2231
|
-
```
|
|
2232
|
-
USAGE
|
|
2233
|
-
$ sf force mdapi retrieve -o <value> -r <value> [--json] [-k <value> | -d <value> | -p <value>] [-s] [-n <value>] [-z]
|
|
2234
|
-
[-w <value>] [-a <value>] [--verbose]
|
|
2235
|
-
|
|
2236
|
-
FLAGS
|
|
2237
|
-
-a, --apiversion=<value> Target API version for the retrieve.
|
|
2238
|
-
-d, --sourcedir=<value> Source directory to use instead of the default package directory specified in
|
|
2239
|
-
sfdx-project.json.
|
|
2240
|
-
-k, --unpackaged=<value> Complete path for the manifest file that specifies the components to retrieve.
|
|
2241
|
-
-n, --zipfilename=<value> File name to use for the retrieved zip file.
|
|
2242
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2243
|
-
configuration variable is already set.
|
|
2244
|
-
-p, --packagenames=<value>... Comma-separated list of packages to retrieve.
|
|
2245
|
-
-r, --retrievetargetdir=<value> (required) Root of the directory structure where the retrieved .zip or metadata files
|
|
2246
|
-
are retrieved.
|
|
2247
|
-
-s, --singlepackage Specify that the zip file points to a directory structure for a single package.
|
|
2248
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete.
|
|
2249
|
-
-z, --unzip Extract all files from the retrieved zip file.
|
|
2250
|
-
--verbose Display verbose output of retrieve result.
|
|
2251
|
-
|
|
2252
|
-
GLOBAL FLAGS
|
|
2253
|
-
--json Format output as json.
|
|
2254
|
-
|
|
2255
|
-
DESCRIPTION
|
|
2256
|
-
Retrieve metadata from an org using Metadata API.
|
|
2257
|
-
|
|
2258
|
-
This command uses Metadata API to retrieve a .zip of XML files that represent metadata from the targeted org. You can
|
|
2259
|
-
retrieve and deploy up to 10,000 files or 400 MB (39 MB compressed) at one time.
|
|
2260
|
-
|
|
2261
|
-
EXAMPLES
|
|
2262
|
-
Retrieve metadata in the default project directory into the target directory:
|
|
2263
|
-
|
|
2264
|
-
$ sf force mdapi retrieve --retrievetargetdir path/to/retrieve/dir
|
|
2265
|
-
|
|
2266
|
-
Retrieve metadata defined in the specified manifest into the target directory:
|
|
2267
|
-
|
|
2268
|
-
$ sf force mdapi retrieve --retrievetargetdir path/to/retrieve/dir --unpackaged package.xml
|
|
2269
|
-
|
|
2270
|
-
Retrieve metadata defined by the specified directory, name the retrieved zipfile and extract all contents
|
|
2271
|
-
|
|
2272
|
-
$ sf force mdapi retrieve --sourcedir path/to/apexClasses --retrievetargetdir path/to/retrieve/dir --unzip \
|
|
2273
|
-
--zipfilename apexClasses.zip
|
|
2274
|
-
|
|
2275
|
-
Enqueue a retrieve request but do not wait for the metadata to be retrieved:
|
|
2276
|
-
|
|
2277
|
-
$ sf force mdapi retrieve --retrievetargetdir path/to/retrieve/dir --wait 0
|
|
2278
|
-
|
|
2279
|
-
FLAG DESCRIPTIONS
|
|
2280
|
-
-a, --apiversion=<value> Target API version for the retrieve.
|
|
2281
|
-
|
|
2282
|
-
Use to override the default, which is the latest version supported by your CLI plug-in, with the version in your
|
|
2283
|
-
package.xml file.
|
|
2284
|
-
|
|
2285
|
-
-s, --singlepackage Specify that the zip file points to a directory structure for a single package.
|
|
2286
|
-
|
|
2287
|
-
By default, the CLI assumes the directory is structured for a set of packages.
|
|
2288
|
-
```
|
|
2289
|
-
|
|
2290
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/retrieve.ts)_
|
|
2291
|
-
|
|
2292
|
-
## `sf force mdapi retrieve report`
|
|
2293
|
-
|
|
2294
|
-
Check the status of a metadata retrieval.
|
|
2295
|
-
|
|
2296
|
-
```
|
|
2297
|
-
USAGE
|
|
2298
|
-
$ sf force mdapi retrieve report -o <value> [--json] [--api-version <value>] [-r <value>] [-i <value>] [-n <value>] [-z] [-w
|
|
2299
|
-
<value>] [--verbose]
|
|
2300
|
-
|
|
2301
|
-
FLAGS
|
|
2302
|
-
-i, --jobid=<value> Job ID of the retrieve you want to check; defaults to your most recent CLI retrieval.
|
|
2303
|
-
-n, --zipfilename=<value> File name to use for the retrieved zip file.
|
|
2304
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2305
|
-
configuration variable is already set.
|
|
2306
|
-
-r, --retrievetargetdir=<value> Root of the directory structure where the retrieved .zip or metadata files are
|
|
2307
|
-
retrieved.
|
|
2308
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete.
|
|
2309
|
-
-z, --unzip Extract all files from the retrieved zip file.
|
|
2310
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2311
|
-
--verbose Display verbose output of retrieve result.
|
|
2312
|
-
|
|
2313
|
-
GLOBAL FLAGS
|
|
2314
|
-
--json Format output as json.
|
|
2315
|
-
|
|
2316
|
-
DESCRIPTION
|
|
2317
|
-
Check the status of a metadata retrieval.
|
|
2318
|
-
|
|
2319
|
-
Specify the job ID and a target directory for the retrieve you want to check. You can also specify a wait time
|
|
2320
|
-
(minutes) to check for updates to the retrieve status. If the retrieve was successful, the resulting zip file will be
|
|
2321
|
-
saved to the location passed in with the retrieve target parameter.
|
|
2322
|
-
|
|
2323
|
-
EXAMPLES
|
|
2324
|
-
Poll until the metadata is retrieved (or timeout is reached) using data from the last force:mdapi:retrieve command:
|
|
2325
|
-
|
|
2326
|
-
$ sf force mdapi retrieve report
|
|
2327
|
-
|
|
2328
|
-
Report the current status of the last retrieve command. If the retrieve is complete the zip file of metadata is
|
|
2329
|
-
written to the target directoy:
|
|
2330
|
-
|
|
2331
|
-
$ sf force mdapi retrieve report --retrievetargetdir path/to/retrieve/dir --wait 0
|
|
2332
|
-
|
|
2333
|
-
Poll until the metadata is retrieved (or timeout is reached) using the provided RetrieveID, naming the zip file and
|
|
2334
|
-
extracting all contents:
|
|
2335
|
-
|
|
2336
|
-
$ sf force mdapi retrieve report -i retrieveId --retrievetargetdir path/to/retrieve/dir --unzip --zipfilename \
|
|
2337
|
-
apexClasses.zip
|
|
2338
|
-
|
|
2339
|
-
FLAG DESCRIPTIONS
|
|
2340
|
-
-i, --jobid=<value> Job ID of the retrieve you want to check; defaults to your most recent CLI retrieval.
|
|
2341
|
-
|
|
2342
|
-
You must specify a --retrievetargetdir. Use with --wait to resume waiting.
|
|
2343
|
-
```
|
|
2344
|
-
|
|
2345
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/retrieve/report.ts)_
|
|
2346
|
-
|
|
2347
|
-
## `sf force org clone`
|
|
2348
|
-
|
|
2349
|
-
Clone a sandbox org.
|
|
2350
|
-
|
|
2351
|
-
```
|
|
2352
|
-
USAGE
|
|
2353
|
-
$ sf force org clone -o <value> -t sandbox [--json] [--api-version <value>] [-f <value>] [-s] [-a <value>] [-w
|
|
2354
|
-
<value>]
|
|
2355
|
-
|
|
2356
|
-
FLAGS
|
|
2357
|
-
-a, --setalias=<value> Alias for the cloned org.
|
|
2358
|
-
-f, --definitionfile=<value> Path to the sandbox definition file.
|
|
2359
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2360
|
-
configuration variable is already set.
|
|
2361
|
-
-s, --setdefaultusername Set the cloned org as your default.
|
|
2362
|
-
-t, --type=<option> (required) Type of org to create.
|
|
2363
|
-
<options: sandbox>
|
|
2364
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait while polling for status.
|
|
2365
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2366
|
-
|
|
2367
|
-
GLOBAL FLAGS
|
|
2368
|
-
--json Format output as json.
|
|
2369
|
-
|
|
2370
|
-
DESCRIPTION
|
|
2371
|
-
Clone a sandbox org.
|
|
2372
|
-
|
|
2373
|
-
There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the
|
|
2374
|
-
command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either
|
|
2375
|
-
case, you must specify both the "SandboxName" and "SourceSandboxName" options to set the names of the new sandbox and
|
|
2376
|
-
the one being cloned, respectively.
|
|
2377
|
-
|
|
2378
|
-
Set the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is
|
|
2379
|
-
required and must be set to "sandbox".
|
|
2380
|
-
|
|
2381
|
-
EXAMPLES
|
|
2382
|
-
$ sf force org clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
|
|
2383
|
-
|
|
2384
|
-
$ sf force org clone -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
|
|
2385
|
-
|
|
2386
|
-
FLAG DESCRIPTIONS
|
|
2387
|
-
-w, --wait=<value> Number of minutes to wait while polling for status.
|
|
2388
|
-
|
|
2389
|
-
Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server
|
|
2390
|
-
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
|
|
2391
|
-
```
|
|
2392
|
-
|
|
2393
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/clone.ts)_
|
|
2394
|
-
|
|
2395
|
-
## `sf force org create`
|
|
2396
|
-
|
|
2397
|
-
Create a scratch org or sandbox.
|
|
2398
|
-
|
|
2399
|
-
```
|
|
2400
|
-
USAGE
|
|
2401
|
-
$ sf force org create [--json] [-o <value>] [-v <value>] [--api-version <value>] [-t scratch|sandbox] [-f <value>]
|
|
2402
|
-
[-n] [-c] [-i <value>] [-s] [-a <value>] [-w <value>] [-d <value>]
|
|
2403
|
-
|
|
2404
|
-
FLAGS
|
|
2405
|
-
-a, --setalias=<value> Alias for the created org.
|
|
2406
|
-
-c, --noancestors Do not include second-generation package ancestors in the scratch org.
|
|
2407
|
-
-d, --durationdays=<value> [default: 7] Duration of the scratch org (in days) (default:7, min:1, max:30).
|
|
2408
|
-
-f, --definitionfile=<value> Path to an org definition file.
|
|
2409
|
-
-i, --clientid=<value> Connected app consumer key; not supported for sandbox org creation.
|
|
2410
|
-
-n, --nonamespace Create the scratch org with no namespace.
|
|
2411
|
-
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
|
|
2412
|
-
-s, --setdefaultusername Set the created org as the default username.
|
|
2413
|
-
-t, --type=<option> [default: scratch] Type of org to create.
|
|
2414
|
-
<options: scratch|sandbox>
|
|
2415
|
-
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration
|
|
2416
|
-
variable is already set.
|
|
2417
|
-
-w, --wait=<value> [default: [object Object]] Streaming client socket timeout (in minutes).
|
|
2418
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2419
|
-
|
|
2420
|
-
GLOBAL FLAGS
|
|
2421
|
-
--json Format output as json.
|
|
2422
|
-
|
|
2423
|
-
DESCRIPTION
|
|
2424
|
-
Create a scratch org or sandbox.
|
|
2425
|
-
|
|
2426
|
-
Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you
|
|
2427
|
-
specify on the command line. Values specified on the command line override values in the configuration file. Specify a
|
|
2428
|
-
configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs,
|
|
2429
|
-
—targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a
|
|
2430
|
-
production org with sandbox licenses. The —type (-t) is required if creating a sandbox.
|
|
2431
|
-
|
|
2432
|
-
EXAMPLES
|
|
2433
|
-
$ sf force org create -f config/enterprise-scratch-def.json -a MyScratchOrg
|
|
2434
|
-
|
|
2435
|
-
$ sf force org create edition=Developer -a MyScratchOrg -s -v devHub
|
|
2436
|
-
|
|
2437
|
-
$ sf force org create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org
|
|
2438
|
-
|
|
2439
|
-
$ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
|
|
2440
|
-
```
|
|
2441
|
-
|
|
2442
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/create.ts)_
|
|
2443
|
-
|
|
2444
|
-
## `sf force org delete`
|
|
2445
|
-
|
|
2446
|
-
Delete a scratch or sandbox org.
|
|
2447
|
-
|
|
2448
|
-
```
|
|
2449
|
-
USAGE
|
|
2450
|
-
$ sf force org delete -o <value> [--json] [--api-version <value>] [-p]
|
|
2451
|
-
|
|
2452
|
-
FLAGS
|
|
2453
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2454
|
-
-p, --no-prompt No prompt to confirm deletion.
|
|
2455
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2456
|
-
|
|
2457
|
-
GLOBAL FLAGS
|
|
2458
|
-
--json Format output as json.
|
|
2459
|
-
|
|
2460
|
-
DESCRIPTION
|
|
2461
|
-
Delete a scratch or sandbox org.
|
|
2462
|
-
|
|
2463
|
-
Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for
|
|
2464
|
-
sandboxes) and then deletes all local references to the org from your computer.
|
|
2465
|
-
|
|
2466
|
-
To mark the org for deletion without being prompted to confirm, specify --noprompt.
|
|
2467
|
-
|
|
2468
|
-
EXAMPLES
|
|
2469
|
-
$ sf force org delete -u me@my.org
|
|
2470
|
-
|
|
2471
|
-
$ sf force org delete -u MyOrgAlias -p
|
|
2472
|
-
```
|
|
2473
|
-
|
|
2474
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/delete.ts)_
|
|
2475
|
-
|
|
2476
|
-
## `sf force org status`
|
|
2477
|
-
|
|
2478
|
-
Check the status of a sandbox, and if complete, authenticate to it.
|
|
2479
|
-
|
|
2480
|
-
```
|
|
2481
|
-
USAGE
|
|
2482
|
-
$ sf force org status -o <value> -n <value> [--json] [--api-version <value>] [-s] [-a <value>] [-w <value>]
|
|
2483
|
-
|
|
2484
|
-
FLAGS
|
|
2485
|
-
-a, --setalias=<value> Alias for the created or cloned org.
|
|
2486
|
-
-n, --sandboxname=<value> (required) Name of the sandbox org to check status for.
|
|
2487
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2488
|
-
configuration variable is already set.
|
|
2489
|
-
-s, --setdefaultusername Set the created or cloned org as your default.
|
|
2490
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait while polling for status.
|
|
2491
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2492
|
-
|
|
2493
|
-
GLOBAL FLAGS
|
|
2494
|
-
--json Format output as json.
|
|
2495
|
-
|
|
2496
|
-
DESCRIPTION
|
|
2497
|
-
Check the status of a sandbox, and if complete, authenticate to it.
|
|
2498
|
-
|
|
2499
|
-
Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to
|
|
2500
|
-
it.
|
|
2501
|
-
|
|
2502
|
-
Use the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or
|
|
2503
|
-
clone to complete before returning control of the terminal to you.
|
|
2504
|
-
|
|
2505
|
-
Set the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.
|
|
2506
|
-
|
|
2507
|
-
EXAMPLES
|
|
2508
|
-
$ sf force org status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg
|
|
2509
|
-
|
|
2510
|
-
$ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
|
|
2511
|
-
```
|
|
2512
|
-
|
|
2513
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/status.ts)_
|
|
2514
|
-
|
|
2515
|
-
## `sf force source deploy`
|
|
2516
|
-
|
|
2517
|
-
Deploy source to an org.
|
|
2518
|
-
|
|
2519
|
-
```
|
|
2520
|
-
USAGE
|
|
2521
|
-
$ sf force source deploy -u <value> [--json] [--api-version <value>] [--soapdeploy] [-w <value>] [-o] [-g]
|
|
2522
|
-
[--purgeondelete -x <value>] [-q <value> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r
|
|
2523
|
-
<value> | -t] [--verbose] [-m <value>] [-p <value>] [--predestructivechanges <value> ] [--postdestructivechanges
|
|
2524
|
-
<value> ] [-f ] [--resultsdir <value>] [--coverageformatters
|
|
2525
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2526
|
-
|
|
2527
|
-
FLAGS
|
|
2528
|
-
-c, --checkonly
|
|
2529
|
-
Validate the deployed metadata and run all Apex tests, but don't save to the org.
|
|
2530
|
-
|
|
2531
|
-
-f, --forceoverwrite
|
|
2532
|
-
Ignore conflict warnings and overwrite changes to the org.
|
|
2533
|
-
|
|
2534
|
-
-g, --ignorewarnings
|
|
2535
|
-
Allow a deployment to complete successfully even if there are warnings.
|
|
2536
|
-
|
|
2537
|
-
-l, --testlevel=<option>
|
|
2538
|
-
Deployment testing level.
|
|
2539
|
-
<options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
|
|
2540
|
-
|
|
2541
|
-
-m, --metadata=<value>...
|
|
2542
|
-
Comma-separated list of metadata component names.
|
|
2543
|
-
|
|
2544
|
-
-o, --ignoreerrors
|
|
2545
|
-
Ignore any errors and don't roll back deployment.
|
|
2546
|
-
|
|
2547
|
-
-p, --sourcepath=<value>...
|
|
2548
|
-
Comma-separated list of source file paths to deploy.
|
|
2549
|
-
|
|
2550
|
-
-q, --validateddeployrequestid=<value>
|
|
2551
|
-
Deploy request ID of the validated deployment to run a Quick Deploy.
|
|
2552
|
-
|
|
2553
|
-
-r, --runtests=<value>...
|
|
2554
|
-
Apex test classes to run if --testlevel RunSpecifiedTests.
|
|
2555
|
-
|
|
2556
|
-
-t, --tracksource
|
|
2557
|
-
If the deploy succeeds, update source tracking information.
|
|
2558
|
-
|
|
2559
|
-
-u, --target-org=<value>
|
|
2560
|
-
(required) Username or alias of the target org.
|
|
2561
|
-
|
|
2562
|
-
-w, --wait=<value>
|
|
2563
|
-
[default: [object Object]] Wait time for command to finish in minutes.
|
|
2564
|
-
|
|
2565
|
-
-x, --manifest=<value>
|
|
2566
|
-
Complete path for the manifest (package.xml) file that specifies the components to deploy.
|
|
2567
|
-
|
|
2568
|
-
--api-version=<value>
|
|
2569
|
-
Override the api version used for api requests made by this command
|
|
2570
|
-
|
|
2571
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
2572
|
-
Format of the code coverage results.
|
|
2573
|
-
|
|
2574
|
-
--junit
|
|
2575
|
-
Output JUnit test results.
|
|
2576
|
-
|
|
2577
|
-
--postdestructivechanges=<value>
|
|
2578
|
-
File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.
|
|
2579
|
-
|
|
2580
|
-
--predestructivechanges=<value>
|
|
2581
|
-
File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.
|
|
2582
|
-
|
|
2583
|
-
--purgeondelete
|
|
2584
|
-
Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion
|
|
2585
|
-
rather than being stored in the Recycle Bin.
|
|
2586
|
-
|
|
2587
|
-
--resultsdir=<value>
|
|
2588
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
2589
|
-
|
|
2590
|
-
--soapdeploy
|
|
2591
|
-
Deploy metadata with SOAP API instead of REST API.
|
|
2592
|
-
|
|
2593
|
-
--verbose
|
|
2594
|
-
Specify verbose output about the deploy result.
|
|
2595
|
-
|
|
2596
|
-
GLOBAL FLAGS
|
|
2597
|
-
--json Format output as json.
|
|
2598
|
-
|
|
2599
|
-
DESCRIPTION
|
|
2600
|
-
Deploy source to an org.
|
|
2601
|
-
|
|
2602
|
-
Use this command to deploy source (metadata that’s in source format) to an org. To take advantage of change tracking
|
|
2603
|
-
with scratch orgs, use "force source push". To deploy metadata that’s in metadata format, use "force mdapi deploy".
|
|
2604
|
-
|
|
2605
|
-
The source you deploy overwrites the corresponding metadata in your org. This command does not attempt to merge your
|
|
2606
|
-
source with the versions in your org.
|
|
2607
|
-
|
|
2608
|
-
To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
|
|
2609
|
-
to use the CLI. To check the status of the job, use "force source deploy report".
|
|
2610
|
-
|
|
2611
|
-
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of
|
|
2612
|
-
double quotes. On Windows, if the list contains commas, also enclose the entire list in one set of double quotes.
|
|
2613
|
-
|
|
2614
|
-
If you use the --manifest, --predestructivechanges, or --postdestructivechanges parameters, run the "force source
|
|
2615
|
-
manifest create" command to easily generate the different types of manifest files.
|
|
2616
|
-
|
|
2617
|
-
EXAMPLES
|
|
2618
|
-
Deploy the source files in a directory:
|
|
2619
|
-
|
|
2620
|
-
$ sf force source deploy --sourcepath path/to/source
|
|
2621
|
-
|
|
2622
|
-
Deploy a specific Apex class and the objects whose source is in a directory:
|
|
2623
|
-
|
|
2624
|
-
$ sf force source deploy --sourcepath "path/to/apex/classes/MyClass.cls,path/to/source/objects"
|
|
2625
|
-
|
|
2626
|
-
Deploy source files in a comma-separated list that contains spaces:
|
|
2627
|
-
|
|
2628
|
-
$ sf force source deploy --sourcepath "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, \
|
|
2629
|
-
path/to/apex/classes"
|
|
2630
|
-
|
|
2631
|
-
Deploy all Apex classes:
|
|
2632
|
-
|
|
2633
|
-
$ sf force source deploy --metadata ApexClass
|
|
2634
|
-
|
|
2635
|
-
Deploy a specific Apex class:
|
|
2636
|
-
|
|
2637
|
-
$ sf force source deploy --metadata ApexClass:MyApexClass
|
|
2638
|
-
|
|
2639
|
-
Deploy a specific Apex class and update source tracking files :
|
|
2640
|
-
|
|
2641
|
-
$ sf force source deploy --metadata ApexClass:MyApexClass --tracksource
|
|
2642
|
-
|
|
2643
|
-
Deploy all custom objects and Apex classes:
|
|
2644
|
-
|
|
2645
|
-
$ sf force source deploy --metadata "CustomObject,ApexClass"
|
|
2646
|
-
|
|
2647
|
-
Deploy all Apex classes and two specific profiles (one of which has a space in its name):
|
|
2648
|
-
|
|
2649
|
-
$ sf force source deploy --metadata "ApexClass, Profile:My Profile, Profile: AnotherProfile"
|
|
2650
|
-
|
|
2651
|
-
Deploy all components listed in a manifest:
|
|
2652
|
-
|
|
2653
|
-
$ sf force source deploy --manifest path/to/package.xml
|
|
2654
|
-
|
|
2655
|
-
Run the tests that aren’t in any managed packages as part of a deployment:
|
|
2656
|
-
|
|
2657
|
-
$ sf force source deploy --metadata ApexClass --testlevel RunLocalTests
|
|
2658
|
-
|
|
2659
|
-
Check whether a deployment would succeed (to prepare for Quick Deploy):
|
|
2660
|
-
|
|
2661
|
-
$ sf force source deploy --metadata ApexClass --testlevel RunAllTestsInOrg -c
|
|
2662
|
-
|
|
2663
|
-
Deploy an already validated deployment (Quick Deploy):
|
|
2664
|
-
|
|
2665
|
-
$ sf force source deploy --validateddeployrequestid 0Af9A00000FTM6pSAH`
|
|
2666
|
-
|
|
2667
|
-
Run a destructive operation before the deploy occurs:
|
|
2668
|
-
|
|
2669
|
-
$ sf force source deploy --manifest package.xml --predestructivechanges destructiveChangesPre.xml
|
|
2670
|
-
|
|
2671
|
-
Run a destructive operation after the deploy occurs:
|
|
2672
|
-
|
|
2673
|
-
$ sf force source deploy --manifest package.xml --postdestructivechanges destructiveChangesPost.xml
|
|
2674
|
-
|
|
2675
|
-
FLAG DESCRIPTIONS
|
|
2676
|
-
-c, --checkonly Validate the deployed metadata and run all Apex tests, but don't save to the org.
|
|
2677
|
-
|
|
2678
|
-
IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained
|
|
2679
|
-
certain terms to avoid any effect on customer implementations.
|
|
2680
|
-
|
|
2681
|
-
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the
|
|
2682
|
-
--checkonly parameter to test a deployment (validation). This kind of change isn’t supported for test deployments to
|
|
2683
|
-
avoid the risk of data loss or corruption. If a change that isn’t supported for test deployments is included in a
|
|
2684
|
-
deployment package, the test deployment fails and issues an error.
|
|
2685
|
-
|
|
2686
|
-
If your deployment package changes a field type from Master-Detail to Lookup or vice versa, you can still validate
|
|
2687
|
-
the changes prior to deploying to Production by performing a full deployment to another test Sandbox. A full
|
|
2688
|
-
deployment includes a validation of the changes as part of the deployment process.
|
|
2689
|
-
|
|
2690
|
-
Note: A Metadata API deployment that includes Master-Detail relationships deletes all detail records in the Recycle
|
|
2691
|
-
Bin in the following cases.
|
|
2692
|
-
|
|
2693
|
-
1. For a deployment with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before
|
|
2694
|
-
proceeding to deploy the Master-Detail field, or the deployment fails. During the deployment, detail records are
|
|
2695
|
-
permanently deleted from the Recycle Bin and cannot be recovered.
|
|
2696
|
-
|
|
2697
|
-
2. For a deployment that converts a Lookup field relationship to a Master-Detail relationship, detail records must
|
|
2698
|
-
reference a master record or be soft-deleted (sent to the Recycle Bin) for the deployment to succeed. However, a
|
|
2699
|
-
successful deployment permanently deletes any detail records in the Recycle Bin.
|
|
2700
|
-
|
|
2701
|
-
-g, --ignorewarnings Allow a deployment to complete successfully even if there are warnings.
|
|
2702
|
-
|
|
2703
|
-
If a warning occurs and ignoreWarnings is set to true, the success field in DeployMessage is true. When
|
|
2704
|
-
ignoreWarnings is set to false, success is set to false, and the warning is treated like an error.
|
|
2705
|
-
|
|
2706
|
-
-l, --testlevel=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment testing level.
|
|
2707
|
-
|
|
2708
|
-
Valid values are:
|
|
2709
|
-
|
|
2710
|
-
- NoTestRun—No tests are run. This test level applies only to deployments to development environments, such as
|
|
2711
|
-
sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.
|
|
2712
|
-
|
|
2713
|
-
- RunSpecifiedTests—Runs only the tests that you specify in the --runtests option. Code coverage requirements differ
|
|
2714
|
-
from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75%
|
|
2715
|
-
code coverage for each class and trigger in the deployment package. This coverage is computed for each class and
|
|
2716
|
-
trigger individually and is different than the overall coverage percentage.
|
|
2717
|
-
|
|
2718
|
-
- RunLocalTests—All tests in your org are run, except the ones that originate from installed managed and unlocked
|
|
2719
|
-
packages. This test level is the default for production deployments that include Apex classes or triggers.
|
|
2720
|
-
|
|
2721
|
-
- RunAllTestsInOrg—All tests in your org are run, including tests of managed packages.
|
|
2722
|
-
|
|
2723
|
-
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more
|
|
2724
|
-
information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.
|
|
2725
|
-
|
|
2726
|
-
-m, --metadata=<value>... Comma-separated list of metadata component names.
|
|
2727
|
-
|
|
2728
|
-
If you specify this parameter, don’t specify --manifest or --sourcepath.
|
|
2729
|
-
|
|
2730
|
-
-o, --ignoreerrors Ignore any errors and don't roll back deployment.
|
|
2731
|
-
|
|
2732
|
-
Keep this parameter set to false when deploying to a production org. If set to true, components without errors are
|
|
2733
|
-
deployed, and components with errors are skipped.
|
|
2734
|
-
|
|
2735
|
-
-p, --sourcepath=<value>... Comma-separated list of source file paths to deploy.
|
|
2736
|
-
|
|
2737
|
-
The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
|
|
2738
|
-
(in which case the operation is applied to all metadata types in the directory and its sub-directories).
|
|
2739
|
-
|
|
2740
|
-
If you specify this parameter, don’t specify --manifest or --metadata.
|
|
2741
|
-
|
|
2742
|
-
-q, --validateddeployrequestid=<value> Deploy request ID of the validated deployment to run a Quick Deploy.
|
|
2743
|
-
|
|
2744
|
-
Deploying a validation helps you shorten your deployment time because tests aren’t rerun. If you have a recent
|
|
2745
|
-
successful validation, you can deploy the validated components without running tests. A validation doesn’t save any
|
|
2746
|
-
components in the org. You use a validation only to check the success or failure messages that you would receive
|
|
2747
|
-
with an actual deployment. To validate your components, add the -c | --checkonly flag when you run "force mdapi
|
|
2748
|
-
deploy". This flag sets the checkOnly="true" parameter for your deployment. Before deploying a recent validation,
|
|
2749
|
-
ensure that the following requirements are met:
|
|
2750
|
-
|
|
2751
|
-
1. The components have been validated successfully for the target environment within the last 10 days.
|
|
2752
|
-
|
|
2753
|
-
2. As part of the validation, Apex tests in the target org have passed.
|
|
2754
|
-
|
|
2755
|
-
3. Code coverage requirements are met.
|
|
2756
|
-
|
|
2757
|
-
* If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have
|
|
2758
|
-
some coverage.
|
|
2759
|
-
|
|
2760
|
-
* If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is
|
|
2761
|
-
covered by at least 75% individually.
|
|
2762
|
-
|
|
2763
|
-
-t, --tracksource If the deploy succeeds, update source tracking information.
|
|
2764
|
-
|
|
2765
|
-
Doesn't delete locally deleted files from org unless you also specify --predestructivechanges or
|
|
2766
|
-
--postdestructivechanges.
|
|
2767
|
-
|
|
2768
|
-
-w, --wait=<value> Wait time for command to finish in minutes.
|
|
2769
|
-
|
|
2770
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2771
|
-
|
|
2772
|
-
-x, --manifest=<value> Complete path for the manifest (package.xml) file that specifies the components to deploy.
|
|
2773
|
-
|
|
2774
|
-
All child components are included.
|
|
2775
|
-
|
|
2776
|
-
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
2777
|
-
```
|
|
2778
|
-
|
|
2779
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/deploy.ts)_
|
|
2780
|
-
|
|
2781
|
-
## `sf force source deploy cancel`
|
|
2782
|
-
|
|
2783
|
-
Cancel a source deployment.
|
|
2784
|
-
|
|
2785
|
-
```
|
|
2786
|
-
USAGE
|
|
2787
|
-
$ sf force source deploy cancel -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>]
|
|
2788
|
-
|
|
2789
|
-
FLAGS
|
|
2790
|
-
-i, --jobid=<value> Job ID of the deployment you want to cancel; defaults to your most recent CLI deployment if
|
|
2791
|
-
not specified.
|
|
2792
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2793
|
-
configuration variable is already set.
|
|
2794
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2795
|
-
display results.
|
|
2796
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2797
|
-
|
|
2798
|
-
GLOBAL FLAGS
|
|
2799
|
-
--json Format output as json.
|
|
2800
|
-
|
|
2801
|
-
DESCRIPTION
|
|
2802
|
-
Cancel a source deployment.
|
|
2803
|
-
|
|
2804
|
-
Use this command to cancel a specified asynchronous source deployment. You can also specify a wait time (in minutes)
|
|
2805
|
-
to check for updates to the canceled deploy status.
|
|
2806
|
-
|
|
2807
|
-
To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
|
|
2808
|
-
to use the CLI. To check the status of the job, use "force source deploy report".
|
|
2809
|
-
|
|
2810
|
-
EXAMPLES
|
|
2811
|
-
Cancel a deployment and wait two minutes:
|
|
2812
|
-
|
|
2813
|
-
$ sf force source deploy cancel --wait 2
|
|
2814
|
-
|
|
2815
|
-
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID:
|
|
2816
|
-
|
|
2817
|
-
$ sf force source deploy cancel --jobid <jobid>
|
|
2818
|
-
|
|
2819
|
-
FLAG DESCRIPTIONS
|
|
2820
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results.
|
|
2821
|
-
|
|
2822
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2823
|
-
```
|
|
2824
|
-
|
|
2825
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/deploy/cancel.ts)_
|
|
2826
|
-
|
|
2827
|
-
## `sf force source deploy report`
|
|
2828
|
-
|
|
2829
|
-
Check the status of a metadata deployment.
|
|
2830
|
-
|
|
2831
|
-
```
|
|
2832
|
-
USAGE
|
|
2833
|
-
$ sf force source deploy report -o <value> [--json] [--api-version <value>] [-w <value>] [-i <value>] [--verbose]
|
|
2834
|
-
[--resultsdir <value>] [--coverageformatters
|
|
2835
|
-
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit]
|
|
2836
|
-
|
|
2837
|
-
FLAGS
|
|
2838
|
-
-i, --jobid=<value>
|
|
2839
|
-
Job ID of the deployment you want to check; defaults to your most recent CLI deployment.
|
|
2840
|
-
|
|
2841
|
-
-o, --target-org=<value>
|
|
2842
|
-
(required) Username or alias of the target org. Not required if the `target-org` configuration variable is already
|
|
2843
|
-
set.
|
|
2844
|
-
|
|
2845
|
-
-w, --wait=<value>
|
|
2846
|
-
[default: [object Object]] Number of minutes to wait for the command to complete and display results to the terminal
|
|
2847
|
-
window.
|
|
2848
|
-
|
|
2849
|
-
--api-version=<value>
|
|
2850
|
-
Override the api version used for api requests made by this command
|
|
2851
|
-
|
|
2852
|
-
--coverageformatters=clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary...
|
|
2853
|
-
Format of the code coverage results.
|
|
2854
|
-
|
|
2855
|
-
--junit
|
|
2856
|
-
Output JUnit test results.
|
|
2857
|
-
|
|
2858
|
-
--resultsdir=<value>
|
|
2859
|
-
Output directory for code coverage and JUnit results; defaults to the deploy ID.
|
|
2860
|
-
|
|
2861
|
-
--verbose
|
|
2862
|
-
Verbose output of deploy result.
|
|
2863
|
-
|
|
2864
|
-
GLOBAL FLAGS
|
|
2865
|
-
--json Format output as json.
|
|
2866
|
-
|
|
2867
|
-
DESCRIPTION
|
|
2868
|
-
Check the status of a metadata deployment.
|
|
2869
|
-
|
|
2870
|
-
Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates
|
|
2871
|
-
to the deploy status.
|
|
2872
|
-
|
|
2873
|
-
EXAMPLES
|
|
2874
|
-
Check the status of the most recent deployment on your default org:
|
|
2875
|
-
|
|
2876
|
-
$ sf force source deploy report
|
|
2877
|
-
|
|
2878
|
-
Check the status using the job ID; output JUnit test results and format code coverage results in the specified
|
|
2879
|
-
format:
|
|
2880
|
-
|
|
2881
|
-
$ sf force source deploy report --jobid <id> --junit --coverageformatters cobertura
|
|
2882
|
-
|
|
2883
|
-
FLAG DESCRIPTIONS
|
|
2884
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
2885
|
-
|
|
2886
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2887
|
-
```
|
|
2888
|
-
|
|
2889
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/deploy/report.ts)_
|
|
2890
|
-
|
|
2891
|
-
## `sf force source pull`
|
|
2892
|
-
|
|
2893
|
-
Pull changed source from the org to your project to keep them in sync.
|
|
2894
|
-
|
|
2895
|
-
```
|
|
2896
|
-
USAGE
|
|
2897
|
-
$ sf force source pull -o <value> [--json] [--verbose] [--api-version <value>] [-f] [-w <value>]
|
|
2898
|
-
|
|
2899
|
-
FLAGS
|
|
2900
|
-
-f, --forceoverwrite Ignore conflict warnings; changes in the org overwrite changes in the project.
|
|
2901
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2902
|
-
configuration variable is already set.
|
|
2903
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2904
|
-
display results to the terminal window.
|
|
2905
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2906
|
-
--verbose Display additional details about the command results.
|
|
2907
|
-
|
|
2908
|
-
GLOBAL FLAGS
|
|
2909
|
-
--json Format output as json.
|
|
2910
|
-
|
|
2911
|
-
DESCRIPTION
|
|
2912
|
-
Pull changed source from the org to your project to keep them in sync.
|
|
2913
|
-
|
|
2914
|
-
If the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the
|
|
2915
|
-
conflict, rerun the command with the --forceoverwrite parameter.
|
|
2916
|
-
|
|
2917
|
-
EXAMPLES
|
|
2918
|
-
Pull source from your default org:
|
|
2919
|
-
|
|
2920
|
-
$ sf force source pull
|
|
2921
|
-
|
|
2922
|
-
Pull source from the org with alias "myscratch"; ignore any conflicts and overwrite the local project files with org
|
|
2923
|
-
changes; wait for only 5 minutes:
|
|
2924
|
-
|
|
2925
|
-
$ sf force source pull --target-org myscratch --wait 5 --forceoverwrite
|
|
2926
|
-
|
|
2927
|
-
FLAG DESCRIPTIONS
|
|
2928
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
2929
|
-
|
|
2930
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2931
|
-
```
|
|
2932
|
-
|
|
2933
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/pull.ts)_
|
|
2934
|
-
|
|
2935
|
-
## `sf force source push`
|
|
2936
|
-
|
|
2937
|
-
Push changed source from your project to an org to keep them in sync.
|
|
2938
|
-
|
|
2939
|
-
```
|
|
2940
|
-
USAGE
|
|
2941
|
-
$ sf force source push -o <value> [--json] [--api-version <value>] [-f] [-w <value>] [-g] [--quiet]
|
|
2942
|
-
|
|
2943
|
-
FLAGS
|
|
2944
|
-
-f, --forceoverwrite Ignore conflict warnings and push source anyway; changes in the project overwrite changes
|
|
2945
|
-
in the org.
|
|
2946
|
-
-g, --ignorewarnings Deploy changes even if warnings are generated.
|
|
2947
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2948
|
-
configuration variable is already set.
|
|
2949
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
2950
|
-
display results to the terminal window.
|
|
2951
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2952
|
-
--quiet Minimize JSON and sdtout output on success.
|
|
2953
|
-
|
|
2954
|
-
GLOBAL FLAGS
|
|
2955
|
-
--json Format output as json.
|
|
2956
|
-
|
|
2957
|
-
DESCRIPTION
|
|
2958
|
-
Push changed source from your project to an org to keep them in sync.
|
|
2959
|
-
|
|
2960
|
-
If the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the
|
|
2961
|
-
conflict, rerun the command with the --forceoverwrite parameter.
|
|
2962
|
-
|
|
2963
|
-
EXAMPLES
|
|
2964
|
-
Push source to your default org:
|
|
2965
|
-
|
|
2966
|
-
$ sf force source push
|
|
2967
|
-
|
|
2968
|
-
Push source to the org with alias "myscratch"; ignore any conflicts and overwrite with org with the local project
|
|
2969
|
-
changes; wait for only 5 minutes:
|
|
2970
|
-
|
|
2971
|
-
$ sf force source push --target-org myscratch --wait 5 --forceoverwrite
|
|
2972
|
-
|
|
2973
|
-
FLAG DESCRIPTIONS
|
|
2974
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
2975
|
-
|
|
2976
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
2977
|
-
```
|
|
2978
|
-
|
|
2979
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/push.ts)_
|
|
2980
|
-
|
|
2981
|
-
## `sf force source retrieve`
|
|
2982
|
-
|
|
2983
|
-
Retrieve source from an org.
|
|
2984
|
-
|
|
2985
|
-
```
|
|
2986
|
-
USAGE
|
|
2987
|
-
$ sf force source retrieve -o <value> [--json] [-a <value>] [-r <value> | -n <value> | -p <value>] [-w <value>] [-x
|
|
2988
|
-
<value> | -m <value> | ] [-f -t] [--verbose]
|
|
2989
|
-
|
|
2990
|
-
FLAGS
|
|
2991
|
-
-a, --api-version=<value> Override the api version used for api requests made by this command
|
|
2992
|
-
-f, --forceoverwrite Ignore conflict warnings and overwrite changes to the project.
|
|
2993
|
-
-m, --metadata=<value>... Comma-separated list of names of metadata components to retrieve from the org.
|
|
2994
|
-
-n, --packagenames=<value>... Comma-separated list of packages to retrieve.
|
|
2995
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2996
|
-
configuration variable is already set.
|
|
2997
|
-
-p, --sourcepath=<value>... Comma-separated list of file paths for source to retrieve from the org.
|
|
2998
|
-
-r, --retrievetargetdir=<value> Root of the directory structure into which the source files are retrieved.
|
|
2999
|
-
-t, --tracksource If the retrieve succeeds, update source tracking information; doesn't delete local
|
|
3000
|
-
files that were deleted in the org.
|
|
3001
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for the command to complete and
|
|
3002
|
-
display results to the terminal window.
|
|
3003
|
-
-x, --manifest=<value> Complete path for the manifest (package.xml) file that specifies the components to
|
|
3004
|
-
retrieve.
|
|
3005
|
-
--verbose Verbose output of retrieve result.
|
|
3006
|
-
|
|
3007
|
-
GLOBAL FLAGS
|
|
3008
|
-
--json Format output as json.
|
|
3009
|
-
|
|
3010
|
-
DESCRIPTION
|
|
3011
|
-
Retrieve source from an org.
|
|
3012
|
-
|
|
3013
|
-
Use this command to retrieve source (metadata that’s in source format) from an org. To take advantage of change
|
|
3014
|
-
tracking with scratch orgs, use "force source pull". To retrieve metadata that’s in metadata format, use "force mdapi
|
|
3015
|
-
retrieve".
|
|
3016
|
-
|
|
3017
|
-
The source you retrieve overwrites the corresponding source files in your local project. This command does not attempt
|
|
3018
|
-
to merge the source from your org with your local source files.
|
|
3019
|
-
|
|
3020
|
-
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of
|
|
3021
|
-
double quotes. On Windows, if the list contains commas, also enclose it in one set of double quotes.
|
|
3022
|
-
|
|
3023
|
-
EXAMPLES
|
|
3024
|
-
Retrieve the source files in a directory from your default org:
|
|
3025
|
-
|
|
3026
|
-
$ sf force source retrieve --sourcepath path/to/source
|
|
3027
|
-
|
|
3028
|
-
Retrieve a specific Apex class and the objects whose source is in a directory from an org with alias "myscratch":
|
|
3029
|
-
|
|
3030
|
-
$ sf force source retrieve --sourcepath "path/to/apex/classes/MyClass.cls,path/to/source/objects" --target-org \
|
|
3031
|
-
myscratch
|
|
3032
|
-
|
|
3033
|
-
Retrieve source files in a comma-separated list that contains spaces:
|
|
3034
|
-
|
|
3035
|
-
$ sf force source retrieve --sourcepath "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, \
|
|
3036
|
-
path/to/apex/classes"
|
|
3037
|
-
|
|
3038
|
-
Retrieve all Apex classes:
|
|
3039
|
-
|
|
3040
|
-
$ sf force source retrieve --metadata ApexClass
|
|
3041
|
-
|
|
3042
|
-
Retrieve a specific Apex class:
|
|
3043
|
-
|
|
3044
|
-
$ sf force source retrieve --metadata ApexClass:MyApexClass
|
|
3045
|
-
|
|
3046
|
-
Retrieve a specific Apex class and update source tracking files:
|
|
3047
|
-
|
|
3048
|
-
$ sf force source retrieve --metadata ApexClass:MyApexClass --tracksource
|
|
3049
|
-
|
|
3050
|
-
Retrieve all custom objects and Apex classes:
|
|
3051
|
-
|
|
3052
|
-
$ sf force source retrieve --metadata "CustomObject,ApexClass"
|
|
3053
|
-
|
|
3054
|
-
Retrieve all Apex classes and two specific profiles (one of which has a space in its name):
|
|
3055
|
-
|
|
3056
|
-
$ sf force source retrieve --metadata "ApexClass, Profile:My Profile, Profile: AnotherProfile"
|
|
3057
|
-
|
|
3058
|
-
Retrieve all metadata components listed in a manifest:
|
|
3059
|
-
|
|
3060
|
-
$ sf force source retrieve --manifest path/to/package.xml
|
|
3061
|
-
|
|
3062
|
-
Retrieve metadata from a package or multiple packages:
|
|
3063
|
-
|
|
3064
|
-
$ sf force source retrieve --packagenames MyPackageName
|
|
3065
|
-
$ sf force source retrieve --packagenames "Package1, PackageName With Spaces, Package3"
|
|
3066
|
-
|
|
3067
|
-
Retrieve all metadata from a package and specific components that aren’t in the package, specify both -n |
|
|
3068
|
-
--packagenames and one other scoping parameter:
|
|
3069
|
-
|
|
3070
|
-
$ sf force source retrieve --packagenames MyPackageName --sourcepath path/to/apex/classes
|
|
3071
|
-
$ sf force source retrieve --packagenames MyPackageName --metadata ApexClass:MyApexClass
|
|
3072
|
-
$ sf force source retrieve --packagenames MyPackageName --manifest path/to/package.xml
|
|
3073
|
-
|
|
3074
|
-
Retrieve source files to a given directory instead of the default package directory specified in sfdx-project.json:
|
|
3075
|
-
|
|
3076
|
-
$ sf force source retrieve --metadata "StandardValueSet:TaskStatus" --retrievetargetdir path/to/unpackaged
|
|
3077
|
-
|
|
3078
|
-
FLAG DESCRIPTIONS
|
|
3079
|
-
-m, --metadata=<value>... Comma-separated list of names of metadata components to retrieve from the org.
|
|
3080
|
-
|
|
3081
|
-
If you specify this parameter, don’t specify --manifest or --sourcepath.
|
|
3082
|
-
|
|
3083
|
-
-p, --sourcepath=<value>... Comma-separated list of file paths for source to retrieve from the org.
|
|
3084
|
-
|
|
3085
|
-
The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
|
|
3086
|
-
(in which case the operation is applied to all source files in the directory and its sub-directories).
|
|
3087
|
-
|
|
3088
|
-
If you specify this parameter, don’t specify --manifest or --metadata.
|
|
3089
|
-
|
|
3090
|
-
-r, --retrievetargetdir=<value> Root of the directory structure into which the source files are retrieved.
|
|
3091
|
-
|
|
3092
|
-
If the target directory matches one of the package directories in your sfdx-project.json file, the command fails.
|
|
3093
|
-
|
|
3094
|
-
Running the command multiple times with the same target adds new files and overwrites existing files.
|
|
3095
|
-
|
|
3096
|
-
-w, --wait=<value> Number of minutes to wait for the command to complete and display results to the terminal window.
|
|
3097
|
-
|
|
3098
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
|
|
3099
|
-
|
|
3100
|
-
-x, --manifest=<value> Complete path for the manifest (package.xml) file that specifies the components to retrieve.
|
|
3101
|
-
|
|
3102
|
-
If you specify this parameter, don’t specify --metadata or --sourcepath.
|
|
3103
|
-
```
|
|
3104
|
-
|
|
3105
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/retrieve.ts)_
|
|
3106
|
-
|
|
3107
|
-
## `sf force source status`
|
|
3108
|
-
|
|
3109
|
-
List changes that have been made locally, in an org, or both.
|
|
3110
|
-
|
|
3111
|
-
```
|
|
3112
|
-
USAGE
|
|
3113
|
-
$ sf force source status -o <value> [--json] [--api-version <value>] [-l | -r] [--concise]
|
|
3114
|
-
|
|
3115
|
-
FLAGS
|
|
3116
|
-
-l, --local List the changes that have been made locally.
|
|
3117
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
3118
|
-
configuration variable is already set.
|
|
3119
|
-
-r, --remote List the changes that have been made in the org.
|
|
3120
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3121
|
-
--concise Show only the changes that will be pushed or pulled; omits files that are forceignored.
|
|
3122
|
-
|
|
3123
|
-
GLOBAL FLAGS
|
|
3124
|
-
--json Format output as json.
|
|
3125
|
-
|
|
3126
|
-
EXAMPLES
|
|
3127
|
-
List changes that have been made locally but not in the org with alias "myscratch":
|
|
3128
|
-
|
|
3129
|
-
$ sf force source status --local --target-org myscratch
|
|
3130
|
-
|
|
3131
|
-
List changes that have been made in your default org but aren't reflected in your local project:
|
|
3132
|
-
|
|
3133
|
-
$ sf force source status --remote
|
|
3134
|
-
```
|
|
3135
|
-
|
|
3136
|
-
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/status.ts)_
|
|
3137
|
-
|
|
3138
|
-
## `sf force user password generate`
|
|
3139
|
-
|
|
3140
|
-
Generate a random password for scratch org users.
|
|
3141
|
-
|
|
3142
|
-
```
|
|
3143
|
-
USAGE
|
|
3144
|
-
$ sf force user password generate -u <value> [--json] [-o <value>] [-l <value>] [-c <value>] [--api-version <value>]
|
|
3145
|
-
|
|
3146
|
-
FLAGS
|
|
3147
|
-
-c, --complexity=<value> [default: 5] Level of password complexity or strength; the higher the value, the
|
|
3148
|
-
stronger the password.
|
|
3149
|
-
-l, --length=<value> [default: 13] Number of characters in the generated password; valid values are between
|
|
3150
|
-
8 and 100.
|
|
3151
|
-
-o, --on-behalf-of=<value>... Comma-separated list of usernames or aliases to assign the password to; must have been
|
|
3152
|
-
created locally with the "org create user" command.
|
|
3153
|
-
-u, --target-org=<value> (required) Scratch org alias or login user.
|
|
3154
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3155
|
-
|
|
3156
|
-
GLOBAL FLAGS
|
|
3157
|
-
--json Format output as json.
|
|
3158
|
-
|
|
3159
|
-
DESCRIPTION
|
|
3160
|
-
Generate a random password for scratch org users.
|
|
3161
|
-
|
|
3162
|
-
By default, new scratch orgs contain one admin user with no password. Use this command to generate or change a
|
|
3163
|
-
password for this admin user. After it's set, you can’t unset a password, you can only change it.
|
|
3164
|
-
|
|
3165
|
-
You can also use the --on-behalf-of flag to generate a password for a scratch org user that you've created locally
|
|
3166
|
-
with the "org create user" command. This command doesn't work for users you created in the scratch org using Setup.
|
|
3167
|
-
|
|
3168
|
-
To change the password strength, set the --complexity flag to a value between 0 and 5. Each value specifies the types
|
|
3169
|
-
of characters used in the generated password:
|
|
3170
|
-
|
|
3171
|
-
0 - lower case letters only
|
|
3172
|
-
1 - lower case letters and numbers only
|
|
3173
|
-
2 - lower case letters and symbols only
|
|
3174
|
-
3 - lower and upper case letters and numbers only
|
|
3175
|
-
4 - lower and upper case letters and symbols only
|
|
3176
|
-
5 - lower and upper case letters and numbers and symbols only
|
|
3177
|
-
|
|
3178
|
-
To see a password that was previously generated, run "org display user".
|
|
3179
|
-
|
|
3180
|
-
EXAMPLES
|
|
3181
|
-
Generate a password for the original admin user of your default scratch org:
|
|
3182
|
-
|
|
3183
|
-
$ sf force user password generate
|
|
3184
|
-
|
|
3185
|
-
Generate a password that contains 12 characters for the original admin user of the scratch org with alias
|
|
3186
|
-
"my-scratch":
|
|
3187
|
-
|
|
3188
|
-
$ sf force user password generate --length 12 --target-org my-scratch
|
|
3189
|
-
|
|
3190
|
-
Generate a password for your default scratch org admin user that uses lower and upper case letters and numbers only:
|
|
3191
|
-
|
|
3192
|
-
$ sf force user password generate --complexity 3
|
|
3193
|
-
|
|
3194
|
-
Generate a password for the specified users in the default scratch org; these users must have been created locally
|
|
3195
|
-
with the "org create user" command:
|
|
3196
|
-
|
|
3197
|
-
$ sf force user password generate --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of \
|
|
3198
|
-
user3@my.org
|
|
3199
|
-
```
|
|
3200
|
-
|
|
3201
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.1.5/src/commands/force/user/password/generate.ts)_
|
|
3202
|
-
|
|
3203
1895
|
## `sf help [COMMANDS]`
|
|
3204
1896
|
|
|
3205
1897
|
Display help for sf.
|
|
@@ -3580,7 +2272,7 @@ EXAMPLES
|
|
|
3580
2272
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
3581
2273
|
```
|
|
3582
2274
|
|
|
3583
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2275
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/assign/permset.ts)_
|
|
3584
2276
|
|
|
3585
2277
|
## `sf org assign permsetlicense`
|
|
3586
2278
|
|
|
@@ -3624,7 +2316,7 @@ EXAMPLES
|
|
|
3624
2316
|
user3
|
|
3625
2317
|
```
|
|
3626
2318
|
|
|
3627
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2319
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/assign/permsetlicense.ts)_
|
|
3628
2320
|
|
|
3629
2321
|
## `sf org create sandbox`
|
|
3630
2322
|
|
|
@@ -3729,7 +2421,7 @@ FLAG DESCRIPTIONS
|
|
|
3729
2421
|
sandbox.
|
|
3730
2422
|
```
|
|
3731
2423
|
|
|
3732
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2424
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/create/sandbox.ts)_
|
|
3733
2425
|
|
|
3734
2426
|
## `sf org create scratch`
|
|
3735
2427
|
|
|
@@ -3882,7 +2574,7 @@ FLAG DESCRIPTIONS
|
|
|
3882
2574
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
3883
2575
|
```
|
|
3884
2576
|
|
|
3885
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2577
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/create/scratch.ts)_
|
|
3886
2578
|
|
|
3887
2579
|
## `sf org create user`
|
|
3888
2580
|
|
|
@@ -3981,7 +2673,7 @@ FLAG DESCRIPTIONS
|
|
|
3981
2673
|
might be different than what you specify in the definition file.
|
|
3982
2674
|
```
|
|
3983
2675
|
|
|
3984
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2676
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/create/user.ts)_
|
|
3985
2677
|
|
|
3986
2678
|
## `sf org delete sandbox`
|
|
3987
2679
|
|
|
@@ -4025,7 +2717,7 @@ EXAMPLES
|
|
|
4025
2717
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
4026
2718
|
```
|
|
4027
2719
|
|
|
4028
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2720
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/delete/sandbox.ts)_
|
|
4029
2721
|
|
|
4030
2722
|
## `sf org delete scratch`
|
|
4031
2723
|
|
|
@@ -4067,7 +2759,7 @@ EXAMPLES
|
|
|
4067
2759
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
4068
2760
|
```
|
|
4069
2761
|
|
|
4070
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2762
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/delete/scratch.ts)_
|
|
4071
2763
|
|
|
4072
2764
|
## `sf org disable tracking`
|
|
4073
2765
|
|
|
@@ -4105,7 +2797,7 @@ EXAMPLES
|
|
|
4105
2797
|
$ sf org disable tracking
|
|
4106
2798
|
```
|
|
4107
2799
|
|
|
4108
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2800
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/disable/tracking.ts)_
|
|
4109
2801
|
|
|
4110
2802
|
## `sf org display`
|
|
4111
2803
|
|
|
@@ -4149,7 +2841,7 @@ EXAMPLES
|
|
|
4149
2841
|
$ sf org display --target-org TestOrg1 --verbose
|
|
4150
2842
|
```
|
|
4151
2843
|
|
|
4152
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2844
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/display.ts)_
|
|
4153
2845
|
|
|
4154
2846
|
## `sf org display user`
|
|
4155
2847
|
|
|
@@ -4187,7 +2879,7 @@ EXAMPLES
|
|
|
4187
2879
|
$ sf org display user --target-org me@my.org --json
|
|
4188
2880
|
```
|
|
4189
2881
|
|
|
4190
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2882
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/display/user.ts)_
|
|
4191
2883
|
|
|
4192
2884
|
## `sf org enable tracking`
|
|
4193
2885
|
|
|
@@ -4228,7 +2920,7 @@ EXAMPLES
|
|
|
4228
2920
|
$ sf org enable tracking
|
|
4229
2921
|
```
|
|
4230
2922
|
|
|
4231
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
2923
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/enable/tracking.ts)_
|
|
4232
2924
|
|
|
4233
2925
|
## `sf org generate password`
|
|
4234
2926
|
|
|
@@ -4293,7 +2985,7 @@ EXAMPLES
|
|
|
4293
2985
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
4294
2986
|
```
|
|
4295
2987
|
|
|
4296
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
2988
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/generate/password.ts)_
|
|
4297
2989
|
|
|
4298
2990
|
## `sf org list`
|
|
4299
2991
|
|
|
@@ -4331,7 +3023,7 @@ EXAMPLES
|
|
|
4331
3023
|
$ sf org list --clean
|
|
4332
3024
|
```
|
|
4333
3025
|
|
|
4334
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3026
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list.ts)_
|
|
4335
3027
|
|
|
4336
3028
|
## `sf org list auth`
|
|
4337
3029
|
|
|
@@ -4362,7 +3054,7 @@ EXAMPLES
|
|
|
4362
3054
|
$ sf org list auth
|
|
4363
3055
|
```
|
|
4364
3056
|
|
|
4365
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
3057
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/list/auth.ts)_
|
|
4366
3058
|
|
|
4367
3059
|
## `sf org list limits`
|
|
4368
3060
|
|
|
@@ -4401,7 +3093,7 @@ EXAMPLES
|
|
|
4401
3093
|
$ sf org list limits --target-org my-scratch-org
|
|
4402
3094
|
```
|
|
4403
3095
|
|
|
4404
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0
|
|
3096
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.0/src/commands/org/list/limits.ts)_
|
|
4405
3097
|
|
|
4406
3098
|
## `sf org list metadata`
|
|
4407
3099
|
|
|
@@ -4466,7 +3158,7 @@ FLAG DESCRIPTIONS
|
|
|
4466
3158
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
4467
3159
|
```
|
|
4468
3160
|
|
|
4469
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3161
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list/metadata.ts)_
|
|
4470
3162
|
|
|
4471
3163
|
## `sf org list metadata-types`
|
|
4472
3164
|
|
|
@@ -4520,7 +3212,7 @@ FLAG DESCRIPTIONS
|
|
|
4520
3212
|
Override the api version used for api requests made by this command
|
|
4521
3213
|
```
|
|
4522
3214
|
|
|
4523
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3215
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list/metadata-types.ts)_
|
|
4524
3216
|
|
|
4525
3217
|
## `sf org list sobject record-counts`
|
|
4526
3218
|
|
|
@@ -4565,7 +3257,7 @@ EXAMPLES
|
|
|
4565
3257
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
4566
3258
|
```
|
|
4567
3259
|
|
|
4568
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0
|
|
3260
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.0/src/commands/org/list/sobject/record-counts.ts)_
|
|
4569
3261
|
|
|
4570
3262
|
## `sf org list users`
|
|
4571
3263
|
|
|
@@ -4602,7 +3294,7 @@ EXAMPLES
|
|
|
4602
3294
|
$ sf org list users --target-org me@my.org
|
|
4603
3295
|
```
|
|
4604
3296
|
|
|
4605
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3297
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/list/users.ts)_
|
|
4606
3298
|
|
|
4607
3299
|
## `sf org login access-token`
|
|
4608
3300
|
|
|
@@ -4655,7 +3347,7 @@ FLAG DESCRIPTIONS
|
|
|
4655
3347
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4656
3348
|
```
|
|
4657
3349
|
|
|
4658
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
3350
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/access-token.ts)_
|
|
4659
3351
|
|
|
4660
3352
|
## `sf org login device`
|
|
4661
3353
|
|
|
@@ -4714,7 +3406,7 @@ FLAG DESCRIPTIONS
|
|
|
4714
3406
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4715
3407
|
```
|
|
4716
3408
|
|
|
4717
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
3409
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/device.ts)_
|
|
4718
3410
|
|
|
4719
3411
|
## `sf org login jwt`
|
|
4720
3412
|
|
|
@@ -4770,7 +3462,7 @@ ALIASES
|
|
|
4770
3462
|
$ sf auth jwt grant
|
|
4771
3463
|
|
|
4772
3464
|
EXAMPLES
|
|
4773
|
-
Log into an org with username jdoe@example.org and on the default instance URL (https://login.salesforce.
|
|
3465
|
+
Log into an org with username jdoe@example.org and on the default instance URL (https://login.salesforce.com). The
|
|
4774
3466
|
private key is stored in the file /Users/jdoe/JWT/server.key and the command uses the connected app with consumer
|
|
4775
3467
|
key (client id) 04580y4051234051.
|
|
4776
3468
|
|
|
@@ -4803,7 +3495,7 @@ FLAG DESCRIPTIONS
|
|
|
4803
3495
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4804
3496
|
```
|
|
4805
3497
|
|
|
4806
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
3498
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/jwt.ts)_
|
|
4807
3499
|
|
|
4808
3500
|
## `sf org login sfdx-url`
|
|
4809
3501
|
|
|
@@ -4861,7 +3553,7 @@ EXAMPLES
|
|
|
4861
3553
|
$ sf org login sfdx-url --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg
|
|
4862
3554
|
```
|
|
4863
3555
|
|
|
4864
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
3556
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/sfdx-url.ts)_
|
|
4865
3557
|
|
|
4866
3558
|
## `sf org login web`
|
|
4867
3559
|
|
|
@@ -4946,7 +3638,7 @@ FLAG DESCRIPTIONS
|
|
|
4946
3638
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4947
3639
|
```
|
|
4948
3640
|
|
|
4949
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
3641
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/web.ts)_
|
|
4950
3642
|
|
|
4951
3643
|
## `sf org logout`
|
|
4952
3644
|
|
|
@@ -5006,7 +3698,7 @@ FLAG DESCRIPTIONS
|
|
|
5006
3698
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
5007
3699
|
```
|
|
5008
3700
|
|
|
5009
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
3701
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/logout.ts)_
|
|
5010
3702
|
|
|
5011
3703
|
## `sf org open`
|
|
5012
3704
|
|
|
@@ -5072,7 +3764,7 @@ EXAMPLES
|
|
|
5072
3764
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
5073
3765
|
```
|
|
5074
3766
|
|
|
5075
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3767
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/open.ts)_
|
|
5076
3768
|
|
|
5077
3769
|
## `sf org resume sandbox`
|
|
5078
3770
|
|
|
@@ -5134,7 +3826,7 @@ FLAG DESCRIPTIONS
|
|
|
5134
3826
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
5135
3827
|
```
|
|
5136
3828
|
|
|
5137
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3829
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/resume/sandbox.ts)_
|
|
5138
3830
|
|
|
5139
3831
|
## `sf org resume scratch`
|
|
5140
3832
|
|
|
@@ -5180,7 +3872,7 @@ FLAG DESCRIPTIONS
|
|
|
5180
3872
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
5181
3873
|
```
|
|
5182
3874
|
|
|
5183
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3875
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/resume/scratch.ts)_
|
|
5184
3876
|
|
|
5185
3877
|
## `sf package1 version create`
|
|
5186
3878
|
|
|
@@ -5246,7 +3938,7 @@ FLAG DESCRIPTIONS
|
|
|
5246
3938
|
subscribers.
|
|
5247
3939
|
```
|
|
5248
3940
|
|
|
5249
|
-
_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)_
|
|
5250
3942
|
|
|
5251
3943
|
## `sf package1 version create get`
|
|
5252
3944
|
|
|
@@ -5278,7 +3970,7 @@ EXAMPLES
|
|
|
5278
3970
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
5279
3971
|
```
|
|
5280
3972
|
|
|
5281
|
-
_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)_
|
|
5282
3974
|
|
|
5283
3975
|
## `sf package1 version display`
|
|
5284
3976
|
|
|
@@ -5311,7 +4003,7 @@ EXAMPLES
|
|
|
5311
4003
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
5312
4004
|
```
|
|
5313
4005
|
|
|
5314
|
-
_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)_
|
|
5315
4007
|
|
|
5316
4008
|
## `sf package1 version list`
|
|
5317
4009
|
|
|
@@ -5348,7 +4040,7 @@ FLAG DESCRIPTIONS
|
|
|
5348
4040
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
5349
4041
|
```
|
|
5350
4042
|
|
|
5351
|
-
_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)_
|
|
5352
4044
|
|
|
5353
4045
|
## `sf package create`
|
|
5354
4046
|
|
|
@@ -5426,7 +4118,7 @@ FLAG DESCRIPTIONS
|
|
|
5426
4118
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
5427
4119
|
```
|
|
5428
4120
|
|
|
5429
|
-
_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)_
|
|
5430
4122
|
|
|
5431
4123
|
## `sf package delete`
|
|
5432
4124
|
|
|
@@ -5467,7 +4159,7 @@ EXAMPLES
|
|
|
5467
4159
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
5468
4160
|
```
|
|
5469
4161
|
|
|
5470
|
-
_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)_
|
|
5471
4163
|
|
|
5472
4164
|
## `sf package install`
|
|
5473
4165
|
|
|
@@ -5565,7 +4257,7 @@ FLAG DESCRIPTIONS
|
|
|
5565
4257
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
5566
4258
|
```
|
|
5567
4259
|
|
|
5568
|
-
_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)_
|
|
5569
4261
|
|
|
5570
4262
|
## `sf package install report`
|
|
5571
4263
|
|
|
@@ -5597,7 +4289,7 @@ EXAMPLES
|
|
|
5597
4289
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
5598
4290
|
```
|
|
5599
4291
|
|
|
5600
|
-
_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)_
|
|
5601
4293
|
|
|
5602
4294
|
## `sf package installed list`
|
|
5603
4295
|
|
|
@@ -5628,7 +4320,7 @@ EXAMPLES
|
|
|
5628
4320
|
$ sf package installed list --target-org me@example.com
|
|
5629
4321
|
```
|
|
5630
4322
|
|
|
5631
|
-
_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)_
|
|
5632
4324
|
|
|
5633
4325
|
## `sf package list`
|
|
5634
4326
|
|
|
@@ -5665,7 +4357,7 @@ EXAMPLES
|
|
|
5665
4357
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
5666
4358
|
```
|
|
5667
4359
|
|
|
5668
|
-
_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)_
|
|
5669
4361
|
|
|
5670
4362
|
## `sf package uninstall`
|
|
5671
4363
|
|
|
@@ -5712,7 +4404,7 @@ EXAMPLES
|
|
|
5712
4404
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
5713
4405
|
```
|
|
5714
4406
|
|
|
5715
|
-
_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)_
|
|
5716
4408
|
|
|
5717
4409
|
## `sf package uninstall report`
|
|
5718
4410
|
|
|
@@ -5744,7 +4436,7 @@ EXAMPLES
|
|
|
5744
4436
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
5745
4437
|
```
|
|
5746
4438
|
|
|
5747
|
-
_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)_
|
|
5748
4440
|
|
|
5749
4441
|
## `sf package update`
|
|
5750
4442
|
|
|
@@ -5798,7 +4490,7 @@ FLAG DESCRIPTIONS
|
|
|
5798
4490
|
associated with your package.
|
|
5799
4491
|
```
|
|
5800
4492
|
|
|
5801
|
-
_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)_
|
|
5802
4494
|
|
|
5803
4495
|
## `sf package version create`
|
|
5804
4496
|
|
|
@@ -5953,7 +4645,7 @@ FLAG DESCRIPTIONS
|
|
|
5953
4645
|
periods of no output from commands.
|
|
5954
4646
|
```
|
|
5955
4647
|
|
|
5956
|
-
_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)_
|
|
5957
4649
|
|
|
5958
4650
|
## `sf package version create list`
|
|
5959
4651
|
|
|
@@ -6013,7 +4705,7 @@ EXAMPLES
|
|
|
6013
4705
|
$ sf package version create list --created-last-days 0 --status Success
|
|
6014
4706
|
```
|
|
6015
4707
|
|
|
6016
|
-
_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)_
|
|
6017
4709
|
|
|
6018
4710
|
## `sf package version create report`
|
|
6019
4711
|
|
|
@@ -6055,7 +4747,7 @@ EXAMPLES
|
|
|
6055
4747
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
6056
4748
|
```
|
|
6057
4749
|
|
|
6058
|
-
_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)_
|
|
6059
4751
|
|
|
6060
4752
|
## `sf package version delete`
|
|
6061
4753
|
|
|
@@ -6093,7 +4785,7 @@ EXAMPLES
|
|
|
6093
4785
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
6094
4786
|
```
|
|
6095
4787
|
|
|
6096
|
-
_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)_
|
|
6097
4789
|
|
|
6098
4790
|
## `sf package version displayancestry`
|
|
6099
4791
|
|
|
@@ -6151,7 +4843,7 @@ FLAG DESCRIPTIONS
|
|
|
6151
4843
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
6152
4844
|
```
|
|
6153
4845
|
|
|
6154
|
-
_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)_
|
|
6155
4847
|
|
|
6156
4848
|
## `sf package version list`
|
|
6157
4849
|
|
|
@@ -6219,7 +4911,7 @@ EXAMPLES
|
|
|
6219
4911
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
6220
4912
|
```
|
|
6221
4913
|
|
|
6222
|
-
_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)_
|
|
6223
4915
|
|
|
6224
4916
|
## `sf package version promote`
|
|
6225
4917
|
|
|
@@ -6262,7 +4954,7 @@ EXAMPLES
|
|
|
6262
4954
|
$ sf package version promote --package "Awesome Package Alias"
|
|
6263
4955
|
```
|
|
6264
4956
|
|
|
6265
|
-
_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)_
|
|
6266
4958
|
|
|
6267
4959
|
## `sf package version report`
|
|
6268
4960
|
|
|
@@ -6301,7 +4993,7 @@ EXAMPLES
|
|
|
6301
4993
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
6302
4994
|
```
|
|
6303
4995
|
|
|
6304
|
-
_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)_
|
|
6305
4997
|
|
|
6306
4998
|
## `sf package version update`
|
|
6307
4999
|
|
|
@@ -6353,7 +5045,7 @@ EXAMPLES
|
|
|
6353
5045
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
6354
5046
|
```
|
|
6355
5047
|
|
|
6356
|
-
_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)_
|
|
6357
5049
|
|
|
6358
5050
|
## `sf plugins`
|
|
6359
5051
|
|
|
@@ -6376,7 +5068,7 @@ EXAMPLES
|
|
|
6376
5068
|
$ sf plugins
|
|
6377
5069
|
```
|
|
6378
5070
|
|
|
6379
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5071
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/index.ts)_
|
|
6380
5072
|
|
|
6381
5073
|
## `sf plugins discover`
|
|
6382
5074
|
|
|
@@ -6420,7 +5112,7 @@ EXAMPLES
|
|
|
6420
5112
|
$ sf plugins inspect myplugin
|
|
6421
5113
|
```
|
|
6422
5114
|
|
|
6423
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5115
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/inspect.ts)_
|
|
6424
5116
|
|
|
6425
5117
|
## `sf plugins:install PLUGIN...`
|
|
6426
5118
|
|
|
@@ -6464,7 +5156,7 @@ EXAMPLES
|
|
|
6464
5156
|
$ sf plugins install someuser/someplugin
|
|
6465
5157
|
```
|
|
6466
5158
|
|
|
6467
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5159
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/install.ts)_
|
|
6468
5160
|
|
|
6469
5161
|
## `sf plugins:link PLUGIN`
|
|
6470
5162
|
|
|
@@ -6494,7 +5186,7 @@ EXAMPLES
|
|
|
6494
5186
|
$ sf plugins link myplugin
|
|
6495
5187
|
```
|
|
6496
5188
|
|
|
6497
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5189
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/link.ts)_
|
|
6498
5190
|
|
|
6499
5191
|
## `sf plugins reset`
|
|
6500
5192
|
|
|
@@ -6505,7 +5197,7 @@ USAGE
|
|
|
6505
5197
|
$ sf plugins reset
|
|
6506
5198
|
```
|
|
6507
5199
|
|
|
6508
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5200
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/reset.ts)_
|
|
6509
5201
|
|
|
6510
5202
|
## `sf plugins trust verify`
|
|
6511
5203
|
|
|
@@ -6561,7 +5253,7 @@ EXAMPLES
|
|
|
6561
5253
|
$ sf plugins uninstall myplugin
|
|
6562
5254
|
```
|
|
6563
5255
|
|
|
6564
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5256
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/uninstall.ts)_
|
|
6565
5257
|
|
|
6566
5258
|
## `sf plugins update`
|
|
6567
5259
|
|
|
@@ -6579,7 +5271,7 @@ DESCRIPTION
|
|
|
6579
5271
|
Update installed plugins.
|
|
6580
5272
|
```
|
|
6581
5273
|
|
|
6582
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
5274
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/update.ts)_
|
|
6583
5275
|
|
|
6584
5276
|
## `sf project convert mdapi`
|
|
6585
5277
|
|
|
@@ -6641,7 +5333,7 @@ FLAG DESCRIPTIONS
|
|
|
6641
5333
|
If you specify this parameter, don’t specify --metadata or --source-dir.
|
|
6642
5334
|
```
|
|
6643
5335
|
|
|
6644
|
-
_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)_
|
|
6645
5337
|
|
|
6646
5338
|
## `sf project convert source`
|
|
6647
5339
|
|
|
@@ -6653,7 +5345,7 @@ USAGE
|
|
|
6653
5345
|
<value> | -m <value>]
|
|
6654
5346
|
|
|
6655
5347
|
FLAGS
|
|
6656
|
-
-d, --output-dir=<value> [default:
|
|
5348
|
+
-d, --output-dir=<value> [default: metadataPackage_1704318036676] Output directory to store the Metadata
|
|
6657
5349
|
API–formatted files in.
|
|
6658
5350
|
-m, --metadata=<value>... Metadata component names to convert.
|
|
6659
5351
|
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
|
|
@@ -6713,7 +5405,7 @@ FLAG DESCRIPTIONS
|
|
|
6713
5405
|
Override the api version used for api requests made by this command
|
|
6714
5406
|
```
|
|
6715
5407
|
|
|
6716
|
-
_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)_
|
|
6717
5409
|
|
|
6718
5410
|
## `sf project delete source`
|
|
6719
5411
|
|
|
@@ -6852,7 +5544,7 @@ FLAG DESCRIPTIONS
|
|
|
6852
5544
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
6853
5545
|
```
|
|
6854
5546
|
|
|
6855
|
-
_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)_
|
|
6856
5548
|
|
|
6857
5549
|
## `sf project delete tracking`
|
|
6858
5550
|
|
|
@@ -6888,7 +5580,7 @@ EXAMPLES
|
|
|
6888
5580
|
$ sf project delete tracking --target-org my-scratch
|
|
6889
5581
|
```
|
|
6890
5582
|
|
|
6891
|
-
_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)_
|
|
6892
5584
|
|
|
6893
5585
|
## `sf project deploy cancel`
|
|
6894
5586
|
|
|
@@ -6958,7 +5650,7 @@ FLAG DESCRIPTIONS
|
|
|
6958
5650
|
project deploy report".
|
|
6959
5651
|
```
|
|
6960
5652
|
|
|
6961
|
-
_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)_
|
|
6962
5654
|
|
|
6963
5655
|
## `sf project deploy preview`
|
|
6964
5656
|
|
|
@@ -7041,7 +5733,7 @@ FLAG DESCRIPTIONS
|
|
|
7041
5733
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
7042
5734
|
```
|
|
7043
5735
|
|
|
7044
|
-
_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)_
|
|
7045
5737
|
|
|
7046
5738
|
## `sf project deploy quick`
|
|
7047
5739
|
|
|
@@ -7134,7 +5826,7 @@ ERROR CODES
|
|
|
7134
5826
|
Canceling (69) The deploy is being canceled.
|
|
7135
5827
|
```
|
|
7136
5828
|
|
|
7137
|
-
_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)_
|
|
7138
5830
|
|
|
7139
5831
|
## `sf project deploy report`
|
|
7140
5832
|
|
|
@@ -7229,7 +5921,7 @@ FLAG DESCRIPTIONS
|
|
|
7229
5921
|
--coverage-formatters lcov --coverage-formatters clover
|
|
7230
5922
|
```
|
|
7231
5923
|
|
|
7232
|
-
_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)_
|
|
7233
5925
|
|
|
7234
5926
|
## `sf project deploy resume`
|
|
7235
5927
|
|
|
@@ -7325,7 +6017,7 @@ ERROR CODES
|
|
|
7325
6017
|
Canceling (69) The deploy is being canceled.
|
|
7326
6018
|
```
|
|
7327
6019
|
|
|
7328
|
-
_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)_
|
|
7329
6021
|
|
|
7330
6022
|
## `sf project deploy start`
|
|
7331
6023
|
|
|
@@ -7554,7 +6246,7 @@ ERROR CODES
|
|
|
7554
6246
|
Canceling (69) The deploy is being canceled.
|
|
7555
6247
|
```
|
|
7556
6248
|
|
|
7557
|
-
_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)_
|
|
7558
6250
|
|
|
7559
6251
|
## `sf project deploy validate`
|
|
7560
6252
|
|
|
@@ -7733,7 +6425,7 @@ ERROR CODES
|
|
|
7733
6425
|
Canceling (69) The deploy is being canceled.
|
|
7734
6426
|
```
|
|
7735
6427
|
|
|
7736
|
-
_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)_
|
|
7737
6429
|
|
|
7738
6430
|
## `sf project generate`
|
|
7739
6431
|
|
|
@@ -7912,7 +6604,7 @@ EXAMPLES
|
|
|
7912
6604
|
$ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
|
|
7913
6605
|
```
|
|
7914
6606
|
|
|
7915
|
-
_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)_
|
|
7916
6608
|
|
|
7917
6609
|
## `sf project list ignored`
|
|
7918
6610
|
|
|
@@ -7953,7 +6645,7 @@ EXAMPLES
|
|
|
7953
6645
|
$ sf project list ignored --source-dir package.xml
|
|
7954
6646
|
```
|
|
7955
6647
|
|
|
7956
|
-
_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)_
|
|
7957
6649
|
|
|
7958
6650
|
## `sf project reset tracking`
|
|
7959
6651
|
|
|
@@ -8001,7 +6693,7 @@ EXAMPLES
|
|
|
8001
6693
|
$ sf project reset tracking --revision 30
|
|
8002
6694
|
```
|
|
8003
6695
|
|
|
8004
|
-
_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)_
|
|
8005
6697
|
|
|
8006
6698
|
## `sf project retrieve preview`
|
|
8007
6699
|
|
|
@@ -8057,7 +6749,7 @@ FLAG DESCRIPTIONS
|
|
|
8057
6749
|
Overrides your default org.
|
|
8058
6750
|
```
|
|
8059
6751
|
|
|
8060
|
-
_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)_
|
|
8061
6753
|
|
|
8062
6754
|
## `sf project retrieve start`
|
|
8063
6755
|
|
|
@@ -8211,7 +6903,7 @@ ENVIRONMENT VARIABLES
|
|
|
8211
6903
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
8212
6904
|
```
|
|
8213
6905
|
|
|
8214
|
-
_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)_
|
|
8215
6907
|
|
|
8216
6908
|
## `sf schema generate field`
|
|
8217
6909
|
|
|
@@ -8454,7 +7146,7 @@ EXAMPLES
|
|
|
8454
7146
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
8455
7147
|
```
|
|
8456
7148
|
|
|
8457
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0
|
|
7149
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.0/src/commands/sobject/describe.ts)_
|
|
8458
7150
|
|
|
8459
7151
|
## `sf sobject list`
|
|
8460
7152
|
|
|
@@ -8492,7 +7184,7 @@ EXAMPLES
|
|
|
8492
7184
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
8493
7185
|
```
|
|
8494
7186
|
|
|
8495
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0
|
|
7187
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.0/src/commands/sobject/list.ts)_
|
|
8496
7188
|
|
|
8497
7189
|
## `sf static-resource generate`
|
|
8498
7190
|
|