@salesforce/plugin-org 3.0.3 → 3.0.5
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 +55 -55
- package/oclif.lock +209 -240
- package/oclif.manifest.json +430 -430
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -132,7 +132,7 @@ FLAGS
|
|
|
132
132
|
-t, --type=<option> (required) Type of org to create.
|
|
133
133
|
<options: sandbox>
|
|
134
134
|
-w, --wait=<value> [default: 6 minutes] Number of minutes to wait while polling for status.
|
|
135
|
-
|
|
135
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
136
136
|
|
|
137
137
|
GLOBAL FLAGS
|
|
138
138
|
--json Format output as json.
|
|
@@ -160,7 +160,7 @@ 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/3.0.
|
|
163
|
+
_See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/clone.ts)_
|
|
164
164
|
|
|
165
165
|
## `sf force org create`
|
|
166
166
|
|
|
@@ -184,7 +184,7 @@ FLAGS
|
|
|
184
184
|
<options: scratch|sandbox>
|
|
185
185
|
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
186
186
|
-w, --wait=<value> [default: 6 minutes] Streaming client socket timeout (in minutes).
|
|
187
|
-
|
|
187
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
188
188
|
|
|
189
189
|
GLOBAL FLAGS
|
|
190
190
|
--json Format output as json.
|
|
@@ -208,7 +208,7 @@ EXAMPLES
|
|
|
208
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/3.0.
|
|
211
|
+
_See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/create.ts)_
|
|
212
212
|
|
|
213
213
|
## `sf force org delete`
|
|
214
214
|
|
|
@@ -219,9 +219,9 @@ USAGE
|
|
|
219
219
|
$ sf force org delete -o <value> [--json] [--api-version <value>] [-p]
|
|
220
220
|
|
|
221
221
|
FLAGS
|
|
222
|
-
-o, --target-org=<value>
|
|
223
|
-
-p, --no-prompt
|
|
224
|
-
|
|
222
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
223
|
+
-p, --no-prompt No prompt to confirm deletion.
|
|
224
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
225
225
|
|
|
226
226
|
GLOBAL FLAGS
|
|
227
227
|
--json Format output as json.
|
|
@@ -240,7 +240,7 @@ EXAMPLES
|
|
|
240
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/3.0.
|
|
243
|
+
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/delete.ts)_
|
|
244
244
|
|
|
245
245
|
## `sf force org status`
|
|
246
246
|
|
|
@@ -256,7 +256,7 @@ FLAGS
|
|
|
256
256
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
257
257
|
-s, --setdefaultusername Set the created or cloned org as your default.
|
|
258
258
|
-w, --wait=<value> [default: 6 minutes] Number of minutes to wait while polling for status.
|
|
259
|
-
|
|
259
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
260
260
|
|
|
261
261
|
GLOBAL FLAGS
|
|
262
262
|
--json Format output as json.
|
|
@@ -278,7 +278,7 @@ EXAMPLES
|
|
|
278
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/3.0.
|
|
281
|
+
_See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/force/org/status.ts)_
|
|
282
282
|
|
|
283
283
|
## `sf org create sandbox`
|
|
284
284
|
|
|
@@ -300,9 +300,9 @@ FLAGS
|
|
|
300
300
|
-o, --target-org=<value> (required) Username or alias of the production org that contains the sandbox license.
|
|
301
301
|
-s, --set-default Set the sandbox org as your default org.
|
|
302
302
|
-w, --wait=<minutes> [default: 30 minutes] Number of minutes to wait for the sandbox org to be ready.
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
303
|
+
--async Request the sandbox creation, but don't wait for it to complete.
|
|
304
|
+
--no-prompt Don't prompt for confirmation about the sandbox configuration.
|
|
305
|
+
--no-track-source Do not use source tracking for this sandbox.
|
|
306
306
|
|
|
307
307
|
GLOBAL FLAGS
|
|
308
308
|
--json Format output as json.
|
|
@@ -383,7 +383,7 @@ 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/3.0.
|
|
386
|
+
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/create/sandbox.ts)_
|
|
387
387
|
|
|
388
388
|
## `sf org create scratch`
|
|
389
389
|
|
|
@@ -406,30 +406,30 @@ FLAGS
|
|
|
406
406
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
407
407
|
-w, --wait=<minutes> [default: 5 minutes] Number of minutes to wait for the scratch org to be ready.
|
|
408
408
|
-y, --duration-days=<days> [default: 7 days] Number of days before the org expires.
|
|
409
|
-
|
|
410
|
-
|
|
409
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
410
|
+
--async Request the org, but don't wait for it to complete.
|
|
411
411
|
|
|
412
412
|
PACKAGING FLAGS
|
|
413
413
|
-c, --no-ancestors Don't include second-generation managed package (2GP) ancestors in the scratch org.
|
|
414
414
|
-m, --no-namespace Create the scratch org with no namespace, even if the Dev Hub has a namespace.
|
|
415
415
|
|
|
416
416
|
DEFINITION FILE OVERRIDE FLAGS
|
|
417
|
-
-e, --edition=<option>
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
417
|
+
-e, --edition=<option> Salesforce edition of the scratch org. Overrides the value of the "edition" option in the
|
|
418
|
+
definition file, if set.
|
|
419
|
+
<options: developer|enterprise|group|professional|partner-developer|partner-enterprise|part
|
|
420
|
+
ner-group|partner-professional>
|
|
421
|
+
--admin-email=<value> Email address that will be applied to the org's admin user. Overrides the value of the
|
|
422
|
+
"adminEmail" option in the definition file, if set.
|
|
423
|
+
--description=<value> Description of the scratch org in the Dev Hub. Overrides the value of the "description"
|
|
424
|
+
option in the definition file, if set.
|
|
425
|
+
--name=<value> Name of the org, such as "Acme Company". Overrides the value of the "orgName" option in the
|
|
426
|
+
definition file, if set.
|
|
427
|
+
--release=<option> Release of the scratch org as compared to the Dev Hub release.
|
|
428
|
+
<options: preview|previous>
|
|
429
|
+
--source-org=<value> 15-character ID of the org whose shape the new scratch org will be based on. Overrides the
|
|
430
|
+
value of the "sourceOrg" option in the definition file, if set.
|
|
431
|
+
--username=<value> Username of the scratch org admin user. Overrides the value of the "username" option in the
|
|
432
|
+
definition file, if set.
|
|
433
433
|
|
|
434
434
|
GLOBAL FLAGS
|
|
435
435
|
--json Format output as json.
|
|
@@ -536,7 +536,7 @@ 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/3.0.
|
|
539
|
+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/create/scratch.ts)_
|
|
540
540
|
|
|
541
541
|
## `sf org delete sandbox`
|
|
542
542
|
|
|
@@ -580,7 +580,7 @@ EXAMPLES
|
|
|
580
580
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
581
581
|
```
|
|
582
582
|
|
|
583
|
-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
583
|
+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/delete/sandbox.ts)_
|
|
584
584
|
|
|
585
585
|
## `sf org delete scratch`
|
|
586
586
|
|
|
@@ -622,7 +622,7 @@ EXAMPLES
|
|
|
622
622
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
623
623
|
```
|
|
624
624
|
|
|
625
|
-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
625
|
+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/delete/scratch.ts)_
|
|
626
626
|
|
|
627
627
|
## `sf org display`
|
|
628
628
|
|
|
@@ -633,9 +633,9 @@ USAGE
|
|
|
633
633
|
$ sf org display -o <value> [--json] [--api-version <value>] [--verbose]
|
|
634
634
|
|
|
635
635
|
FLAGS
|
|
636
|
-
-o, --target-org=<value>
|
|
637
|
-
|
|
638
|
-
|
|
636
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
637
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
638
|
+
--verbose Display the sfdxAuthUrl property.
|
|
639
639
|
|
|
640
640
|
GLOBAL FLAGS
|
|
641
641
|
--json Format output as json.
|
|
@@ -665,7 +665,7 @@ EXAMPLES
|
|
|
665
665
|
$ sf org display --target-org TestOrg1 --verbose
|
|
666
666
|
```
|
|
667
667
|
|
|
668
|
-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
668
|
+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/display.ts)_
|
|
669
669
|
|
|
670
670
|
## `sf org list`
|
|
671
671
|
|
|
@@ -676,12 +676,12 @@ USAGE
|
|
|
676
676
|
$ sf org list [--json] [--verbose] [--all] [-p --clean] [--skip-connection-status]
|
|
677
677
|
|
|
678
678
|
FLAGS
|
|
679
|
-
-p, --no-prompt
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
679
|
+
-p, --no-prompt Don't prompt for confirmation.
|
|
680
|
+
--all Include expired, deleted, and unknown-status scratch orgs.
|
|
681
|
+
--clean Remove all local org authorizations for non-active scratch orgs. Use "org logout" to
|
|
682
|
+
remove non-scratch orgs.
|
|
683
|
+
--skip-connection-status Skip retrieving the connection status of non-scratch orgs.
|
|
684
|
+
--verbose List more information about each org.
|
|
685
685
|
|
|
686
686
|
GLOBAL FLAGS
|
|
687
687
|
--json Format output as json.
|
|
@@ -703,7 +703,7 @@ EXAMPLES
|
|
|
703
703
|
$ sf org list --clean
|
|
704
704
|
```
|
|
705
705
|
|
|
706
|
-
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
706
|
+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list.ts)_
|
|
707
707
|
|
|
708
708
|
## `sf org list metadata`
|
|
709
709
|
|
|
@@ -718,8 +718,8 @@ FLAGS
|
|
|
718
718
|
-m, --metadata-type=<value> (required) Metadata type to be retrieved, such as CustomObject; metadata type names are
|
|
719
719
|
case-sensitive.
|
|
720
720
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
721
|
-
|
|
722
|
-
|
|
721
|
+
--api-version=<value> API version to use; default is the most recent API version.
|
|
722
|
+
--folder=<value> Folder associated with the component; required for components that use folders; folder
|
|
723
723
|
names are case-sensitive.
|
|
724
724
|
|
|
725
725
|
GLOBAL FLAGS
|
|
@@ -767,7 +767,7 @@ FLAG DESCRIPTIONS
|
|
|
767
767
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
768
768
|
```
|
|
769
769
|
|
|
770
|
-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
770
|
+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list/metadata.ts)_
|
|
771
771
|
|
|
772
772
|
## `sf org list metadata-types`
|
|
773
773
|
|
|
@@ -780,7 +780,7 @@ USAGE
|
|
|
780
780
|
FLAGS
|
|
781
781
|
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
782
782
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
783
|
-
|
|
783
|
+
--api-version=<value> API version to use; default is the most recent API version.
|
|
784
784
|
|
|
785
785
|
GLOBAL FLAGS
|
|
786
786
|
--json Format output as json.
|
|
@@ -820,7 +820,7 @@ FLAG DESCRIPTIONS
|
|
|
820
820
|
Override the api version used for api requests made by this command
|
|
821
821
|
```
|
|
822
822
|
|
|
823
|
-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
823
|
+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/list/metadata-types.ts)_
|
|
824
824
|
|
|
825
825
|
## `sf org open`
|
|
826
826
|
|
|
@@ -838,7 +838,7 @@ FLAGS
|
|
|
838
838
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
839
839
|
-p, --path=<value> Navigation URL path to open a specific page.
|
|
840
840
|
-r, --url-only Display navigation URL, but don’t launch browser.
|
|
841
|
-
|
|
841
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
842
842
|
|
|
843
843
|
GLOBAL FLAGS
|
|
844
844
|
--json Format output as json.
|
|
@@ -885,7 +885,7 @@ EXAMPLES
|
|
|
885
885
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
886
886
|
```
|
|
887
887
|
|
|
888
|
-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
888
|
+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/open.ts)_
|
|
889
889
|
|
|
890
890
|
## `sf org resume sandbox`
|
|
891
891
|
|
|
@@ -947,7 +947,7 @@ FLAG DESCRIPTIONS
|
|
|
947
947
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
948
948
|
```
|
|
949
949
|
|
|
950
|
-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
950
|
+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/resume/sandbox.ts)_
|
|
951
951
|
|
|
952
952
|
## `sf org resume scratch`
|
|
953
953
|
|
|
@@ -993,6 +993,6 @@ FLAG DESCRIPTIONS
|
|
|
993
993
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
994
994
|
```
|
|
995
995
|
|
|
996
|
-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.
|
|
996
|
+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.5/src/commands/org/resume/scratch.ts)_
|
|
997
997
|
|
|
998
998
|
<!-- commandsstop -->
|