@salesforce/plugin-org 2.10.7 → 2.10.9
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 +287 -495
- package/oclif.manifest.json +1 -1
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -99,586 +99,187 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
|
|
|
99
99
|
|
|
100
100
|
<!-- commands -->
|
|
101
101
|
|
|
102
|
-
- [`sf
|
|
103
|
-
- [`sf
|
|
104
|
-
- [`sf
|
|
105
|
-
- [`sf
|
|
106
|
-
- [`sf env:resume:scratch`](#sf-envresumescratch)
|
|
107
|
-
- [`sf force:mdapi:describemetadata`](#sf-forcemdapidescribemetadata)
|
|
108
|
-
- [`sf force:mdapi:listmetadata`](#sf-forcemdapilistmetadata)
|
|
109
|
-
- [`sf force:org:display`](#sf-forceorgdisplay)
|
|
110
|
-
- [`sf force:org:open`](#sf-forceorgopen)
|
|
111
|
-
- [`sf force:source:open`](#sf-forcesourceopen)
|
|
102
|
+
- [`sf force:org:clone`](#sf-forceorgclone)
|
|
103
|
+
- [`sf force:org:create`](#sf-forceorgcreate)
|
|
104
|
+
- [`sf force:org:delete`](#sf-forceorgdelete)
|
|
105
|
+
- [`sf force:org:status`](#sf-forceorgstatus)
|
|
112
106
|
- [`sf org:create:sandbox`](#sf-orgcreatesandbox)
|
|
107
|
+
- [`sf org:create:scratch`](#sf-orgcreatescratch)
|
|
113
108
|
- [`sf org:delete:sandbox`](#sf-orgdeletesandbox)
|
|
114
109
|
- [`sf org:delete:scratch`](#sf-orgdeletescratch)
|
|
115
110
|
- [`sf org:display`](#sf-orgdisplay)
|
|
111
|
+
- [`sf org:list`](#sf-orglist)
|
|
116
112
|
- [`sf org:list:metadata`](#sf-orglistmetadata)
|
|
117
113
|
- [`sf org:list:metadata-types`](#sf-orglistmetadata-types)
|
|
118
114
|
- [`sf org:open`](#sf-orgopen)
|
|
119
115
|
- [`sf org:resume:sandbox`](#sf-orgresumesandbox)
|
|
120
116
|
- [`sf org:resume:scratch`](#sf-orgresumescratch)
|
|
121
117
|
|
|
122
|
-
## `sf
|
|
118
|
+
## `sf force:org:clone`
|
|
123
119
|
|
|
124
|
-
|
|
120
|
+
Clone a sandbox org.
|
|
125
121
|
|
|
126
122
|
```
|
|
127
123
|
USAGE
|
|
128
|
-
$ sf
|
|
129
|
-
|
|
124
|
+
$ sf force:org:clone -o <value> -t sandbox [--json] [--api-version <value>] [-f <value>] [-s] [-a <value>] [-w
|
|
125
|
+
<value>]
|
|
130
126
|
|
|
131
127
|
FLAGS
|
|
132
|
-
-a, --
|
|
133
|
-
-
|
|
134
|
-
-
|
|
135
|
-
-
|
|
136
|
-
-
|
|
137
|
-
|
|
138
|
-
-
|
|
139
|
-
|
|
140
|
-
-s, --set-default Set the sandbox org as your default org.
|
|
141
|
-
-w, --wait=<minutes> [default: 30 minutes] Number of minutes to wait for the sandbox org to be ready.
|
|
142
|
-
--async Request the sandbox creation, but don't wait for it to complete.
|
|
143
|
-
--no-prompt Don't prompt for confirmation about the sandbox configuration.
|
|
144
|
-
--no-track-source Do not use source tracking for this sandbox.
|
|
128
|
+
-a, --setalias=<value> Alias for the cloned org.
|
|
129
|
+
-f, --definitionfile=<value> Path to the sandbox definition file.
|
|
130
|
+
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
131
|
+
-s, --setdefaultusername Set the cloned org as your default.
|
|
132
|
+
-t, --type=<option> (required) Type of org to create.
|
|
133
|
+
<options: sandbox>
|
|
134
|
+
-w, --wait=<value> [default: 6 minutes] Number of minutes to wait while polling for status.
|
|
135
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
145
136
|
|
|
146
137
|
GLOBAL FLAGS
|
|
147
138
|
--json Format output as json.
|
|
148
139
|
|
|
149
140
|
DESCRIPTION
|
|
150
|
-
|
|
141
|
+
Clone a sandbox org.
|
|
151
142
|
|
|
152
|
-
There are two ways to
|
|
153
|
-
|
|
154
|
-
|
|
143
|
+
There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the
|
|
144
|
+
command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either
|
|
145
|
+
case, you must specify both the "SandboxName" and "SourceSandboxName" options to set the names of the new sandbox and
|
|
146
|
+
the one being cloned, respectively.
|
|
155
147
|
|
|
156
|
-
|
|
157
|
-
|
|
148
|
+
Set the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is
|
|
149
|
+
required and must be set to "sandbox".
|
|
158
150
|
|
|
159
151
|
EXAMPLES
|
|
160
|
-
|
|
161
|
-
the sandbox license has the alias "prodOrg".
|
|
152
|
+
$ sf force:org:clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
|
|
162
153
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition
|
|
166
|
-
file. Set the sandbox org as your default.
|
|
167
|
-
|
|
168
|
-
$ sf env:create:sandbox --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg \
|
|
169
|
-
--set-default
|
|
154
|
+
$ sf force:org:clone -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
|
|
170
155
|
|
|
171
156
|
FLAG DESCRIPTIONS
|
|
172
|
-
-
|
|
173
|
-
|
|
174
|
-
When you create a sandbox, the generated usernames are based on the usernames present in the production org. To
|
|
175
|
-
ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username
|
|
176
|
-
"user@example.com" in the production org results in the username "user@example.com.mysandbox" in a sandbox named
|
|
177
|
-
"mysandbox". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running
|
|
178
|
-
this command.
|
|
179
|
-
|
|
180
|
-
-c, --clone=<value> Name of the sandbox org to clone.
|
|
181
|
-
|
|
182
|
-
The value of clone must be an existing sandbox in the same target-org.
|
|
183
|
-
|
|
184
|
-
-f, --definition-file=<value> Path to a sandbox definition file.
|
|
185
|
-
|
|
186
|
-
The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each
|
|
187
|
-
sandbox type that you use in the development process. See
|
|
188
|
-
<https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all
|
|
189
|
-
the options you can specify in the defintion file.
|
|
190
|
-
|
|
191
|
-
-n, --name=<value> Name of the sandbox org.
|
|
192
|
-
|
|
193
|
-
The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a
|
|
194
|
-
name while a sandbox is in the process of being deleted.
|
|
195
|
-
|
|
196
|
-
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
|
|
197
|
-
|
|
198
|
-
When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to
|
|
199
|
-
the new sandbox org.
|
|
200
|
-
|
|
201
|
-
-w, --wait=<minutes> Number of minutes to wait for the sandbox org to be ready.
|
|
202
|
-
|
|
203
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays
|
|
204
|
-
the "sf org resume sandbox" command you run to check the status of the create. The displayed command includes the
|
|
205
|
-
job ID for the running sandbox creation.
|
|
206
|
-
|
|
207
|
-
--async Request the sandbox creation, but don't wait for it to complete.
|
|
208
|
-
|
|
209
|
-
The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue
|
|
210
|
-
to use the CLI. To check the status of the sandbox creation, run "sf org resume sandbox".
|
|
211
|
-
|
|
212
|
-
--no-track-source Do not use source tracking for this sandbox.
|
|
213
|
-
|
|
214
|
-
We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default
|
|
215
|
-
behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and
|
|
216
|
-
in the sandbox, and to detect any conflicts between the two.
|
|
217
|
-
|
|
218
|
-
To disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source
|
|
219
|
-
tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your
|
|
220
|
-
CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the
|
|
221
|
-
SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the
|
|
222
|
-
sandbox.
|
|
223
|
-
```
|
|
224
|
-
|
|
225
|
-
## `sf env:delete:sandbox`
|
|
226
|
-
|
|
227
|
-
Delete a sandbox.
|
|
157
|
+
-w, --wait=<value> Number of minutes to wait while polling for status.
|
|
228
158
|
|
|
159
|
+
Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server
|
|
160
|
+
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
|
|
229
161
|
```
|
|
230
|
-
USAGE
|
|
231
|
-
$ sf env:delete:sandbox -o <value> [--json] [-p]
|
|
232
162
|
|
|
233
|
-
|
|
234
|
-
-o, --target-org=<value> (required) Sandbox alias or login user.
|
|
235
|
-
-p, --no-prompt Don't prompt the user to confirm the deletion.
|
|
163
|
+
_See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/force/org/clone.ts)_
|
|
236
164
|
|
|
237
|
-
|
|
238
|
-
--json Format output as json.
|
|
165
|
+
## `sf force:org:create`
|
|
239
166
|
|
|
240
|
-
|
|
241
|
-
Delete a sandbox.
|
|
242
|
-
|
|
243
|
-
Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes
|
|
244
|
-
all local references to the org from your computer.
|
|
245
|
-
Specify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when
|
|
246
|
-
you created it. Run "sf org list" to view all your orgs, including sandboxes, and their aliases.
|
|
247
|
-
|
|
248
|
-
ALIASES
|
|
249
|
-
$ sf env:delete:sandbox
|
|
250
|
-
|
|
251
|
-
EXAMPLES
|
|
252
|
-
Delete a sandbox with alias my-sandbox:
|
|
253
|
-
|
|
254
|
-
$ sf env:delete:sandbox --target-org my-sandbox
|
|
255
|
-
|
|
256
|
-
Specify a username instead of an alias:
|
|
257
|
-
|
|
258
|
-
$ sf env:delete:sandbox --target-org myusername@example.com.qa
|
|
259
|
-
|
|
260
|
-
Delete the sandbox without prompting to confirm :
|
|
261
|
-
|
|
262
|
-
$ sf env:delete:sandbox --target-org my-sandbox --no-prompt
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
## `sf env:delete:scratch`
|
|
266
|
-
|
|
267
|
-
Delete a scratch org.
|
|
167
|
+
Create a scratch org or sandbox.
|
|
268
168
|
|
|
269
169
|
```
|
|
270
170
|
USAGE
|
|
271
|
-
$ sf
|
|
171
|
+
$ sf force:org:create [--json] [-o <value>] [-v <value>] [--api-version <value>] [-t scratch|sandbox] [-f <value>]
|
|
172
|
+
[-n] [-c] [-i <value>] [-s] [-a <value>] [-w <value>] [-d <value>]
|
|
272
173
|
|
|
273
174
|
FLAGS
|
|
274
|
-
-
|
|
275
|
-
-
|
|
175
|
+
-a, --setalias=<value> Alias for the created org.
|
|
176
|
+
-c, --noancestors Do not include second-generation package ancestors in the scratch org.
|
|
177
|
+
-d, --durationdays=<value> [default: 7] Duration of the scratch org (in days) (default:7, min:1, max:30).
|
|
178
|
+
-f, --definitionfile=<value> Path to an org definition file.
|
|
179
|
+
-i, --clientid=<value> Connected app consumer key; not supported for sandbox org creation.
|
|
180
|
+
-n, --nonamespace Create the scratch org with no namespace.
|
|
181
|
+
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
|
|
182
|
+
-s, --setdefaultusername Set the created org as the default username.
|
|
183
|
+
-t, --type=<option> [default: scratch] Type of org to create.
|
|
184
|
+
<options: scratch|sandbox>
|
|
185
|
+
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
186
|
+
-w, --wait=<value> [default: 6 minutes] Streaming client socket timeout (in minutes).
|
|
187
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
276
188
|
|
|
277
189
|
GLOBAL FLAGS
|
|
278
190
|
--json Format output as json.
|
|
279
191
|
|
|
280
192
|
DESCRIPTION
|
|
281
|
-
|
|
193
|
+
Create a scratch org or sandbox.
|
|
282
194
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
ALIASES
|
|
289
|
-
$ sf env:delete:scratch
|
|
195
|
+
Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you
|
|
196
|
+
specify on the command line. Values specified on the command line override values in the configuration file. Specify a
|
|
197
|
+
configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs,
|
|
198
|
+
—targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a
|
|
199
|
+
production org with sandbox licenses. The —type (-t) is required if creating a sandbox.
|
|
290
200
|
|
|
291
201
|
EXAMPLES
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
$ sf env:delete:scratch --target-org my-scratch-org
|
|
202
|
+
$ sf force:org:create -f config/enterprise-scratch-def.json -a MyScratchOrg
|
|
295
203
|
|
|
296
|
-
|
|
204
|
+
$ sf force:org:create edition=Developer -a MyScratchOrg -s -v devHub
|
|
297
205
|
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
Delete the scratch org without prompting to confirm :
|
|
301
|
-
|
|
302
|
-
$ sf env:delete:scratch --target-org my-scratch-org --no-prompt
|
|
303
|
-
```
|
|
304
|
-
|
|
305
|
-
## `sf env:resume:sandbox`
|
|
306
|
-
|
|
307
|
-
Check the status of a sandbox creation, and log in to it if it's ready.
|
|
206
|
+
$ sf force:org:create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org
|
|
308
207
|
|
|
208
|
+
$ sf force:org:create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
|
|
309
209
|
```
|
|
310
|
-
USAGE
|
|
311
|
-
$ sf env:resume:sandbox [--json] [-w <value>] [-n <value> | -i <value>] [-l] [-o <value>]
|
|
312
|
-
|
|
313
|
-
FLAGS
|
|
314
|
-
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
315
|
-
-l, --use-most-recent Use the most recent sandbox create request.
|
|
316
|
-
-n, --name=<value> Name of the sandbox org.
|
|
317
|
-
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
|
|
318
|
-
-w, --wait=<minutes> Number of minutes to wait for the sandbox org to be ready.
|
|
319
|
-
|
|
320
|
-
GLOBAL FLAGS
|
|
321
|
-
--json Format output as json.
|
|
322
|
-
|
|
323
|
-
DESCRIPTION
|
|
324
|
-
Check the status of a sandbox creation, and log in to it if it's ready.
|
|
325
|
-
|
|
326
|
-
Sandbox creation can take a long time. If the original "sf org create sandbox" command either times out, or you
|
|
327
|
-
specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is
|
|
328
|
-
complete, and if it is, the command then logs into it.
|
|
329
|
-
|
|
330
|
-
You can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most
|
|
331
|
-
recent sandbox creation.
|
|
332
|
-
|
|
333
|
-
ALIASES
|
|
334
|
-
$ sf env:resume:sandbox
|
|
335
|
-
|
|
336
|
-
EXAMPLES
|
|
337
|
-
Check the status of a sandbox creation using its name and specify a production org with alias "prodOrg":
|
|
338
|
-
|
|
339
|
-
$ sf env:resume:sandbox --name mysandbox --target-org prodOrg
|
|
340
|
-
|
|
341
|
-
Check the status using the job ID:
|
|
342
|
-
|
|
343
|
-
$ sf env:resume:sandbox --job-id 0GRxxxxxxxx
|
|
344
|
-
|
|
345
|
-
Check the status of the most recent sandbox create request:
|
|
346
|
-
|
|
347
|
-
$ sf env:resume:sandbox --use-most-recent
|
|
348
|
-
|
|
349
|
-
FLAG DESCRIPTIONS
|
|
350
|
-
-i, --job-id=<value> Job ID of the incomplete sandbox creation that you want to check the status of.
|
|
351
|
-
|
|
352
|
-
The job ID is valid for 24 hours after you start the sandbox creation.
|
|
353
|
-
|
|
354
|
-
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
|
|
355
|
-
|
|
356
|
-
When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to
|
|
357
|
-
the new sandbox org.
|
|
358
|
-
|
|
359
|
-
-w, --wait=<minutes> Number of minutes to wait for the sandbox org to be ready.
|
|
360
|
-
|
|
361
|
-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
|
|
362
|
-
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
363
|
-
```
|
|
364
|
-
|
|
365
|
-
## `sf env:resume:scratch`
|
|
366
|
-
|
|
367
|
-
Resume the creation of an incomplete scratch org.
|
|
368
|
-
|
|
369
|
-
```
|
|
370
|
-
USAGE
|
|
371
|
-
$ sf env:resume:scratch [--json] [-i <value>] [-r]
|
|
372
210
|
|
|
373
|
-
|
|
374
|
-
-i, --job-id=<value> Job ID of the incomplete scratch org create that you want to resume.
|
|
375
|
-
-r, --use-most-recent Use the job ID of the most recent incomplete scratch org.
|
|
376
|
-
|
|
377
|
-
GLOBAL FLAGS
|
|
378
|
-
--json Format output as json.
|
|
379
|
-
|
|
380
|
-
DESCRIPTION
|
|
381
|
-
Resume the creation of an incomplete scratch org.
|
|
382
|
-
|
|
383
|
-
When the original "sf org create scratch" command either times out or is run with the --async flag, it displays a job
|
|
384
|
-
ID.
|
|
385
|
-
|
|
386
|
-
Run this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent
|
|
387
|
-
incomplete scratch org.
|
|
388
|
-
|
|
389
|
-
ALIASES
|
|
390
|
-
$ sf env:resume:scratch
|
|
391
|
-
|
|
392
|
-
EXAMPLES
|
|
393
|
-
Resume a scratch org create with a job ID:
|
|
394
|
-
|
|
395
|
-
$ sf env:resume:scratch --job-id 2SR3u0000008fBDGAY
|
|
396
|
-
|
|
397
|
-
Resume your most recent incomplete scratch org:
|
|
211
|
+
_See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/force/org/create.ts)_
|
|
398
212
|
|
|
399
|
-
|
|
213
|
+
## `sf force:org:delete`
|
|
400
214
|
|
|
401
|
-
|
|
402
|
-
-i, --job-id=<value> Job ID of the incomplete scratch org create that you want to resume.
|
|
403
|
-
|
|
404
|
-
The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.
|
|
405
|
-
|
|
406
|
-
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
407
|
-
```
|
|
408
|
-
|
|
409
|
-
## `sf force:mdapi:describemetadata`
|
|
410
|
-
|
|
411
|
-
Display details about the metadata types that are enabled for your org.
|
|
215
|
+
Delete a scratch or sandbox org.
|
|
412
216
|
|
|
413
217
|
```
|
|
414
218
|
USAGE
|
|
415
|
-
$ sf force:
|
|
416
|
-
|
|
417
|
-
FLAGS
|
|
418
|
-
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
419
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
420
|
-
--api-version=<value> API version to use; default is the most recent API version.
|
|
421
|
-
|
|
422
|
-
GLOBAL FLAGS
|
|
423
|
-
--json Format output as json.
|
|
424
|
-
|
|
425
|
-
DESCRIPTION
|
|
426
|
-
Display details about the metadata types that are enabled for your org.
|
|
427
|
-
|
|
428
|
-
The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that
|
|
429
|
-
define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element
|
|
430
|
-
in a manifest file (package.xml).
|
|
431
|
-
|
|
432
|
-
The username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API
|
|
433
|
-
Functions permission.
|
|
434
|
-
|
|
435
|
-
ALIASES
|
|
436
|
-
$ sf force:mdapi:describemetadata
|
|
437
|
-
|
|
438
|
-
EXAMPLES
|
|
439
|
-
Display information about all known and enabled metadata types in the org with alias "my-dev-org" using API version
|
|
440
|
-
57.0:
|
|
441
|
-
|
|
442
|
-
$ sf force:mdapi:describemetadata --api-version 57.0 --target-org my-dev-org
|
|
443
|
-
|
|
444
|
-
Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the
|
|
445
|
-
results to the specified file:
|
|
446
|
-
|
|
447
|
-
$ sf force:mdapi:describemetadata --output-file /path/to/outputfilename.txt --filter-known
|
|
448
|
-
|
|
449
|
-
FLAG DESCRIPTIONS
|
|
450
|
-
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
451
|
-
|
|
452
|
-
Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file.
|
|
453
|
-
The default output destination is the terminal or command window console.
|
|
454
|
-
|
|
455
|
-
--api-version=<value> API version to use; default is the most recent API version.
|
|
456
|
-
|
|
457
|
-
Override the api version used for api requests made by this command
|
|
458
|
-
```
|
|
459
|
-
|
|
460
|
-
## `sf force:mdapi:listmetadata`
|
|
461
|
-
|
|
462
|
-
List the metadata components and properties of a specified type.
|
|
463
|
-
|
|
464
|
-
```
|
|
465
|
-
USAGE
|
|
466
|
-
$ sf force:mdapi:listmetadata -o <value> -m <value> [--json] [--api-version <value>] [-f <value>] [--folder <value>]
|
|
467
|
-
|
|
468
|
-
FLAGS
|
|
469
|
-
-f, --output-file=<value> Pathname of the file in which to write the results.
|
|
470
|
-
-m, --metadata-type=<value> (required) Metadata type to be retrieved, such as CustomObject; metadata type names are
|
|
471
|
-
case-sensitive.
|
|
472
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
473
|
-
--api-version=<value> API version to use; default is the most recent API version.
|
|
474
|
-
--folder=<value> Folder associated with the component; required for components that use folders; folder
|
|
475
|
-
names are case-sensitive.
|
|
476
|
-
|
|
477
|
-
GLOBAL FLAGS
|
|
478
|
-
--json Format output as json.
|
|
479
|
-
|
|
480
|
-
DESCRIPTION
|
|
481
|
-
List the metadata components and properties of a specified type.
|
|
482
|
-
|
|
483
|
-
Use this command to identify individual components in your manifest file or if you want a high-level view of
|
|
484
|
-
particular metadata types in your org. For example, you can use this command to return a list of names of all the
|
|
485
|
-
CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset
|
|
486
|
-
of these components.
|
|
487
|
-
|
|
488
|
-
The username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API
|
|
489
|
-
Functions permission.
|
|
490
|
-
|
|
491
|
-
ALIASES
|
|
492
|
-
$ sf force:mdapi:listmetadata
|
|
493
|
-
|
|
494
|
-
EXAMPLES
|
|
495
|
-
List the CustomObject components, and their properties, in the org with alias "my-dev-org":
|
|
496
|
-
|
|
497
|
-
$ sf force:mdapi:listmetadata --metadata-type CustomObject --target-org my-dev-org
|
|
498
|
-
|
|
499
|
-
List the CustomObject components in your default org, write the output to the specified file, and use API version
|
|
500
|
-
57.0:
|
|
501
|
-
|
|
502
|
-
$ sf force:mdapi:listmetadata --metadata-type CustomObject --api-version 57.0 --output-file \
|
|
503
|
-
/path/to/outputfilename.txt
|
|
504
|
-
|
|
505
|
-
List the Dashboard components in your default org that are contained in the "folderSales" folder, write the output
|
|
506
|
-
to the specified file, and use API version 57.0:
|
|
507
|
-
|
|
508
|
-
$ sf force:mdapi:listmetadata --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file \
|
|
509
|
-
/path/to/outputfilename.txt
|
|
510
|
-
|
|
511
|
-
FLAG DESCRIPTIONS
|
|
512
|
-
--api-version=<value> API version to use; default is the most recent API version.
|
|
513
|
-
|
|
514
|
-
Override the api version used for api requests made by this command
|
|
515
|
-
|
|
516
|
-
--folder=<value>
|
|
517
|
-
|
|
518
|
-
Folder associated with the component; required for components that use folders; folder names are case-sensitive.
|
|
519
|
-
|
|
520
|
-
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
521
|
-
```
|
|
522
|
-
|
|
523
|
-
## `sf force:org:display`
|
|
524
|
-
|
|
525
|
-
Display information about an org.
|
|
526
|
-
|
|
527
|
-
```
|
|
528
|
-
USAGE
|
|
529
|
-
$ sf force:org:display -o <value> [--json] [--api-version <value>] [--verbose]
|
|
219
|
+
$ sf force:org:delete -o <value> [--json] [--api-version <value>] [-p]
|
|
530
220
|
|
|
531
221
|
FLAGS
|
|
532
222
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
223
|
+
-p, --no-prompt No prompt to confirm deletion.
|
|
533
224
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
534
|
-
--verbose Display the sfdxAuthUrl property.
|
|
535
225
|
|
|
536
226
|
GLOBAL FLAGS
|
|
537
227
|
--json Format output as json.
|
|
538
228
|
|
|
539
229
|
DESCRIPTION
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
Output includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if
|
|
543
|
-
applicable.
|
|
544
|
-
|
|
545
|
-
Use --verbose to include the SFDX auth URL. WARNING: The SFDX auth URL contains sensitive information, such as a
|
|
546
|
-
refresh token that can be used to access an org. Don't share or distribute this URL or token.
|
|
230
|
+
Delete a scratch or sandbox org.
|
|
547
231
|
|
|
548
|
-
|
|
549
|
-
|
|
232
|
+
Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for
|
|
233
|
+
sandboxes) and then deletes all local references to the org from your computer.
|
|
550
234
|
|
|
551
|
-
|
|
552
|
-
$ sf force:org:display
|
|
235
|
+
To mark the org for deletion without being prompted to confirm, specify --noprompt.
|
|
553
236
|
|
|
554
237
|
EXAMPLES
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
$ sf force:org:display
|
|
558
|
-
|
|
559
|
-
Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:
|
|
238
|
+
$ sf force:org:delete -u me@my.org
|
|
560
239
|
|
|
561
|
-
|
|
240
|
+
$ sf force:org:delete -u MyOrgAlias -p
|
|
562
241
|
```
|
|
563
242
|
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
Open your default scratch org, or another specified org, in a browser.
|
|
567
|
-
|
|
568
|
-
```
|
|
569
|
-
USAGE
|
|
570
|
-
$ sf force:org:open -o <value> [--json] [--api-version <value>] [-b chrome|edge|firefox | -r] [-p <value> | -f
|
|
571
|
-
<value>]
|
|
572
|
-
|
|
573
|
-
FLAGS
|
|
574
|
-
-b, --browser=<option> Browser where the org opens.
|
|
575
|
-
<options: chrome|edge|firefox>
|
|
576
|
-
-f, --source-file=<value> Path to an ApexPage or FlexiPage to open in Lightning App Builder.
|
|
577
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
578
|
-
-p, --path=<value> Navigation URL path to open a specific page.
|
|
579
|
-
-r, --url-only Display navigation URL, but don’t launch browser.
|
|
580
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
581
|
-
|
|
582
|
-
GLOBAL FLAGS
|
|
583
|
-
--json Format output as json.
|
|
584
|
-
|
|
585
|
-
DESCRIPTION
|
|
586
|
-
Open your default scratch org, or another specified org, in a browser.
|
|
587
|
-
|
|
588
|
-
To open a specific page, specify the portion of the URL after "https://MyDomainName.my.salesforce.com/" as the value
|
|
589
|
-
for the --path flag. For example, specify "--path lightning" to open Lightning Experience, or specify "--path
|
|
590
|
-
/apex/YourPage" to open a Visualforce page.
|
|
591
|
-
|
|
592
|
-
Use the --source-file to open a Lightning Page from your local project in Lightning App Builder. Lightning page files
|
|
593
|
-
have the suffix .flexipage-meta.xml, and are stored in the "flexipages" directory.
|
|
594
|
-
|
|
595
|
-
To generate a URL but not launch it in your browser, specify --url-only.
|
|
596
|
-
|
|
597
|
-
To open in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "firefox". If you
|
|
598
|
-
don't specify --browser, the org opens in your default browser.
|
|
599
|
-
|
|
600
|
-
ALIASES
|
|
601
|
-
$ sf force:org:open
|
|
602
|
-
$ sf force:source:open
|
|
603
|
-
|
|
604
|
-
EXAMPLES
|
|
605
|
-
Open your default org in your default browser:
|
|
606
|
-
|
|
607
|
-
$ sf force:org:open
|
|
608
|
-
|
|
609
|
-
Open the org with alias MyTestOrg1 in the Firefox browser:
|
|
610
|
-
|
|
611
|
-
$ sf force:org:open --target-org MyTestOrg1 --browser firefox
|
|
612
|
-
|
|
613
|
-
Display the navigation URL for the Lightning Experience page for your default org, but don't open the page in a
|
|
614
|
-
browser:
|
|
615
|
-
|
|
616
|
-
$ sf force:org:open --url-only --path lightning
|
|
617
|
-
|
|
618
|
-
Open a local Lightning page in your default org's Lightning App Builder:
|
|
243
|
+
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/force/org/delete.ts)_
|
|
619
244
|
|
|
620
|
-
|
|
621
|
-
```
|
|
622
|
-
|
|
623
|
-
## `sf force:source:open`
|
|
245
|
+
## `sf force:org:status`
|
|
624
246
|
|
|
625
|
-
|
|
247
|
+
Check the status of a sandbox, and if complete, authenticate to it.
|
|
626
248
|
|
|
627
249
|
```
|
|
628
250
|
USAGE
|
|
629
|
-
$ sf force:
|
|
630
|
-
<value>]
|
|
251
|
+
$ sf force:org:status -o <value> -n <value> [--json] [--api-version <value>] [-s] [-a <value>] [-w <value>]
|
|
631
252
|
|
|
632
253
|
FLAGS
|
|
633
|
-
-
|
|
634
|
-
|
|
635
|
-
-f, --source-file=<value> Path to an ApexPage or FlexiPage to open in Lightning App Builder.
|
|
254
|
+
-a, --setalias=<value> Alias for the created or cloned org.
|
|
255
|
+
-n, --sandboxname=<value> (required) Name of the sandbox org to check status for.
|
|
636
256
|
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
637
|
-
-
|
|
638
|
-
-
|
|
257
|
+
-s, --setdefaultusername Set the created or cloned org as your default.
|
|
258
|
+
-w, --wait=<value> [default: 6 minutes] Number of minutes to wait while polling for status.
|
|
639
259
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
640
260
|
|
|
641
261
|
GLOBAL FLAGS
|
|
642
262
|
--json Format output as json.
|
|
643
263
|
|
|
644
264
|
DESCRIPTION
|
|
645
|
-
|
|
265
|
+
Check the status of a sandbox, and if complete, authenticate to it.
|
|
646
266
|
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
/apex/YourPage" to open a Visualforce page.
|
|
267
|
+
Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to
|
|
268
|
+
it.
|
|
650
269
|
|
|
651
|
-
Use the --
|
|
652
|
-
|
|
270
|
+
Use the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or
|
|
271
|
+
clone to complete before returning control of the terminal to you.
|
|
653
272
|
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
To open in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "firefox". If you
|
|
657
|
-
don't specify --browser, the org opens in your default browser.
|
|
658
|
-
|
|
659
|
-
ALIASES
|
|
660
|
-
$ sf force:org:open
|
|
661
|
-
$ sf force:source:open
|
|
273
|
+
Set the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.
|
|
662
274
|
|
|
663
275
|
EXAMPLES
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
$ sf force:source:open
|
|
667
|
-
|
|
668
|
-
Open the org with alias MyTestOrg1 in the Firefox browser:
|
|
669
|
-
|
|
670
|
-
$ sf force:source:open --target-org MyTestOrg1 --browser firefox
|
|
671
|
-
|
|
672
|
-
Display the navigation URL for the Lightning Experience page for your default org, but don't open the page in a
|
|
673
|
-
browser:
|
|
674
|
-
|
|
675
|
-
$ sf force:source:open --url-only --path lightning
|
|
276
|
+
$ sf force:org:status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg
|
|
676
277
|
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
$ sf force:source:open --source-path force-app/main/default/flexipages/Hello.flexipage-meta.xml
|
|
278
|
+
$ sf force:org:status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
|
|
680
279
|
```
|
|
681
280
|
|
|
281
|
+
_See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/force/org/status.ts)_
|
|
282
|
+
|
|
682
283
|
## `sf org:create:sandbox`
|
|
683
284
|
|
|
684
285
|
Create a sandbox org.
|
|
@@ -782,7 +383,160 @@ FLAG DESCRIPTIONS
|
|
|
782
383
|
sandbox.
|
|
783
384
|
```
|
|
784
385
|
|
|
785
|
-
_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/2.10.9/src/commands/org/create/sandbox.ts)_
|
|
387
|
+
|
|
388
|
+
## `sf org:create:scratch`
|
|
389
|
+
|
|
390
|
+
Create a scratch org.
|
|
391
|
+
|
|
392
|
+
```
|
|
393
|
+
USAGE
|
|
394
|
+
$ sf org:create:scratch -v <value> [--json] [-a <value>] [--async] [-d] [-f <value>] [-c] [-e
|
|
395
|
+
developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
|
|
396
|
+
[-m] [-y <value>] [-w <value>] [--api-version <value>] [-i <value>] [-t] [--username <value>] [--description
|
|
397
|
+
<value>] [--name <value>] [--release preview|previous] [--admin-email <value>] [--source-org <value>]
|
|
398
|
+
|
|
399
|
+
FLAGS
|
|
400
|
+
-a, --alias=<value> Alias for the scratch org.
|
|
401
|
+
-d, --set-default Set the scratch org as your default org
|
|
402
|
+
-f, --definition-file=<value> Path to a scratch org definition file.
|
|
403
|
+
-i, --client-id=<value> Consumer key of the Dev Hub connected app.
|
|
404
|
+
-t, --[no-]track-source Use source tracking for this scratch org. Set --no-track-source to disable source
|
|
405
|
+
tracking.
|
|
406
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
|
|
407
|
+
-w, --wait=<minutes> [default: 5 minutes] Number of minutes to wait for the scratch org to be ready.
|
|
408
|
+
-y, --duration-days=<days> [default: 7 days] Number of days before the org expires.
|
|
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
|
+
|
|
412
|
+
PACKAGING FLAGS
|
|
413
|
+
-c, --no-ancestors Don't include second-generation managed package (2GP) ancestors in the scratch org.
|
|
414
|
+
-m, --no-namespace Create the scratch org with no namespace, even if the Dev Hub has a namespace.
|
|
415
|
+
|
|
416
|
+
DEFINITION FILE OVERRIDE FLAGS
|
|
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|partner
|
|
420
|
+
-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" option
|
|
424
|
+
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
|
+
|
|
434
|
+
GLOBAL FLAGS
|
|
435
|
+
--json Format output as json.
|
|
436
|
+
|
|
437
|
+
DESCRIPTION
|
|
438
|
+
Create a scratch org.
|
|
439
|
+
|
|
440
|
+
There are two ways to create a scratch org: either specify a definition file that contains the options or use the
|
|
441
|
+
--edition flag to specify the one required option.
|
|
442
|
+
|
|
443
|
+
For either method, you can also use these flags; if you use them with --definition-file, they override their
|
|
444
|
+
equivalent option in the scratch org definition file:
|
|
445
|
+
|
|
446
|
+
* --description
|
|
447
|
+
* --name (equivalent to the "orgName" option)
|
|
448
|
+
* --username
|
|
449
|
+
* --release
|
|
450
|
+
* --edition
|
|
451
|
+
* --admin-email (equivalent to the "adminEmail" option)
|
|
452
|
+
* --source-org (equivalent to the "sourceOrg" option)
|
|
453
|
+
|
|
454
|
+
If you want to set options other than the preceding ones, such as org features or settings, you must use a definition
|
|
455
|
+
file.
|
|
456
|
+
|
|
457
|
+
You must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default
|
|
458
|
+
Dev Hub with the target-dev-hub configuration variable.
|
|
459
|
+
|
|
460
|
+
ALIASES
|
|
461
|
+
$ sf env:create:scratch
|
|
462
|
+
|
|
463
|
+
EXAMPLES
|
|
464
|
+
Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:
|
|
465
|
+
|
|
466
|
+
$ sf org:create:scratch --edition developer --alias my-scratch-org
|
|
467
|
+
|
|
468
|
+
Create a scratch org with a definition file. Specify the Dev Hub using its alias, set the scratch org as your
|
|
469
|
+
default, and specify that it expires in 3 days:
|
|
470
|
+
|
|
471
|
+
$ sf org:create:scratch --target-dev-hub MyHub --definition-file config/project-scratch-def.json --set-default \
|
|
472
|
+
--duration-days 3
|
|
473
|
+
|
|
474
|
+
Create a preview Enterprise edition scratch org; for use only during Salesforce release transition periods:
|
|
475
|
+
|
|
476
|
+
$ sf org:create:scratch --edition enterprise --alias my-scratch-org --target-dev-hub MyHub --release preview
|
|
477
|
+
|
|
478
|
+
FLAG DESCRIPTIONS
|
|
479
|
+
-a, --alias=<value> Alias for the scratch org.
|
|
480
|
+
|
|
481
|
+
New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks
|
|
482
|
+
something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this
|
|
483
|
+
username.
|
|
484
|
+
|
|
485
|
+
-e, --edition=developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional
|
|
486
|
+
|
|
487
|
+
Salesforce edition of the scratch org. Overrides the value of the "edition" option in the definition file, if set.
|
|
488
|
+
|
|
489
|
+
The editions that begin with "partner-" are available only if the Dev Hub org is a Partner Business Org.
|
|
490
|
+
|
|
491
|
+
-f, --definition-file=<value> Path to a scratch org definition file.
|
|
492
|
+
|
|
493
|
+
The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in
|
|
494
|
+
the development life cycle, such as acceptance testing, packaging, or production. See
|
|
495
|
+
<https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for
|
|
496
|
+
all the option you can specify in the definition file.
|
|
497
|
+
|
|
498
|
+
-t, --[no-]track-source Use source tracking for this scratch org. Set --no-track-source to disable source tracking.
|
|
499
|
+
|
|
500
|
+
We recommend you enable source tracking in scratch orgs, which is why it's the default behavior. Source tracking
|
|
501
|
+
allows you to track the changes you make to your metadata, both in your local project and in the scratch org, and to
|
|
502
|
+
detect any conflicts between the two.
|
|
503
|
+
|
|
504
|
+
To disable source tracking in the new scratch org, specify the --no-track-source flag. The main reason to disable
|
|
505
|
+
source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in
|
|
506
|
+
your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the
|
|
507
|
+
SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the
|
|
508
|
+
scratch org.
|
|
509
|
+
|
|
510
|
+
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
511
|
+
|
|
512
|
+
Overrides the value of the target-dev-hub configuration variable, if set.
|
|
513
|
+
|
|
514
|
+
-w, --wait=<minutes> Number of minutes to wait for the scratch org to be ready.
|
|
515
|
+
|
|
516
|
+
If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays
|
|
517
|
+
the job ID. To resume the scratch org creation, run the org resume scratch command and pass it the job ID.
|
|
518
|
+
|
|
519
|
+
--async Request the org, but don't wait for it to complete.
|
|
520
|
+
|
|
521
|
+
The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue
|
|
522
|
+
to use the CLI. To resume the scratch org creation, run "sf org resume scratch".
|
|
523
|
+
|
|
524
|
+
--release=preview|previous Release of the scratch org as compared to the Dev Hub release.
|
|
525
|
+
|
|
526
|
+
By default, scratch orgs are on the same release as the Dev Hub. During Salesforce release transition periods, you
|
|
527
|
+
can override this default behavior and opt in or out of the new release.
|
|
528
|
+
|
|
529
|
+
--username=<value>
|
|
530
|
+
|
|
531
|
+
Username of the scratch org admin user. Overrides the value of the "username" option in the definition file, if set.
|
|
532
|
+
|
|
533
|
+
The username must be unique within the entire scratch org and sandbox universe. You must add your own logic to
|
|
534
|
+
ensure uniqueness.
|
|
535
|
+
|
|
536
|
+
Omit this flag to have Salesforce generate a unique username for your org.
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/create/scratch.ts)_
|
|
786
540
|
|
|
787
541
|
## `sf org:delete:sandbox`
|
|
788
542
|
|
|
@@ -824,7 +578,7 @@ EXAMPLES
|
|
|
824
578
|
$ sf org:delete:sandbox --target-org my-sandbox --no-prompt
|
|
825
579
|
```
|
|
826
580
|
|
|
827
|
-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
581
|
+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/delete/sandbox.ts)_
|
|
828
582
|
|
|
829
583
|
## `sf org:delete:scratch`
|
|
830
584
|
|
|
@@ -866,7 +620,7 @@ EXAMPLES
|
|
|
866
620
|
$ sf org:delete:scratch --target-org my-scratch-org --no-prompt
|
|
867
621
|
```
|
|
868
622
|
|
|
869
|
-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
623
|
+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/delete/scratch.ts)_
|
|
870
624
|
|
|
871
625
|
## `sf org:display`
|
|
872
626
|
|
|
@@ -909,7 +663,45 @@ EXAMPLES
|
|
|
909
663
|
$ sf org:display --target-org TestOrg1 --verbose
|
|
910
664
|
```
|
|
911
665
|
|
|
912
|
-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
666
|
+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/display.ts)_
|
|
667
|
+
|
|
668
|
+
## `sf org:list`
|
|
669
|
+
|
|
670
|
+
List all orgs you’ve created or authenticated to.
|
|
671
|
+
|
|
672
|
+
```
|
|
673
|
+
USAGE
|
|
674
|
+
$ sf org:list [--json] [--verbose] [--all] [-p --clean] [--skip-connection-status]
|
|
675
|
+
|
|
676
|
+
FLAGS
|
|
677
|
+
-p, --no-prompt Don't prompt for confirmation.
|
|
678
|
+
--all Include expired, deleted, and unknown-status scratch orgs.
|
|
679
|
+
--clean Remove all local org authorizations for non-active scratch orgs. Use "org logout" to remove
|
|
680
|
+
non-scratch orgs.
|
|
681
|
+
--skip-connection-status Skip retrieving the connection status of non-scratch orgs.
|
|
682
|
+
--verbose List more information about each org.
|
|
683
|
+
|
|
684
|
+
GLOBAL FLAGS
|
|
685
|
+
--json Format output as json.
|
|
686
|
+
|
|
687
|
+
ALIASES
|
|
688
|
+
$ sf force:org:list
|
|
689
|
+
|
|
690
|
+
EXAMPLES
|
|
691
|
+
List all orgs you've created or authenticated to:
|
|
692
|
+
|
|
693
|
+
$ sf org:list
|
|
694
|
+
|
|
695
|
+
List all orgs, including expired, deleted, and unknown-status orgs; don't include the connection status:
|
|
696
|
+
|
|
697
|
+
$ sf org:list --skip-connection-status --all
|
|
698
|
+
|
|
699
|
+
List orgs and remove local org authorization info about non-active scratch orgs:
|
|
700
|
+
|
|
701
|
+
$ sf org:list --clean
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/list.ts)_
|
|
913
705
|
|
|
914
706
|
## `sf org:list:metadata`
|
|
915
707
|
|
|
@@ -973,7 +765,7 @@ FLAG DESCRIPTIONS
|
|
|
973
765
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
974
766
|
```
|
|
975
767
|
|
|
976
|
-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
768
|
+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/list/metadata.ts)_
|
|
977
769
|
|
|
978
770
|
## `sf org:list:metadata-types`
|
|
979
771
|
|
|
@@ -1026,7 +818,7 @@ FLAG DESCRIPTIONS
|
|
|
1026
818
|
Override the api version used for api requests made by this command
|
|
1027
819
|
```
|
|
1028
820
|
|
|
1029
|
-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
821
|
+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/list/metadata-types.ts)_
|
|
1030
822
|
|
|
1031
823
|
## `sf org:open`
|
|
1032
824
|
|
|
@@ -1087,7 +879,7 @@ EXAMPLES
|
|
|
1087
879
|
$ sf org:open --source-path force-app/main/default/flexipages/Hello.flexipage-meta.xml
|
|
1088
880
|
```
|
|
1089
881
|
|
|
1090
|
-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
882
|
+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/open.ts)_
|
|
1091
883
|
|
|
1092
884
|
## `sf org:resume:sandbox`
|
|
1093
885
|
|
|
@@ -1149,7 +941,7 @@ FLAG DESCRIPTIONS
|
|
|
1149
941
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
1150
942
|
```
|
|
1151
943
|
|
|
1152
|
-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
944
|
+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/resume/sandbox.ts)_
|
|
1153
945
|
|
|
1154
946
|
## `sf org:resume:scratch`
|
|
1155
947
|
|
|
@@ -1195,6 +987,6 @@ FLAG DESCRIPTIONS
|
|
|
1195
987
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
1196
988
|
```
|
|
1197
989
|
|
|
1198
|
-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/
|
|
990
|
+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/2.10.9/src/commands/org/resume/scratch.ts)_
|
|
1199
991
|
|
|
1200
992
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
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": "2.10.
|
|
4
|
+
"version": "2.10.9",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"main": "lib/index.js",
|
|
7
7
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
@@ -10,25 +10,25 @@
|
|
|
10
10
|
"@salesforce/core": "^5.2.0",
|
|
11
11
|
"@salesforce/kit": "^3.0.9",
|
|
12
12
|
"@salesforce/sf-plugins-core": "^3.1.22",
|
|
13
|
-
"@salesforce/source-deploy-retrieve": "^9.7.
|
|
13
|
+
"@salesforce/source-deploy-retrieve": "^9.7.13",
|
|
14
14
|
"open": "^8.4.2",
|
|
15
15
|
"tslib": "^2"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"@oclif/plugin-command-snapshot": "^4.0.14",
|
|
19
|
-
"@salesforce/cli-plugins-testkit": "^4.3.
|
|
19
|
+
"@salesforce/cli-plugins-testkit": "^4.3.6",
|
|
20
20
|
"@salesforce/dev-config": "^4.0.1",
|
|
21
21
|
"@salesforce/dev-scripts": "^5.10.0",
|
|
22
|
-
"@salesforce/plugin-command-reference": "^3.0.
|
|
23
|
-
"@salesforce/plugin-source": "^2.10.
|
|
22
|
+
"@salesforce/plugin-command-reference": "^3.0.34",
|
|
23
|
+
"@salesforce/plugin-source": "^2.10.36",
|
|
24
24
|
"@salesforce/prettier-config": "^0.0.3",
|
|
25
|
-
"@salesforce/ts-sinon": "1.4.
|
|
25
|
+
"@salesforce/ts-sinon": "1.4.15",
|
|
26
26
|
"@swc/core": "1.3.39",
|
|
27
27
|
"@types/shelljs": "^0.8.12",
|
|
28
28
|
"@typescript-eslint/eslint-plugin": "^5.61.0",
|
|
29
29
|
"@typescript-eslint/parser": "^5.61.0",
|
|
30
30
|
"chai": "^4.3.7",
|
|
31
|
-
"eslint": "^8.
|
|
31
|
+
"eslint": "^8.49.0",
|
|
32
32
|
"eslint-config-prettier": "^8.10.0",
|
|
33
33
|
"eslint-config-salesforce": "^2.0.2",
|
|
34
34
|
"eslint-config-salesforce-license": "^0.2.0",
|
|
@@ -36,12 +36,12 @@
|
|
|
36
36
|
"eslint-plugin-header": "^3.1.1",
|
|
37
37
|
"eslint-plugin-import": "2.28.1",
|
|
38
38
|
"eslint-plugin-jsdoc": "^43.0.5",
|
|
39
|
-
"eslint-plugin-sf-plugin": "^1.16.
|
|
39
|
+
"eslint-plugin-sf-plugin": "^1.16.7",
|
|
40
40
|
"husky": "^7.0.4",
|
|
41
41
|
"mocha": "^10.2.0",
|
|
42
42
|
"moment": "^2.29.1",
|
|
43
43
|
"nyc": "^15.1.0",
|
|
44
|
-
"oclif": "^3.
|
|
44
|
+
"oclif": "^3.17.1",
|
|
45
45
|
"prettier": "^2.8.8",
|
|
46
46
|
"pretty-quick": "^3.1.0",
|
|
47
47
|
"shelljs": "^0.8.5",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"sinon": "10.0.0",
|
|
50
50
|
"ts-node": "^10.9.1",
|
|
51
51
|
"typescript": "^4.9.5",
|
|
52
|
-
"wireit": "^0.
|
|
52
|
+
"wireit": "^0.13.0"
|
|
53
53
|
},
|
|
54
54
|
"engines": {
|
|
55
55
|
"node": ">=16.0.0"
|
|
@@ -236,7 +236,7 @@
|
|
|
236
236
|
}
|
|
237
237
|
},
|
|
238
238
|
"sfdx": {
|
|
239
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/2.10.
|
|
240
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/2.10.
|
|
239
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/2.10.9.crt",
|
|
240
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/2.10.9.sig"
|
|
241
241
|
}
|
|
242
242
|
}
|