@salesforce/plugin-org 2.11.8 → 3.0.2
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 +117 -115
- package/lib/commands/force/org/clone.d.ts +8 -8
- package/lib/commands/force/org/clone.js +65 -66
- package/lib/commands/force/org/clone.js.map +1 -1
- package/lib/commands/force/org/create.d.ts +18 -42
- package/lib/commands/force/org/create.js +104 -106
- package/lib/commands/force/org/create.js.map +1 -1
- package/lib/commands/force/org/delete.d.ts +5 -5
- package/lib/commands/force/org/delete.js +42 -44
- package/lib/commands/force/org/delete.js.map +1 -1
- package/lib/commands/force/org/status.d.ts +7 -7
- package/lib/commands/force/org/status.js +48 -50
- package/lib/commands/force/org/status.js.map +1 -1
- package/lib/commands/org/create/sandbox.d.ts +11 -11
- package/lib/commands/org/create/sandbox.js +106 -106
- package/lib/commands/org/create/sandbox.js.map +1 -1
- package/lib/commands/org/create/scratch.d.ts +20 -20
- package/lib/commands/org/create/scratch.js +140 -142
- package/lib/commands/org/create/scratch.js.map +1 -1
- package/lib/commands/org/delete/sandbox.d.ts +3 -3
- package/lib/commands/org/delete/sandbox.js +46 -31
- package/lib/commands/org/delete/sandbox.js.map +1 -1
- package/lib/commands/org/delete/scratch.d.ts +3 -3
- package/lib/commands/org/delete/scratch.js +27 -28
- package/lib/commands/org/delete/scratch.js.map +1 -1
- package/lib/commands/org/display.d.ts +5 -5
- package/lib/commands/org/display.js +33 -34
- package/lib/commands/org/display.js.map +1 -1
- package/lib/commands/org/list/metadata-types.d.ts +5 -5
- package/lib/commands/org/list/metadata-types.js +38 -40
- package/lib/commands/org/list/metadata-types.js.map +1 -1
- package/lib/commands/org/list/metadata.d.ts +6 -6
- package/lib/commands/org/list/metadata.js +39 -41
- package/lib/commands/org/list/metadata.js.map +1 -1
- package/lib/commands/org/list.d.ts +2 -2
- package/lib/commands/org/list.js +56 -57
- package/lib/commands/org/list.js.map +1 -1
- package/lib/commands/org/open.d.ts +7 -7
- package/lib/commands/org/open.js +61 -61
- package/lib/commands/org/open.js.map +1 -1
- package/lib/commands/org/resume/sandbox.d.ts +6 -6
- package/lib/commands/org/resume/sandbox.js +61 -61
- package/lib/commands/org/resume/sandbox.js.map +1 -1
- package/lib/commands/org/resume/scratch.d.ts +3 -3
- package/lib/commands/org/resume/scratch.js +35 -36
- package/lib/commands/org/resume/scratch.js.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +1 -2
- package/lib/index.js.map +1 -1
- package/lib/shared/flags.d.ts +4 -1
- package/lib/shared/flags.js +10 -11
- package/lib/shared/flags.js.map +1 -1
- package/lib/shared/orgHighlighter.d.ts +1 -1
- package/lib/shared/orgHighlighter.js +4 -9
- package/lib/shared/orgHighlighter.js.map +1 -1
- package/lib/shared/orgHooks.js +1 -2
- package/lib/shared/orgHooks.js.map +1 -1
- package/lib/shared/orgListUtil.d.ts +1 -1
- package/lib/shared/orgListUtil.js +27 -31
- package/lib/shared/orgListUtil.js.map +1 -1
- package/lib/shared/orgTypes.js +2 -5
- package/lib/shared/orgTypes.js.map +1 -1
- package/lib/shared/sandboxCommandBase.d.ts +2 -2
- package/lib/shared/sandboxCommandBase.js +33 -28
- package/lib/shared/sandboxCommandBase.js.map +1 -1
- package/lib/shared/sandboxProgress.d.ts +1 -1
- package/lib/shared/sandboxProgress.js +11 -17
- package/lib/shared/sandboxProgress.js.map +1 -1
- package/lib/shared/sandboxReporter.d.ts +0 -1
- package/lib/shared/sandboxReporter.js +3 -16
- package/lib/shared/sandboxReporter.js.map +1 -1
- package/lib/shared/sandboxRequest.d.ts +5 -0
- package/lib/shared/sandboxRequest.js +21 -20
- package/lib/shared/sandboxRequest.js.map +1 -1
- package/lib/shared/scratchOrgOutput.js +20 -31
- package/lib/shared/scratchOrgOutput.js.map +1 -1
- package/lib/shared/scratchOrgRequest.d.ts +1 -1
- package/lib/shared/scratchOrgRequest.js +4 -8
- package/lib/shared/scratchOrgRequest.js.map +1 -1
- package/lib/shared/stagedProgress.d.ts +1 -1
- package/lib/shared/stagedProgress.js +19 -19
- package/lib/shared/stagedProgress.js.map +1 -1
- package/lib/shared/timeUtils.js +10 -16
- package/lib/shared/timeUtils.js.map +1 -1
- package/lib/shared/utils.d.ts +9 -2
- package/lib/shared/utils.js +13 -14
- package/lib/shared/utils.js.map +1 -1
- package/messages/delete_sandbox.md +9 -3
- package/oclif.lock +8460 -0
- package/oclif.manifest.json +1090 -688
- package/package.json +26 -23
package/README.md
CHANGED
|
@@ -99,29 +99,29 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
|
|
|
99
99
|
|
|
100
100
|
<!-- commands -->
|
|
101
101
|
|
|
102
|
-
- [`sf force
|
|
103
|
-
- [`sf force
|
|
104
|
-
- [`sf force
|
|
105
|
-
- [`sf force
|
|
106
|
-
- [`sf org
|
|
107
|
-
- [`sf org
|
|
108
|
-
- [`sf org
|
|
109
|
-
- [`sf org
|
|
110
|
-
- [`sf org
|
|
111
|
-
- [`sf org
|
|
112
|
-
- [`sf org
|
|
113
|
-
- [`sf org
|
|
114
|
-
- [`sf org
|
|
115
|
-
- [`sf org
|
|
116
|
-
- [`sf org
|
|
117
|
-
|
|
118
|
-
## `sf force
|
|
102
|
+
- [`sf force org clone`](#sf-force-org-clone)
|
|
103
|
+
- [`sf force org create`](#sf-force-org-create)
|
|
104
|
+
- [`sf force org delete`](#sf-force-org-delete)
|
|
105
|
+
- [`sf force org status`](#sf-force-org-status)
|
|
106
|
+
- [`sf org create sandbox`](#sf-org-create-sandbox)
|
|
107
|
+
- [`sf org create scratch`](#sf-org-create-scratch)
|
|
108
|
+
- [`sf org delete sandbox`](#sf-org-delete-sandbox)
|
|
109
|
+
- [`sf org delete scratch`](#sf-org-delete-scratch)
|
|
110
|
+
- [`sf org display`](#sf-org-display)
|
|
111
|
+
- [`sf org list`](#sf-org-list)
|
|
112
|
+
- [`sf org list metadata`](#sf-org-list-metadata)
|
|
113
|
+
- [`sf org list metadata-types`](#sf-org-list-metadata-types)
|
|
114
|
+
- [`sf org open`](#sf-org-open)
|
|
115
|
+
- [`sf org resume sandbox`](#sf-org-resume-sandbox)
|
|
116
|
+
- [`sf org resume scratch`](#sf-org-resume-scratch)
|
|
117
|
+
|
|
118
|
+
## `sf force org clone`
|
|
119
119
|
|
|
120
120
|
Clone a sandbox org.
|
|
121
121
|
|
|
122
122
|
```
|
|
123
123
|
USAGE
|
|
124
|
-
$ sf force
|
|
124
|
+
$ sf force org clone -o <value> -t sandbox [--json] [--api-version <value>] [-f <value>] [-s] [-a <value>] [-w
|
|
125
125
|
<value>]
|
|
126
126
|
|
|
127
127
|
FLAGS
|
|
@@ -149,9 +149,9 @@ DESCRIPTION
|
|
|
149
149
|
required and must be set to "sandbox".
|
|
150
150
|
|
|
151
151
|
EXAMPLES
|
|
152
|
-
$ sf force
|
|
152
|
+
$ sf force org clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
|
|
153
153
|
|
|
154
|
-
$ sf force
|
|
154
|
+
$ sf force org clone -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
|
|
155
155
|
|
|
156
156
|
FLAG DESCRIPTIONS
|
|
157
157
|
-w, --wait=<value> Number of minutes to wait while polling for status.
|
|
@@ -160,15 +160,15 @@ FLAG DESCRIPTIONS
|
|
|
160
160
|
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
|
|
161
161
|
```
|
|
162
162
|
|
|
163
|
-
_See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
163
|
+
_See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/clone.ts)_
|
|
164
164
|
|
|
165
|
-
## `sf force
|
|
165
|
+
## `sf force org create`
|
|
166
166
|
|
|
167
167
|
Create a scratch org or sandbox.
|
|
168
168
|
|
|
169
169
|
```
|
|
170
170
|
USAGE
|
|
171
|
-
$ sf force
|
|
171
|
+
$ sf force org create [--json] [-o <value>] [-v <value>] [--api-version <value>] [-t scratch|sandbox] [-f <value>]
|
|
172
172
|
[-n] [-c] [-i <value>] [-s] [-a <value>] [-w <value>] [-d <value>]
|
|
173
173
|
|
|
174
174
|
FLAGS
|
|
@@ -199,24 +199,24 @@ DESCRIPTION
|
|
|
199
199
|
production org with sandbox licenses. The —type (-t) is required if creating a sandbox.
|
|
200
200
|
|
|
201
201
|
EXAMPLES
|
|
202
|
-
$ sf force
|
|
202
|
+
$ sf force org create -f config/enterprise-scratch-def.json -a MyScratchOrg
|
|
203
203
|
|
|
204
|
-
$ sf force
|
|
204
|
+
$ sf force org create edition=Developer -a MyScratchOrg -s -v devHub
|
|
205
205
|
|
|
206
|
-
$ sf force
|
|
206
|
+
$ sf force org create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org
|
|
207
207
|
|
|
208
|
-
$ sf force
|
|
208
|
+
$ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
|
|
209
209
|
```
|
|
210
210
|
|
|
211
|
-
_See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
211
|
+
_See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/create.ts)_
|
|
212
212
|
|
|
213
|
-
## `sf force
|
|
213
|
+
## `sf force org delete`
|
|
214
214
|
|
|
215
215
|
Delete a scratch or sandbox org.
|
|
216
216
|
|
|
217
217
|
```
|
|
218
218
|
USAGE
|
|
219
|
-
$ sf force
|
|
219
|
+
$ sf force org delete -o <value> [--json] [--api-version <value>] [-p]
|
|
220
220
|
|
|
221
221
|
FLAGS
|
|
222
222
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
@@ -235,20 +235,20 @@ DESCRIPTION
|
|
|
235
235
|
To mark the org for deletion without being prompted to confirm, specify --noprompt.
|
|
236
236
|
|
|
237
237
|
EXAMPLES
|
|
238
|
-
$ sf force
|
|
238
|
+
$ sf force org delete -u me@my.org
|
|
239
239
|
|
|
240
|
-
$ sf force
|
|
240
|
+
$ sf force org delete -u MyOrgAlias -p
|
|
241
241
|
```
|
|
242
242
|
|
|
243
|
-
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
243
|
+
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/delete.ts)_
|
|
244
244
|
|
|
245
|
-
## `sf force
|
|
245
|
+
## `sf force org status`
|
|
246
246
|
|
|
247
247
|
Check the status of a sandbox, and if complete, authenticate to it.
|
|
248
248
|
|
|
249
249
|
```
|
|
250
250
|
USAGE
|
|
251
|
-
$ sf force
|
|
251
|
+
$ sf force org status -o <value> -n <value> [--json] [--api-version <value>] [-s] [-a <value>] [-w <value>]
|
|
252
252
|
|
|
253
253
|
FLAGS
|
|
254
254
|
-a, --setalias=<value> Alias for the created or cloned org.
|
|
@@ -273,20 +273,20 @@ DESCRIPTION
|
|
|
273
273
|
Set the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.
|
|
274
274
|
|
|
275
275
|
EXAMPLES
|
|
276
|
-
$ sf force
|
|
276
|
+
$ sf force org status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg
|
|
277
277
|
|
|
278
|
-
$ sf force
|
|
278
|
+
$ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
|
|
279
279
|
```
|
|
280
280
|
|
|
281
|
-
_See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
281
|
+
_See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/force/org/status.ts)_
|
|
282
282
|
|
|
283
|
-
## `sf org
|
|
283
|
+
## `sf org create sandbox`
|
|
284
284
|
|
|
285
285
|
Create a sandbox org.
|
|
286
286
|
|
|
287
287
|
```
|
|
288
288
|
USAGE
|
|
289
|
-
$ sf org
|
|
289
|
+
$ sf org create sandbox -o <value> [--json] [-f <value> | -n <value> | -l Developer|Developer_Pro|Partial|Full] [-s]
|
|
290
290
|
[-a <value>] [-w <value> | --async] [-i <value> | ] [-c <value> | ] [--no-prompt] [--no-track-source]
|
|
291
291
|
|
|
292
292
|
FLAGS
|
|
@@ -315,18 +315,18 @@ DESCRIPTION
|
|
|
315
315
|
license type, such as apexClassId, you must use a definition file.
|
|
316
316
|
|
|
317
317
|
ALIASES
|
|
318
|
-
$ sf env
|
|
318
|
+
$ sf env create sandbox
|
|
319
319
|
|
|
320
320
|
EXAMPLES
|
|
321
321
|
Create a sandbox org using a definition file and give it the alias "MyDevSandbox". The production org that contains
|
|
322
322
|
the sandbox license has the alias "prodOrg".
|
|
323
323
|
|
|
324
|
-
$ sf org
|
|
324
|
+
$ sf org create sandbox -f config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg
|
|
325
325
|
|
|
326
326
|
Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition
|
|
327
327
|
file. Set the sandbox org as your default.
|
|
328
328
|
|
|
329
|
-
$ sf org
|
|
329
|
+
$ sf org create sandbox --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg \
|
|
330
330
|
--set-default
|
|
331
331
|
|
|
332
332
|
FLAG DESCRIPTIONS
|
|
@@ -383,15 +383,15 @@ FLAG DESCRIPTIONS
|
|
|
383
383
|
sandbox.
|
|
384
384
|
```
|
|
385
385
|
|
|
386
|
-
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
386
|
+
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/create/sandbox.ts)_
|
|
387
387
|
|
|
388
|
-
## `sf org
|
|
388
|
+
## `sf org create scratch`
|
|
389
389
|
|
|
390
390
|
Create a scratch org.
|
|
391
391
|
|
|
392
392
|
```
|
|
393
393
|
USAGE
|
|
394
|
-
$ sf org
|
|
394
|
+
$ sf org create scratch -v <value> [--json] [-a <value>] [--async] [-d] [-f <value>] [-c] [-e
|
|
395
395
|
developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
|
|
396
396
|
[-m] [-y <value>] [-w <value>] [--api-version <value>] [-i <value>] [-t] [--username <value>] [--description
|
|
397
397
|
<value>] [--name <value>] [--release preview|previous] [--admin-email <value>] [--source-org <value>]
|
|
@@ -458,22 +458,22 @@ DESCRIPTION
|
|
|
458
458
|
Dev Hub with the target-dev-hub configuration variable.
|
|
459
459
|
|
|
460
460
|
ALIASES
|
|
461
|
-
$ sf env
|
|
461
|
+
$ sf env create scratch
|
|
462
462
|
|
|
463
463
|
EXAMPLES
|
|
464
464
|
Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:
|
|
465
465
|
|
|
466
|
-
$ sf org
|
|
466
|
+
$ sf org create scratch --edition developer --alias my-scratch-org
|
|
467
467
|
|
|
468
468
|
Create a scratch org with a definition file. Specify the Dev Hub using its alias, set the scratch org as your
|
|
469
469
|
default, and specify that it expires in 3 days:
|
|
470
470
|
|
|
471
|
-
$ sf org
|
|
471
|
+
$ sf org create scratch --target-dev-hub MyHub --definition-file config/project-scratch-def.json --set-default \
|
|
472
472
|
--duration-days 3
|
|
473
473
|
|
|
474
474
|
Create a preview Enterprise edition scratch org; for use only during Salesforce release transition periods:
|
|
475
475
|
|
|
476
|
-
$ sf org
|
|
476
|
+
$ sf org create scratch --edition enterprise --alias my-scratch-org --target-dev-hub MyHub --release preview
|
|
477
477
|
|
|
478
478
|
FLAG DESCRIPTIONS
|
|
479
479
|
-a, --alias=<value> Alias for the scratch org.
|
|
@@ -536,15 +536,15 @@ FLAG DESCRIPTIONS
|
|
|
536
536
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
537
537
|
```
|
|
538
538
|
|
|
539
|
-
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
539
|
+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/create/scratch.ts)_
|
|
540
540
|
|
|
541
|
-
## `sf org
|
|
541
|
+
## `sf org delete sandbox`
|
|
542
542
|
|
|
543
543
|
Delete a sandbox.
|
|
544
544
|
|
|
545
545
|
```
|
|
546
546
|
USAGE
|
|
547
|
-
$ sf org
|
|
547
|
+
$ sf org delete sandbox -o <value> [--json] [-p]
|
|
548
548
|
|
|
549
549
|
FLAGS
|
|
550
550
|
-o, --target-org=<value> (required) Sandbox alias or login user.
|
|
@@ -560,33 +560,35 @@ DESCRIPTION
|
|
|
560
560
|
all local references to the org from your computer.
|
|
561
561
|
Specify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when
|
|
562
562
|
you created it. Run "sf org list" to view all your orgs, including sandboxes, and their aliases.
|
|
563
|
+
Both the sandbox and the associated production org must already be authenticated with the CLI to successfully delete
|
|
564
|
+
the sandbox.
|
|
563
565
|
|
|
564
566
|
ALIASES
|
|
565
|
-
$ sf env
|
|
567
|
+
$ sf env delete sandbox
|
|
566
568
|
|
|
567
569
|
EXAMPLES
|
|
568
570
|
Delete a sandbox with alias my-sandbox:
|
|
569
571
|
|
|
570
|
-
$ sf org
|
|
572
|
+
$ sf org delete sandbox --target-org my-sandbox
|
|
571
573
|
|
|
572
574
|
Specify a username instead of an alias:
|
|
573
575
|
|
|
574
|
-
$ sf org
|
|
576
|
+
$ sf org delete sandbox --target-org myusername@example.com.qa
|
|
575
577
|
|
|
576
|
-
Delete the sandbox without prompting to confirm
|
|
578
|
+
Delete the sandbox without prompting to confirm:
|
|
577
579
|
|
|
578
|
-
$ sf org
|
|
580
|
+
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
579
581
|
```
|
|
580
582
|
|
|
581
|
-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
583
|
+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/delete/sandbox.ts)_
|
|
582
584
|
|
|
583
|
-
## `sf org
|
|
585
|
+
## `sf org delete scratch`
|
|
584
586
|
|
|
585
587
|
Delete a scratch org.
|
|
586
588
|
|
|
587
589
|
```
|
|
588
590
|
USAGE
|
|
589
|
-
$ sf org
|
|
591
|
+
$ sf org delete scratch -o <value> [--json] [-p]
|
|
590
592
|
|
|
591
593
|
FLAGS
|
|
592
594
|
-o, --target-org=<value> (required) Scratch org alias or login user.
|
|
@@ -604,31 +606,31 @@ DESCRIPTION
|
|
|
604
606
|
list" to view all your orgs, including scratch orgs, and their aliases.
|
|
605
607
|
|
|
606
608
|
ALIASES
|
|
607
|
-
$ sf env
|
|
609
|
+
$ sf env delete scratch
|
|
608
610
|
|
|
609
611
|
EXAMPLES
|
|
610
612
|
Delete a scratch org with alias my-scratch-org:
|
|
611
613
|
|
|
612
|
-
$ sf org
|
|
614
|
+
$ sf org delete scratch --target-org my-scratch-org
|
|
613
615
|
|
|
614
616
|
Specify a username instead of an alias:
|
|
615
617
|
|
|
616
|
-
$ sf org
|
|
618
|
+
$ sf org delete scratch --target-org test-123456-abcdefg@example.com
|
|
617
619
|
|
|
618
620
|
Delete the scratch org without prompting to confirm :
|
|
619
621
|
|
|
620
|
-
$ sf org
|
|
622
|
+
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
621
623
|
```
|
|
622
624
|
|
|
623
|
-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
625
|
+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/delete/scratch.ts)_
|
|
624
626
|
|
|
625
|
-
## `sf org
|
|
627
|
+
## `sf org display`
|
|
626
628
|
|
|
627
629
|
Display information about an org.
|
|
628
630
|
|
|
629
631
|
```
|
|
630
632
|
USAGE
|
|
631
|
-
$ sf org
|
|
633
|
+
$ sf org display -o <value> [--json] [--api-version <value>] [--verbose]
|
|
632
634
|
|
|
633
635
|
FLAGS
|
|
634
636
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
@@ -651,27 +653,27 @@ DESCRIPTION
|
|
|
651
653
|
"org login jwt").
|
|
652
654
|
|
|
653
655
|
ALIASES
|
|
654
|
-
$ sf force
|
|
656
|
+
$ sf force org display
|
|
655
657
|
|
|
656
658
|
EXAMPLES
|
|
657
659
|
Display information about your default org:
|
|
658
660
|
|
|
659
|
-
$ sf org
|
|
661
|
+
$ sf org display
|
|
660
662
|
|
|
661
663
|
Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:
|
|
662
664
|
|
|
663
|
-
$ sf org
|
|
665
|
+
$ sf org display --target-org TestOrg1 --verbose
|
|
664
666
|
```
|
|
665
667
|
|
|
666
|
-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
668
|
+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/display.ts)_
|
|
667
669
|
|
|
668
|
-
## `sf org
|
|
670
|
+
## `sf org list`
|
|
669
671
|
|
|
670
672
|
List all orgs you’ve created or authenticated to.
|
|
671
673
|
|
|
672
674
|
```
|
|
673
675
|
USAGE
|
|
674
|
-
$ sf org
|
|
676
|
+
$ sf org list [--json] [--verbose] [--all] [-p --clean] [--skip-connection-status]
|
|
675
677
|
|
|
676
678
|
FLAGS
|
|
677
679
|
-p, --no-prompt Don't prompt for confirmation.
|
|
@@ -685,31 +687,31 @@ GLOBAL FLAGS
|
|
|
685
687
|
--json Format output as json.
|
|
686
688
|
|
|
687
689
|
ALIASES
|
|
688
|
-
$ sf force
|
|
690
|
+
$ sf force org list
|
|
689
691
|
|
|
690
692
|
EXAMPLES
|
|
691
693
|
List all orgs you've created or authenticated to:
|
|
692
694
|
|
|
693
|
-
$ sf org
|
|
695
|
+
$ sf org list
|
|
694
696
|
|
|
695
697
|
List all orgs, including expired, deleted, and unknown-status orgs; don't include the connection status:
|
|
696
698
|
|
|
697
|
-
$ sf org
|
|
699
|
+
$ sf org list --skip-connection-status --all
|
|
698
700
|
|
|
699
701
|
List orgs and remove local org authorization info about non-active scratch orgs:
|
|
700
702
|
|
|
701
|
-
$ sf org
|
|
703
|
+
$ sf org list --clean
|
|
702
704
|
```
|
|
703
705
|
|
|
704
|
-
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
706
|
+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/list.ts)_
|
|
705
707
|
|
|
706
|
-
## `sf org
|
|
708
|
+
## `sf org list metadata`
|
|
707
709
|
|
|
708
710
|
List the metadata components and properties of a specified type.
|
|
709
711
|
|
|
710
712
|
```
|
|
711
713
|
USAGE
|
|
712
|
-
$ sf org
|
|
714
|
+
$ sf org list metadata -o <value> -m <value> [--json] [--api-version <value>] [-f <value>] [--folder <value>]
|
|
713
715
|
|
|
714
716
|
FLAGS
|
|
715
717
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -735,22 +737,22 @@ DESCRIPTION
|
|
|
735
737
|
Functions permission.
|
|
736
738
|
|
|
737
739
|
ALIASES
|
|
738
|
-
$ sf force
|
|
740
|
+
$ sf force mdapi listmetadata
|
|
739
741
|
|
|
740
742
|
EXAMPLES
|
|
741
743
|
List the CustomObject components, and their properties, in the org with alias "my-dev-org":
|
|
742
744
|
|
|
743
|
-
$ sf org
|
|
745
|
+
$ sf org list metadata --metadata-type CustomObject --target-org my-dev-org
|
|
744
746
|
|
|
745
747
|
List the CustomObject components in your default org, write the output to the specified file, and use API version
|
|
746
748
|
57.0:
|
|
747
749
|
|
|
748
|
-
$ sf org
|
|
750
|
+
$ sf org list metadata --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt
|
|
749
751
|
|
|
750
752
|
List the Dashboard components in your default org that are contained in the "folderSales" folder, write the output
|
|
751
753
|
to the specified file, and use API version 57.0:
|
|
752
754
|
|
|
753
|
-
$ sf org
|
|
755
|
+
$ sf org list metadata --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file \
|
|
754
756
|
/path/to/outputfilename.txt
|
|
755
757
|
|
|
756
758
|
FLAG DESCRIPTIONS
|
|
@@ -765,15 +767,15 @@ FLAG DESCRIPTIONS
|
|
|
765
767
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
766
768
|
```
|
|
767
769
|
|
|
768
|
-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
770
|
+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/list/metadata.ts)_
|
|
769
771
|
|
|
770
|
-
## `sf org
|
|
772
|
+
## `sf org list metadata-types`
|
|
771
773
|
|
|
772
774
|
Display details about the metadata types that are enabled for your org.
|
|
773
775
|
|
|
774
776
|
```
|
|
775
777
|
USAGE
|
|
776
|
-
$ sf org
|
|
778
|
+
$ sf org list metadata-types -o <value> [--json] [--api-version <value>] [-f <value>]
|
|
777
779
|
|
|
778
780
|
FLAGS
|
|
779
781
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -794,18 +796,18 @@ DESCRIPTION
|
|
|
794
796
|
Functions permission.
|
|
795
797
|
|
|
796
798
|
ALIASES
|
|
797
|
-
$ sf force
|
|
799
|
+
$ sf force mdapi describemetadata
|
|
798
800
|
|
|
799
801
|
EXAMPLES
|
|
800
802
|
Display information about all known and enabled metadata types in the org with alias "my-dev-org" using API version
|
|
801
803
|
57.0:
|
|
802
804
|
|
|
803
|
-
$ sf org
|
|
805
|
+
$ sf org list metadata-types --api-version 57.0 --target-org my-dev-org
|
|
804
806
|
|
|
805
807
|
Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the
|
|
806
808
|
results to the specified file:
|
|
807
809
|
|
|
808
|
-
$ sf org
|
|
810
|
+
$ sf org list metadata-types --output-file /path/to/outputfilename.txt --filter-known
|
|
809
811
|
|
|
810
812
|
FLAG DESCRIPTIONS
|
|
811
813
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -818,15 +820,15 @@ FLAG DESCRIPTIONS
|
|
|
818
820
|
Override the api version used for api requests made by this command
|
|
819
821
|
```
|
|
820
822
|
|
|
821
|
-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
823
|
+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/list/metadata-types.ts)_
|
|
822
824
|
|
|
823
|
-
## `sf org
|
|
825
|
+
## `sf org open`
|
|
824
826
|
|
|
825
827
|
Open your default scratch org, or another specified org, in a browser.
|
|
826
828
|
|
|
827
829
|
```
|
|
828
830
|
USAGE
|
|
829
|
-
$ sf org
|
|
831
|
+
$ sf org open -o <value> [--json] [--api-version <value>] [-b chrome|edge|firefox | -r] [-p <value> | -f
|
|
830
832
|
<value>]
|
|
831
833
|
|
|
832
834
|
FLAGS
|
|
@@ -857,41 +859,41 @@ DESCRIPTION
|
|
|
857
859
|
don't specify --browser, the org opens in your default browser.
|
|
858
860
|
|
|
859
861
|
ALIASES
|
|
860
|
-
$ sf force
|
|
861
|
-
$ sf force
|
|
862
|
+
$ sf force org open
|
|
863
|
+
$ sf force source open
|
|
862
864
|
|
|
863
865
|
EXAMPLES
|
|
864
866
|
Open your default org in your default browser:
|
|
865
867
|
|
|
866
|
-
$ sf org
|
|
868
|
+
$ sf org open
|
|
867
869
|
|
|
868
870
|
Open the org with alias MyTestOrg1 in the Firefox browser:
|
|
869
871
|
|
|
870
|
-
$ sf org
|
|
872
|
+
$ sf org open --target-org MyTestOrg1 --browser firefox
|
|
871
873
|
|
|
872
874
|
Display the navigation URL for the Lightning Experience page for your default org, but don't open the page in a
|
|
873
875
|
browser:
|
|
874
876
|
|
|
875
|
-
$ sf org
|
|
877
|
+
$ sf org open --url-only --path lightning
|
|
876
878
|
|
|
877
879
|
Open a local Lightning page in your default org's Lightning App Builder:
|
|
878
880
|
|
|
879
|
-
$ sf org
|
|
881
|
+
$ sf org open --source-file force-app/main/default/flexipages/Hello.flexipage-meta.xml
|
|
880
882
|
|
|
881
883
|
Open a local Flow in Flow Builder:
|
|
882
884
|
|
|
883
|
-
$ sf org
|
|
885
|
+
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
884
886
|
```
|
|
885
887
|
|
|
886
|
-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
888
|
+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/open.ts)_
|
|
887
889
|
|
|
888
|
-
## `sf org
|
|
890
|
+
## `sf org resume sandbox`
|
|
889
891
|
|
|
890
892
|
Check the status of a sandbox creation, and log in to it if it's ready.
|
|
891
893
|
|
|
892
894
|
```
|
|
893
895
|
USAGE
|
|
894
|
-
$ sf org
|
|
896
|
+
$ sf org resume sandbox [--json] [-w <value>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
895
897
|
|
|
896
898
|
FLAGS
|
|
897
899
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
@@ -914,20 +916,20 @@ DESCRIPTION
|
|
|
914
916
|
recent sandbox creation.
|
|
915
917
|
|
|
916
918
|
ALIASES
|
|
917
|
-
$ sf env
|
|
919
|
+
$ sf env resume sandbox
|
|
918
920
|
|
|
919
921
|
EXAMPLES
|
|
920
922
|
Check the status of a sandbox creation using its name and specify a production org with alias "prodOrg":
|
|
921
923
|
|
|
922
|
-
$ sf org
|
|
924
|
+
$ sf org resume sandbox --name mysandbox --target-org prodOrg
|
|
923
925
|
|
|
924
926
|
Check the status using the job ID:
|
|
925
927
|
|
|
926
|
-
$ sf org
|
|
928
|
+
$ sf org resume sandbox --job-id 0GRxxxxxxxx
|
|
927
929
|
|
|
928
930
|
Check the status of the most recent sandbox create request:
|
|
929
931
|
|
|
930
|
-
$ sf org
|
|
932
|
+
$ sf org resume sandbox --use-most-recent
|
|
931
933
|
|
|
932
934
|
FLAG DESCRIPTIONS
|
|
933
935
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
@@ -945,15 +947,15 @@ FLAG DESCRIPTIONS
|
|
|
945
947
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
946
948
|
```
|
|
947
949
|
|
|
948
|
-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
950
|
+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/resume/sandbox.ts)_
|
|
949
951
|
|
|
950
|
-
## `sf org
|
|
952
|
+
## `sf org resume scratch`
|
|
951
953
|
|
|
952
954
|
Resume the creation of an incomplete scratch org.
|
|
953
955
|
|
|
954
956
|
```
|
|
955
957
|
USAGE
|
|
956
|
-
$ sf org
|
|
958
|
+
$ sf org resume scratch [--json] [-i <value>] [-r]
|
|
957
959
|
|
|
958
960
|
FLAGS
|
|
959
961
|
-i, --job-id=<value> Job ID of the incomplete scratch org create that you want to resume.
|
|
@@ -972,16 +974,16 @@ DESCRIPTION
|
|
|
972
974
|
incomplete scratch org.
|
|
973
975
|
|
|
974
976
|
ALIASES
|
|
975
|
-
$ sf env
|
|
977
|
+
$ sf env resume scratch
|
|
976
978
|
|
|
977
979
|
EXAMPLES
|
|
978
980
|
Resume a scratch org create with a job ID:
|
|
979
981
|
|
|
980
|
-
$ sf org
|
|
982
|
+
$ sf org resume scratch --job-id 2SR3u0000008fBDGAY
|
|
981
983
|
|
|
982
984
|
Resume your most recent incomplete scratch org:
|
|
983
985
|
|
|
984
|
-
$ sf org
|
|
986
|
+
$ sf org resume scratch --use-most-recent
|
|
985
987
|
|
|
986
988
|
FLAG DESCRIPTIONS
|
|
987
989
|
-i, --job-id=<value> Job ID of the incomplete scratch org create that you want to resume.
|
|
@@ -991,6 +993,6 @@ FLAG DESCRIPTIONS
|
|
|
991
993
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
992
994
|
```
|
|
993
995
|
|
|
994
|
-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
996
|
+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.2/src/commands/org/resume/scratch.ts)_
|
|
995
997
|
|
|
996
998
|
<!-- commandsstop -->
|
|
@@ -12,14 +12,14 @@ export declare class OrgCloneCommand extends SfCommand<SandboxProcessObject> {
|
|
|
12
12
|
};
|
|
13
13
|
static readonly SANDBOXDEF_SRC_SANDBOXNAME = "SourceSandboxName";
|
|
14
14
|
static readonly flags: {
|
|
15
|
-
'target-org': import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
16
|
-
'api-version': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
17
|
-
type: import("@oclif/core/lib/interfaces").OptionFlag<"sandbox", import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
18
|
-
definitionfile: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
19
|
-
setdefaultusername: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
|
|
20
|
-
setalias: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
21
|
-
wait: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/kit").Duration
|
|
22
|
-
loglevel: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
15
|
+
'target-org': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
|
|
16
|
+
'api-version': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
|
|
17
|
+
type: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<"sandbox", import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
|
|
18
|
+
definitionfile: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
|
|
19
|
+
setdefaultusername: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
|
|
20
|
+
setalias: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
|
|
21
|
+
wait: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<import("@salesforce/kit").Duration, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
|
|
22
|
+
loglevel: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
|
|
23
23
|
};
|
|
24
24
|
private logger;
|
|
25
25
|
run(): Promise<SandboxProcessObject>;
|