@salesforce/plugin-org 2.11.7 → 3.0.1
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 +114 -114
- 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 +2 -2
- package/lib/commands/org/delete/sandbox.js +27 -28
- package/lib/commands/org/delete/sandbox.js.map +1 -1
- package/lib/commands/org/delete/scratch.d.ts +2 -2
- package/lib/commands/org/delete/scratch.js +26 -27
- 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 +65 -62
- 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.js +5 -9
- 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/oclif.lock +7993 -0
- package/oclif.manifest.json +1089 -687
- package/package.json +34 -53
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/2.11.
|
|
163
|
+
_See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/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/2.11.
|
|
211
|
+
_See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/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/2.11.
|
|
243
|
+
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/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/2.11.
|
|
281
|
+
_See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/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/2.11.
|
|
386
|
+
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/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/2.11.
|
|
539
|
+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/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.
|
|
@@ -562,31 +562,31 @@ DESCRIPTION
|
|
|
562
562
|
you created it. Run "sf org list" to view all your orgs, including sandboxes, and their aliases.
|
|
563
563
|
|
|
564
564
|
ALIASES
|
|
565
|
-
$ sf env
|
|
565
|
+
$ sf env delete sandbox
|
|
566
566
|
|
|
567
567
|
EXAMPLES
|
|
568
568
|
Delete a sandbox with alias my-sandbox:
|
|
569
569
|
|
|
570
|
-
$ sf org
|
|
570
|
+
$ sf org delete sandbox --target-org my-sandbox
|
|
571
571
|
|
|
572
572
|
Specify a username instead of an alias:
|
|
573
573
|
|
|
574
|
-
$ sf org
|
|
574
|
+
$ sf org delete sandbox --target-org myusername@example.com.qa
|
|
575
575
|
|
|
576
576
|
Delete the sandbox without prompting to confirm :
|
|
577
577
|
|
|
578
|
-
$ sf org
|
|
578
|
+
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
579
579
|
```
|
|
580
580
|
|
|
581
|
-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
581
|
+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/delete/sandbox.ts)_
|
|
582
582
|
|
|
583
|
-
## `sf org
|
|
583
|
+
## `sf org delete scratch`
|
|
584
584
|
|
|
585
585
|
Delete a scratch org.
|
|
586
586
|
|
|
587
587
|
```
|
|
588
588
|
USAGE
|
|
589
|
-
$ sf org
|
|
589
|
+
$ sf org delete scratch -o <value> [--json] [-p]
|
|
590
590
|
|
|
591
591
|
FLAGS
|
|
592
592
|
-o, --target-org=<value> (required) Scratch org alias or login user.
|
|
@@ -604,31 +604,31 @@ DESCRIPTION
|
|
|
604
604
|
list" to view all your orgs, including scratch orgs, and their aliases.
|
|
605
605
|
|
|
606
606
|
ALIASES
|
|
607
|
-
$ sf env
|
|
607
|
+
$ sf env delete scratch
|
|
608
608
|
|
|
609
609
|
EXAMPLES
|
|
610
610
|
Delete a scratch org with alias my-scratch-org:
|
|
611
611
|
|
|
612
|
-
$ sf org
|
|
612
|
+
$ sf org delete scratch --target-org my-scratch-org
|
|
613
613
|
|
|
614
614
|
Specify a username instead of an alias:
|
|
615
615
|
|
|
616
|
-
$ sf org
|
|
616
|
+
$ sf org delete scratch --target-org test-123456-abcdefg@example.com
|
|
617
617
|
|
|
618
618
|
Delete the scratch org without prompting to confirm :
|
|
619
619
|
|
|
620
|
-
$ sf org
|
|
620
|
+
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
621
621
|
```
|
|
622
622
|
|
|
623
|
-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
623
|
+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/delete/scratch.ts)_
|
|
624
624
|
|
|
625
|
-
## `sf org
|
|
625
|
+
## `sf org display`
|
|
626
626
|
|
|
627
627
|
Display information about an org.
|
|
628
628
|
|
|
629
629
|
```
|
|
630
630
|
USAGE
|
|
631
|
-
$ sf org
|
|
631
|
+
$ sf org display -o <value> [--json] [--api-version <value>] [--verbose]
|
|
632
632
|
|
|
633
633
|
FLAGS
|
|
634
634
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
@@ -651,27 +651,27 @@ DESCRIPTION
|
|
|
651
651
|
"org login jwt").
|
|
652
652
|
|
|
653
653
|
ALIASES
|
|
654
|
-
$ sf force
|
|
654
|
+
$ sf force org display
|
|
655
655
|
|
|
656
656
|
EXAMPLES
|
|
657
657
|
Display information about your default org:
|
|
658
658
|
|
|
659
|
-
$ sf org
|
|
659
|
+
$ sf org display
|
|
660
660
|
|
|
661
661
|
Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:
|
|
662
662
|
|
|
663
|
-
$ sf org
|
|
663
|
+
$ sf org display --target-org TestOrg1 --verbose
|
|
664
664
|
```
|
|
665
665
|
|
|
666
|
-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
666
|
+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/display.ts)_
|
|
667
667
|
|
|
668
|
-
## `sf org
|
|
668
|
+
## `sf org list`
|
|
669
669
|
|
|
670
670
|
List all orgs you’ve created or authenticated to.
|
|
671
671
|
|
|
672
672
|
```
|
|
673
673
|
USAGE
|
|
674
|
-
$ sf org
|
|
674
|
+
$ sf org list [--json] [--verbose] [--all] [-p --clean] [--skip-connection-status]
|
|
675
675
|
|
|
676
676
|
FLAGS
|
|
677
677
|
-p, --no-prompt Don't prompt for confirmation.
|
|
@@ -685,31 +685,31 @@ GLOBAL FLAGS
|
|
|
685
685
|
--json Format output as json.
|
|
686
686
|
|
|
687
687
|
ALIASES
|
|
688
|
-
$ sf force
|
|
688
|
+
$ sf force org list
|
|
689
689
|
|
|
690
690
|
EXAMPLES
|
|
691
691
|
List all orgs you've created or authenticated to:
|
|
692
692
|
|
|
693
|
-
$ sf org
|
|
693
|
+
$ sf org list
|
|
694
694
|
|
|
695
695
|
List all orgs, including expired, deleted, and unknown-status orgs; don't include the connection status:
|
|
696
696
|
|
|
697
|
-
$ sf org
|
|
697
|
+
$ sf org list --skip-connection-status --all
|
|
698
698
|
|
|
699
699
|
List orgs and remove local org authorization info about non-active scratch orgs:
|
|
700
700
|
|
|
701
|
-
$ sf org
|
|
701
|
+
$ sf org list --clean
|
|
702
702
|
```
|
|
703
703
|
|
|
704
|
-
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
704
|
+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/list.ts)_
|
|
705
705
|
|
|
706
|
-
## `sf org
|
|
706
|
+
## `sf org list metadata`
|
|
707
707
|
|
|
708
708
|
List the metadata components and properties of a specified type.
|
|
709
709
|
|
|
710
710
|
```
|
|
711
711
|
USAGE
|
|
712
|
-
$ sf org
|
|
712
|
+
$ sf org list metadata -o <value> -m <value> [--json] [--api-version <value>] [-f <value>] [--folder <value>]
|
|
713
713
|
|
|
714
714
|
FLAGS
|
|
715
715
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -735,22 +735,22 @@ DESCRIPTION
|
|
|
735
735
|
Functions permission.
|
|
736
736
|
|
|
737
737
|
ALIASES
|
|
738
|
-
$ sf force
|
|
738
|
+
$ sf force mdapi listmetadata
|
|
739
739
|
|
|
740
740
|
EXAMPLES
|
|
741
741
|
List the CustomObject components, and their properties, in the org with alias "my-dev-org":
|
|
742
742
|
|
|
743
|
-
$ sf org
|
|
743
|
+
$ sf org list metadata --metadata-type CustomObject --target-org my-dev-org
|
|
744
744
|
|
|
745
745
|
List the CustomObject components in your default org, write the output to the specified file, and use API version
|
|
746
746
|
57.0:
|
|
747
747
|
|
|
748
|
-
$ sf org
|
|
748
|
+
$ sf org list metadata --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt
|
|
749
749
|
|
|
750
750
|
List the Dashboard components in your default org that are contained in the "folderSales" folder, write the output
|
|
751
751
|
to the specified file, and use API version 57.0:
|
|
752
752
|
|
|
753
|
-
$ sf org
|
|
753
|
+
$ sf org list metadata --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file \
|
|
754
754
|
/path/to/outputfilename.txt
|
|
755
755
|
|
|
756
756
|
FLAG DESCRIPTIONS
|
|
@@ -765,15 +765,15 @@ FLAG DESCRIPTIONS
|
|
|
765
765
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
766
766
|
```
|
|
767
767
|
|
|
768
|
-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
768
|
+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/list/metadata.ts)_
|
|
769
769
|
|
|
770
|
-
## `sf org
|
|
770
|
+
## `sf org list metadata-types`
|
|
771
771
|
|
|
772
772
|
Display details about the metadata types that are enabled for your org.
|
|
773
773
|
|
|
774
774
|
```
|
|
775
775
|
USAGE
|
|
776
|
-
$ sf org
|
|
776
|
+
$ sf org list metadata-types -o <value> [--json] [--api-version <value>] [-f <value>]
|
|
777
777
|
|
|
778
778
|
FLAGS
|
|
779
779
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -794,18 +794,18 @@ DESCRIPTION
|
|
|
794
794
|
Functions permission.
|
|
795
795
|
|
|
796
796
|
ALIASES
|
|
797
|
-
$ sf force
|
|
797
|
+
$ sf force mdapi describemetadata
|
|
798
798
|
|
|
799
799
|
EXAMPLES
|
|
800
800
|
Display information about all known and enabled metadata types in the org with alias "my-dev-org" using API version
|
|
801
801
|
57.0:
|
|
802
802
|
|
|
803
|
-
$ sf org
|
|
803
|
+
$ sf org list metadata-types --api-version 57.0 --target-org my-dev-org
|
|
804
804
|
|
|
805
805
|
Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the
|
|
806
806
|
results to the specified file:
|
|
807
807
|
|
|
808
|
-
$ sf org
|
|
808
|
+
$ sf org list metadata-types --output-file /path/to/outputfilename.txt --filter-known
|
|
809
809
|
|
|
810
810
|
FLAG DESCRIPTIONS
|
|
811
811
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
@@ -818,15 +818,15 @@ FLAG DESCRIPTIONS
|
|
|
818
818
|
Override the api version used for api requests made by this command
|
|
819
819
|
```
|
|
820
820
|
|
|
821
|
-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
821
|
+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/list/metadata-types.ts)_
|
|
822
822
|
|
|
823
|
-
## `sf org
|
|
823
|
+
## `sf org open`
|
|
824
824
|
|
|
825
825
|
Open your default scratch org, or another specified org, in a browser.
|
|
826
826
|
|
|
827
827
|
```
|
|
828
828
|
USAGE
|
|
829
|
-
$ sf org
|
|
829
|
+
$ sf org open -o <value> [--json] [--api-version <value>] [-b chrome|edge|firefox | -r] [-p <value> | -f
|
|
830
830
|
<value>]
|
|
831
831
|
|
|
832
832
|
FLAGS
|
|
@@ -857,41 +857,41 @@ DESCRIPTION
|
|
|
857
857
|
don't specify --browser, the org opens in your default browser.
|
|
858
858
|
|
|
859
859
|
ALIASES
|
|
860
|
-
$ sf force
|
|
861
|
-
$ sf force
|
|
860
|
+
$ sf force org open
|
|
861
|
+
$ sf force source open
|
|
862
862
|
|
|
863
863
|
EXAMPLES
|
|
864
864
|
Open your default org in your default browser:
|
|
865
865
|
|
|
866
|
-
$ sf org
|
|
866
|
+
$ sf org open
|
|
867
867
|
|
|
868
868
|
Open the org with alias MyTestOrg1 in the Firefox browser:
|
|
869
869
|
|
|
870
|
-
$ sf org
|
|
870
|
+
$ sf org open --target-org MyTestOrg1 --browser firefox
|
|
871
871
|
|
|
872
872
|
Display the navigation URL for the Lightning Experience page for your default org, but don't open the page in a
|
|
873
873
|
browser:
|
|
874
874
|
|
|
875
|
-
$ sf org
|
|
875
|
+
$ sf org open --url-only --path lightning
|
|
876
876
|
|
|
877
877
|
Open a local Lightning page in your default org's Lightning App Builder:
|
|
878
878
|
|
|
879
|
-
$ sf org
|
|
879
|
+
$ sf org open --source-file force-app/main/default/flexipages/Hello.flexipage-meta.xml
|
|
880
880
|
|
|
881
881
|
Open a local Flow in Flow Builder:
|
|
882
882
|
|
|
883
|
-
$ sf org
|
|
883
|
+
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
884
884
|
```
|
|
885
885
|
|
|
886
|
-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
886
|
+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/open.ts)_
|
|
887
887
|
|
|
888
|
-
## `sf org
|
|
888
|
+
## `sf org resume sandbox`
|
|
889
889
|
|
|
890
890
|
Check the status of a sandbox creation, and log in to it if it's ready.
|
|
891
891
|
|
|
892
892
|
```
|
|
893
893
|
USAGE
|
|
894
|
-
$ sf org
|
|
894
|
+
$ sf org resume sandbox [--json] [-w <value>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
895
895
|
|
|
896
896
|
FLAGS
|
|
897
897
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
@@ -914,20 +914,20 @@ DESCRIPTION
|
|
|
914
914
|
recent sandbox creation.
|
|
915
915
|
|
|
916
916
|
ALIASES
|
|
917
|
-
$ sf env
|
|
917
|
+
$ sf env resume sandbox
|
|
918
918
|
|
|
919
919
|
EXAMPLES
|
|
920
920
|
Check the status of a sandbox creation using its name and specify a production org with alias "prodOrg":
|
|
921
921
|
|
|
922
|
-
$ sf org
|
|
922
|
+
$ sf org resume sandbox --name mysandbox --target-org prodOrg
|
|
923
923
|
|
|
924
924
|
Check the status using the job ID:
|
|
925
925
|
|
|
926
|
-
$ sf org
|
|
926
|
+
$ sf org resume sandbox --job-id 0GRxxxxxxxx
|
|
927
927
|
|
|
928
928
|
Check the status of the most recent sandbox create request:
|
|
929
929
|
|
|
930
|
-
$ sf org
|
|
930
|
+
$ sf org resume sandbox --use-most-recent
|
|
931
931
|
|
|
932
932
|
FLAG DESCRIPTIONS
|
|
933
933
|
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
@@ -945,15 +945,15 @@ FLAG DESCRIPTIONS
|
|
|
945
945
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
946
946
|
```
|
|
947
947
|
|
|
948
|
-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
948
|
+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/resume/sandbox.ts)_
|
|
949
949
|
|
|
950
|
-
## `sf org
|
|
950
|
+
## `sf org resume scratch`
|
|
951
951
|
|
|
952
952
|
Resume the creation of an incomplete scratch org.
|
|
953
953
|
|
|
954
954
|
```
|
|
955
955
|
USAGE
|
|
956
|
-
$ sf org
|
|
956
|
+
$ sf org resume scratch [--json] [-i <value>] [-r]
|
|
957
957
|
|
|
958
958
|
FLAGS
|
|
959
959
|
-i, --job-id=<value> Job ID of the incomplete scratch org create that you want to resume.
|
|
@@ -972,16 +972,16 @@ DESCRIPTION
|
|
|
972
972
|
incomplete scratch org.
|
|
973
973
|
|
|
974
974
|
ALIASES
|
|
975
|
-
$ sf env
|
|
975
|
+
$ sf env resume scratch
|
|
976
976
|
|
|
977
977
|
EXAMPLES
|
|
978
978
|
Resume a scratch org create with a job ID:
|
|
979
979
|
|
|
980
|
-
$ sf org
|
|
980
|
+
$ sf org resume scratch --job-id 2SR3u0000008fBDGAY
|
|
981
981
|
|
|
982
982
|
Resume your most recent incomplete scratch org:
|
|
983
983
|
|
|
984
|
-
$ sf org
|
|
984
|
+
$ sf org resume scratch --use-most-recent
|
|
985
985
|
|
|
986
986
|
FLAG DESCRIPTIONS
|
|
987
987
|
-i, --job-id=<value> Job ID of the incomplete scratch org create that you want to resume.
|
|
@@ -991,6 +991,6 @@ FLAG DESCRIPTIONS
|
|
|
991
991
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
992
992
|
```
|
|
993
993
|
|
|
994
|
-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.
|
|
994
|
+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.11.9/src/commands/org/resume/scratch.ts)_
|
|
995
995
|
|
|
996
996
|
<!-- 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>;
|