@salesforce/plugin-org 5.11.2 → 5.11.3
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 +20 -20
- package/oclif.manifest.json +152 -152
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -161,7 +161,7 @@ EXAMPLES
|
|
|
161
161
|
$ sf org auth show-access-token --target-org my-org --json
|
|
162
162
|
```
|
|
163
163
|
|
|
164
|
-
_See code: [src/commands/org/auth/show-access-token.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
164
|
+
_See code: [src/commands/org/auth/show-access-token.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/auth/show-access-token.ts)_
|
|
165
165
|
|
|
166
166
|
## `sf org auth show-sfdx-auth-url`
|
|
167
167
|
|
|
@@ -205,7 +205,7 @@ EXAMPLES
|
|
|
205
205
|
$ sf org auth show-sfdx-auth-url --target-org my-org --json
|
|
206
206
|
```
|
|
207
207
|
|
|
208
|
-
_See code: [src/commands/org/auth/show-sfdx-auth-url.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
208
|
+
_See code: [src/commands/org/auth/show-sfdx-auth-url.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/auth/show-sfdx-auth-url.ts)_
|
|
209
209
|
|
|
210
210
|
## `sf org auth show-user-password`
|
|
211
211
|
|
|
@@ -252,7 +252,7 @@ EXAMPLES
|
|
|
252
252
|
$ sf org auth show-user-password --target-org my-org --json
|
|
253
253
|
```
|
|
254
254
|
|
|
255
|
-
_See code: [src/commands/org/auth/show-user-password.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
255
|
+
_See code: [src/commands/org/auth/show-user-password.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/auth/show-user-password.ts)_
|
|
256
256
|
|
|
257
257
|
## `sf org create agent-user`
|
|
258
258
|
|
|
@@ -330,7 +330,7 @@ FLAG DESCRIPTIONS
|
|
|
330
330
|
"agent.user.<GUID>@your-org-domain.com".
|
|
331
331
|
```
|
|
332
332
|
|
|
333
|
-
_See code: [src/commands/org/create/agent-user.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
333
|
+
_See code: [src/commands/org/create/agent-user.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/create/agent-user.ts)_
|
|
334
334
|
|
|
335
335
|
## `sf org create sandbox`
|
|
336
336
|
|
|
@@ -464,7 +464,7 @@ FLAG DESCRIPTIONS
|
|
|
464
464
|
You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
|
|
465
465
|
```
|
|
466
466
|
|
|
467
|
-
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
467
|
+
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/create/sandbox.ts)_
|
|
468
468
|
|
|
469
469
|
## `sf org create scratch`
|
|
470
470
|
|
|
@@ -646,7 +646,7 @@ FLAG DESCRIPTIONS
|
|
|
646
646
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
647
647
|
```
|
|
648
648
|
|
|
649
|
-
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
649
|
+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/create/scratch.ts)_
|
|
650
650
|
|
|
651
651
|
## `sf org delete sandbox`
|
|
652
652
|
|
|
@@ -692,7 +692,7 @@ EXAMPLES
|
|
|
692
692
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
693
693
|
```
|
|
694
694
|
|
|
695
|
-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
695
|
+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/delete/sandbox.ts)_
|
|
696
696
|
|
|
697
697
|
## `sf org delete scratch`
|
|
698
698
|
|
|
@@ -736,7 +736,7 @@ EXAMPLES
|
|
|
736
736
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
737
737
|
```
|
|
738
738
|
|
|
739
|
-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
739
|
+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/delete/scratch.ts)_
|
|
740
740
|
|
|
741
741
|
## `sf org disable tracking`
|
|
742
742
|
|
|
@@ -775,7 +775,7 @@ EXAMPLES
|
|
|
775
775
|
$ sf org disable tracking
|
|
776
776
|
```
|
|
777
777
|
|
|
778
|
-
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
778
|
+
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/disable/tracking.ts)_
|
|
779
779
|
|
|
780
780
|
## `sf org display`
|
|
781
781
|
|
|
@@ -820,7 +820,7 @@ EXAMPLES
|
|
|
820
820
|
$ sf org display --target-org TestOrg1 --verbose
|
|
821
821
|
```
|
|
822
822
|
|
|
823
|
-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
823
|
+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/display.ts)_
|
|
824
824
|
|
|
825
825
|
## `sf org enable tracking`
|
|
826
826
|
|
|
@@ -862,7 +862,7 @@ EXAMPLES
|
|
|
862
862
|
$ sf org enable tracking
|
|
863
863
|
```
|
|
864
864
|
|
|
865
|
-
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
865
|
+
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/enable/tracking.ts)_
|
|
866
866
|
|
|
867
867
|
## `sf org list`
|
|
868
868
|
|
|
@@ -901,7 +901,7 @@ EXAMPLES
|
|
|
901
901
|
$ sf org list --clean
|
|
902
902
|
```
|
|
903
903
|
|
|
904
|
-
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
904
|
+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/list.ts)_
|
|
905
905
|
|
|
906
906
|
## `sf org list metadata`
|
|
907
907
|
|
|
@@ -968,7 +968,7 @@ FLAG DESCRIPTIONS
|
|
|
968
968
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
969
969
|
```
|
|
970
970
|
|
|
971
|
-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
971
|
+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/list/metadata.ts)_
|
|
972
972
|
|
|
973
973
|
## `sf org list metadata-types`
|
|
974
974
|
|
|
@@ -1023,7 +1023,7 @@ FLAG DESCRIPTIONS
|
|
|
1023
1023
|
Override the api version used for api requests made by this command
|
|
1024
1024
|
```
|
|
1025
1025
|
|
|
1026
|
-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
1026
|
+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/list/metadata-types.ts)_
|
|
1027
1027
|
|
|
1028
1028
|
## `sf org open`
|
|
1029
1029
|
|
|
@@ -1099,7 +1099,7 @@ EXAMPLES
|
|
|
1099
1099
|
$ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
|
|
1100
1100
|
```
|
|
1101
1101
|
|
|
1102
|
-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
1102
|
+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/open.ts)_
|
|
1103
1103
|
|
|
1104
1104
|
## `sf org open agent`
|
|
1105
1105
|
|
|
@@ -1174,7 +1174,7 @@ FLAG DESCRIPTIONS
|
|
|
1174
1174
|
flag.
|
|
1175
1175
|
```
|
|
1176
1176
|
|
|
1177
|
-
_See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
1177
|
+
_See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/open/agent.ts)_
|
|
1178
1178
|
|
|
1179
1179
|
## `sf org open authoring-bundle`
|
|
1180
1180
|
|
|
@@ -1220,7 +1220,7 @@ EXAMPLES
|
|
|
1220
1220
|
$ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
|
|
1221
1221
|
```
|
|
1222
1222
|
|
|
1223
|
-
_See code: [src/commands/org/open/authoring-bundle.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
1223
|
+
_See code: [src/commands/org/open/authoring-bundle.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/open/authoring-bundle.ts)_
|
|
1224
1224
|
|
|
1225
1225
|
## `sf org refresh sandbox`
|
|
1226
1226
|
|
|
@@ -1323,7 +1323,7 @@ FLAG DESCRIPTIONS
|
|
|
1323
1323
|
You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
|
|
1324
1324
|
```
|
|
1325
1325
|
|
|
1326
|
-
_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
1326
|
+
_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/refresh/sandbox.ts)_
|
|
1327
1327
|
|
|
1328
1328
|
## `sf org resume sandbox`
|
|
1329
1329
|
|
|
@@ -1386,7 +1386,7 @@ FLAG DESCRIPTIONS
|
|
|
1386
1386
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
1387
1387
|
```
|
|
1388
1388
|
|
|
1389
|
-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
1389
|
+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/resume/sandbox.ts)_
|
|
1390
1390
|
|
|
1391
1391
|
## `sf org resume scratch`
|
|
1392
1392
|
|
|
@@ -1439,6 +1439,6 @@ FLAG DESCRIPTIONS
|
|
|
1439
1439
|
returns the job ID. To resume checking the scratch creation, rerun this command.
|
|
1440
1440
|
```
|
|
1441
1441
|
|
|
1442
|
-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.
|
|
1442
|
+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.11.3/src/commands/org/resume/scratch.ts)_
|
|
1443
1443
|
|
|
1444
1444
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
|
@@ -1957,157 +1957,6 @@
|
|
|
1957
1957
|
"authoring-bundle:open:org"
|
|
1958
1958
|
]
|
|
1959
1959
|
},
|
|
1960
|
-
"org:refresh:sandbox": {
|
|
1961
|
-
"aliases": [],
|
|
1962
|
-
"args": {},
|
|
1963
|
-
"description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
|
|
1964
|
-
"examples": [
|
|
1965
|
-
"Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
|
|
1966
|
-
"Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
|
|
1967
|
-
"Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg",
|
|
1968
|
-
"Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
|
|
1969
|
-
],
|
|
1970
|
-
"flags": {
|
|
1971
|
-
"json": {
|
|
1972
|
-
"description": "Format output as json.",
|
|
1973
|
-
"helpGroup": "GLOBAL",
|
|
1974
|
-
"name": "json",
|
|
1975
|
-
"allowNo": false,
|
|
1976
|
-
"type": "boolean"
|
|
1977
|
-
},
|
|
1978
|
-
"flags-dir": {
|
|
1979
|
-
"helpGroup": "GLOBAL",
|
|
1980
|
-
"name": "flags-dir",
|
|
1981
|
-
"summary": "Import flag values from a directory.",
|
|
1982
|
-
"hasDynamicHelp": false,
|
|
1983
|
-
"multiple": false,
|
|
1984
|
-
"type": "option"
|
|
1985
|
-
},
|
|
1986
|
-
"no-auto-activate": {
|
|
1987
|
-
"description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
|
|
1988
|
-
"name": "no-auto-activate",
|
|
1989
|
-
"summary": "Disable auto-activation of the sandbox after a successful refresh.",
|
|
1990
|
-
"allowNo": false,
|
|
1991
|
-
"type": "boolean"
|
|
1992
|
-
},
|
|
1993
|
-
"wait": {
|
|
1994
|
-
"char": "w",
|
|
1995
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
|
|
1996
|
-
"exclusive": [
|
|
1997
|
-
"async"
|
|
1998
|
-
],
|
|
1999
|
-
"name": "wait",
|
|
2000
|
-
"summary": "Number of minutes to poll for sandbox refresh status.",
|
|
2001
|
-
"hasDynamicHelp": true,
|
|
2002
|
-
"helpValue": "<minutes>",
|
|
2003
|
-
"multiple": false,
|
|
2004
|
-
"type": "option"
|
|
2005
|
-
},
|
|
2006
|
-
"poll-interval": {
|
|
2007
|
-
"char": "i",
|
|
2008
|
-
"exclusive": [
|
|
2009
|
-
"async"
|
|
2010
|
-
],
|
|
2011
|
-
"name": "poll-interval",
|
|
2012
|
-
"summary": "Number of seconds to wait between status polling requests.",
|
|
2013
|
-
"hasDynamicHelp": true,
|
|
2014
|
-
"helpValue": "<seconds>",
|
|
2015
|
-
"multiple": false,
|
|
2016
|
-
"type": "option"
|
|
2017
|
-
},
|
|
2018
|
-
"source-sandbox-name": {
|
|
2019
|
-
"description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
|
|
2020
|
-
"exclusive": [
|
|
2021
|
-
"source-id"
|
|
2022
|
-
],
|
|
2023
|
-
"name": "source-sandbox-name",
|
|
2024
|
-
"summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
2025
|
-
"hasDynamicHelp": false,
|
|
2026
|
-
"multiple": false,
|
|
2027
|
-
"type": "option"
|
|
2028
|
-
},
|
|
2029
|
-
"source-id": {
|
|
2030
|
-
"description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
|
|
2031
|
-
"exclusive": [
|
|
2032
|
-
"source-sandbox-name"
|
|
2033
|
-
],
|
|
2034
|
-
"name": "source-id",
|
|
2035
|
-
"summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
2036
|
-
"hasDynamicHelp": false,
|
|
2037
|
-
"multiple": false,
|
|
2038
|
-
"type": "option"
|
|
2039
|
-
},
|
|
2040
|
-
"async": {
|
|
2041
|
-
"description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
|
|
2042
|
-
"exclusive": [
|
|
2043
|
-
"wait",
|
|
2044
|
-
"poll-interval"
|
|
2045
|
-
],
|
|
2046
|
-
"name": "async",
|
|
2047
|
-
"summary": "Request the sandbox refresh, but don't wait for it to complete.",
|
|
2048
|
-
"allowNo": false,
|
|
2049
|
-
"type": "boolean"
|
|
2050
|
-
},
|
|
2051
|
-
"name": {
|
|
2052
|
-
"char": "n",
|
|
2053
|
-
"name": "name",
|
|
2054
|
-
"summary": "Name of the existing sandbox org in your production org that you want to refresh.",
|
|
2055
|
-
"hasDynamicHelp": false,
|
|
2056
|
-
"multiple": false,
|
|
2057
|
-
"type": "option"
|
|
2058
|
-
},
|
|
2059
|
-
"definition-file": {
|
|
2060
|
-
"char": "f",
|
|
2061
|
-
"description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
|
|
2062
|
-
"name": "definition-file",
|
|
2063
|
-
"summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
|
|
2064
|
-
"hasDynamicHelp": false,
|
|
2065
|
-
"multiple": false,
|
|
2066
|
-
"type": "option"
|
|
2067
|
-
},
|
|
2068
|
-
"target-org": {
|
|
2069
|
-
"char": "o",
|
|
2070
|
-
"name": "target-org",
|
|
2071
|
-
"noCacheDefault": true,
|
|
2072
|
-
"required": true,
|
|
2073
|
-
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
2074
|
-
"hasDynamicHelp": true,
|
|
2075
|
-
"multiple": false,
|
|
2076
|
-
"type": "option"
|
|
2077
|
-
},
|
|
2078
|
-
"no-prompt": {
|
|
2079
|
-
"name": "no-prompt",
|
|
2080
|
-
"summary": "Don't prompt for confirmation about the sandbox refresh.",
|
|
2081
|
-
"allowNo": false,
|
|
2082
|
-
"type": "boolean"
|
|
2083
|
-
}
|
|
2084
|
-
},
|
|
2085
|
-
"hasDynamicHelp": true,
|
|
2086
|
-
"hiddenAliases": [],
|
|
2087
|
-
"id": "org:refresh:sandbox",
|
|
2088
|
-
"pluginAlias": "@salesforce/plugin-org",
|
|
2089
|
-
"pluginName": "@salesforce/plugin-org",
|
|
2090
|
-
"pluginType": "core",
|
|
2091
|
-
"strict": true,
|
|
2092
|
-
"summary": "Refresh a sandbox org using the sandbox name.",
|
|
2093
|
-
"isESM": true,
|
|
2094
|
-
"relativePath": [
|
|
2095
|
-
"lib",
|
|
2096
|
-
"commands",
|
|
2097
|
-
"org",
|
|
2098
|
-
"refresh",
|
|
2099
|
-
"sandbox.js"
|
|
2100
|
-
],
|
|
2101
|
-
"aliasPermutations": [],
|
|
2102
|
-
"permutations": [
|
|
2103
|
-
"org:refresh:sandbox",
|
|
2104
|
-
"refresh:org:sandbox",
|
|
2105
|
-
"refresh:sandbox:org",
|
|
2106
|
-
"org:sandbox:refresh",
|
|
2107
|
-
"sandbox:org:refresh",
|
|
2108
|
-
"sandbox:refresh:org"
|
|
2109
|
-
]
|
|
2110
|
-
},
|
|
2111
1960
|
"org:resume:sandbox": {
|
|
2112
1961
|
"aliases": [
|
|
2113
1962
|
"env:resume:sandbox"
|
|
@@ -2309,7 +2158,158 @@
|
|
|
2309
2158
|
"scratch:org:resume",
|
|
2310
2159
|
"scratch:resume:org"
|
|
2311
2160
|
]
|
|
2161
|
+
},
|
|
2162
|
+
"org:refresh:sandbox": {
|
|
2163
|
+
"aliases": [],
|
|
2164
|
+
"args": {},
|
|
2165
|
+
"description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
|
|
2166
|
+
"examples": [
|
|
2167
|
+
"Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
|
|
2168
|
+
"Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
|
|
2169
|
+
"Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg",
|
|
2170
|
+
"Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
|
|
2171
|
+
],
|
|
2172
|
+
"flags": {
|
|
2173
|
+
"json": {
|
|
2174
|
+
"description": "Format output as json.",
|
|
2175
|
+
"helpGroup": "GLOBAL",
|
|
2176
|
+
"name": "json",
|
|
2177
|
+
"allowNo": false,
|
|
2178
|
+
"type": "boolean"
|
|
2179
|
+
},
|
|
2180
|
+
"flags-dir": {
|
|
2181
|
+
"helpGroup": "GLOBAL",
|
|
2182
|
+
"name": "flags-dir",
|
|
2183
|
+
"summary": "Import flag values from a directory.",
|
|
2184
|
+
"hasDynamicHelp": false,
|
|
2185
|
+
"multiple": false,
|
|
2186
|
+
"type": "option"
|
|
2187
|
+
},
|
|
2188
|
+
"no-auto-activate": {
|
|
2189
|
+
"description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
|
|
2190
|
+
"name": "no-auto-activate",
|
|
2191
|
+
"summary": "Disable auto-activation of the sandbox after a successful refresh.",
|
|
2192
|
+
"allowNo": false,
|
|
2193
|
+
"type": "boolean"
|
|
2194
|
+
},
|
|
2195
|
+
"wait": {
|
|
2196
|
+
"char": "w",
|
|
2197
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
|
|
2198
|
+
"exclusive": [
|
|
2199
|
+
"async"
|
|
2200
|
+
],
|
|
2201
|
+
"name": "wait",
|
|
2202
|
+
"summary": "Number of minutes to poll for sandbox refresh status.",
|
|
2203
|
+
"hasDynamicHelp": true,
|
|
2204
|
+
"helpValue": "<minutes>",
|
|
2205
|
+
"multiple": false,
|
|
2206
|
+
"type": "option"
|
|
2207
|
+
},
|
|
2208
|
+
"poll-interval": {
|
|
2209
|
+
"char": "i",
|
|
2210
|
+
"exclusive": [
|
|
2211
|
+
"async"
|
|
2212
|
+
],
|
|
2213
|
+
"name": "poll-interval",
|
|
2214
|
+
"summary": "Number of seconds to wait between status polling requests.",
|
|
2215
|
+
"hasDynamicHelp": true,
|
|
2216
|
+
"helpValue": "<seconds>",
|
|
2217
|
+
"multiple": false,
|
|
2218
|
+
"type": "option"
|
|
2219
|
+
},
|
|
2220
|
+
"source-sandbox-name": {
|
|
2221
|
+
"description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
|
|
2222
|
+
"exclusive": [
|
|
2223
|
+
"source-id"
|
|
2224
|
+
],
|
|
2225
|
+
"name": "source-sandbox-name",
|
|
2226
|
+
"summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
2227
|
+
"hasDynamicHelp": false,
|
|
2228
|
+
"multiple": false,
|
|
2229
|
+
"type": "option"
|
|
2230
|
+
},
|
|
2231
|
+
"source-id": {
|
|
2232
|
+
"description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
|
|
2233
|
+
"exclusive": [
|
|
2234
|
+
"source-sandbox-name"
|
|
2235
|
+
],
|
|
2236
|
+
"name": "source-id",
|
|
2237
|
+
"summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
2238
|
+
"hasDynamicHelp": false,
|
|
2239
|
+
"multiple": false,
|
|
2240
|
+
"type": "option"
|
|
2241
|
+
},
|
|
2242
|
+
"async": {
|
|
2243
|
+
"description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
|
|
2244
|
+
"exclusive": [
|
|
2245
|
+
"wait",
|
|
2246
|
+
"poll-interval"
|
|
2247
|
+
],
|
|
2248
|
+
"name": "async",
|
|
2249
|
+
"summary": "Request the sandbox refresh, but don't wait for it to complete.",
|
|
2250
|
+
"allowNo": false,
|
|
2251
|
+
"type": "boolean"
|
|
2252
|
+
},
|
|
2253
|
+
"name": {
|
|
2254
|
+
"char": "n",
|
|
2255
|
+
"name": "name",
|
|
2256
|
+
"summary": "Name of the existing sandbox org in your production org that you want to refresh.",
|
|
2257
|
+
"hasDynamicHelp": false,
|
|
2258
|
+
"multiple": false,
|
|
2259
|
+
"type": "option"
|
|
2260
|
+
},
|
|
2261
|
+
"definition-file": {
|
|
2262
|
+
"char": "f",
|
|
2263
|
+
"description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
|
|
2264
|
+
"name": "definition-file",
|
|
2265
|
+
"summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
|
|
2266
|
+
"hasDynamicHelp": false,
|
|
2267
|
+
"multiple": false,
|
|
2268
|
+
"type": "option"
|
|
2269
|
+
},
|
|
2270
|
+
"target-org": {
|
|
2271
|
+
"char": "o",
|
|
2272
|
+
"name": "target-org",
|
|
2273
|
+
"noCacheDefault": true,
|
|
2274
|
+
"required": true,
|
|
2275
|
+
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
2276
|
+
"hasDynamicHelp": true,
|
|
2277
|
+
"multiple": false,
|
|
2278
|
+
"type": "option"
|
|
2279
|
+
},
|
|
2280
|
+
"no-prompt": {
|
|
2281
|
+
"name": "no-prompt",
|
|
2282
|
+
"summary": "Don't prompt for confirmation about the sandbox refresh.",
|
|
2283
|
+
"allowNo": false,
|
|
2284
|
+
"type": "boolean"
|
|
2285
|
+
}
|
|
2286
|
+
},
|
|
2287
|
+
"hasDynamicHelp": true,
|
|
2288
|
+
"hiddenAliases": [],
|
|
2289
|
+
"id": "org:refresh:sandbox",
|
|
2290
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
2291
|
+
"pluginName": "@salesforce/plugin-org",
|
|
2292
|
+
"pluginType": "core",
|
|
2293
|
+
"strict": true,
|
|
2294
|
+
"summary": "Refresh a sandbox org using the sandbox name.",
|
|
2295
|
+
"isESM": true,
|
|
2296
|
+
"relativePath": [
|
|
2297
|
+
"lib",
|
|
2298
|
+
"commands",
|
|
2299
|
+
"org",
|
|
2300
|
+
"refresh",
|
|
2301
|
+
"sandbox.js"
|
|
2302
|
+
],
|
|
2303
|
+
"aliasPermutations": [],
|
|
2304
|
+
"permutations": [
|
|
2305
|
+
"org:refresh:sandbox",
|
|
2306
|
+
"refresh:org:sandbox",
|
|
2307
|
+
"refresh:sandbox:org",
|
|
2308
|
+
"org:sandbox:refresh",
|
|
2309
|
+
"sandbox:org:refresh",
|
|
2310
|
+
"sandbox:refresh:org"
|
|
2311
|
+
]
|
|
2312
2312
|
}
|
|
2313
2313
|
},
|
|
2314
|
-
"version": "5.11.
|
|
2314
|
+
"version": "5.11.3"
|
|
2315
2315
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-org",
|
|
3
3
|
"description": "Commands to interact with Salesforce orgs",
|
|
4
|
-
"version": "5.11.
|
|
4
|
+
"version": "5.11.3",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"enableO11y": true,
|
|
@@ -233,7 +233,7 @@
|
|
|
233
233
|
"exports": "./lib/index.js",
|
|
234
234
|
"type": "module",
|
|
235
235
|
"sfdx": {
|
|
236
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.11.
|
|
237
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.11.
|
|
236
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.11.3.crt",
|
|
237
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.11.3.sig"
|
|
238
238
|
}
|
|
239
239
|
}
|