@salesforce/cli 2.23.19 → 2.23.20
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 +43 -280
- package/npm-shrinkwrap.json +13392 -15550
- package/oclif.manifest.json +1 -1
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
|
|
|
24
24
|
$ sf COMMAND
|
|
25
25
|
running command...
|
|
26
26
|
$ sf (--version|-v)
|
|
27
|
-
@salesforce/cli/2.23.
|
|
27
|
+
@salesforce/cli/2.23.20 linux-x64 node-v20.10.0
|
|
28
28
|
$ sf --help [COMMAND]
|
|
29
29
|
USAGE
|
|
30
30
|
$ sf COMMAND
|
|
@@ -81,10 +81,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
81
81
|
- [`sf force mdapi deploy report`](#sf-force-mdapi-deploy-report)
|
|
82
82
|
- [`sf force mdapi retrieve`](#sf-force-mdapi-retrieve)
|
|
83
83
|
- [`sf force mdapi retrieve report`](#sf-force-mdapi-retrieve-report)
|
|
84
|
-
- [`sf force org clone`](#sf-force-org-clone)
|
|
85
|
-
- [`sf force org create`](#sf-force-org-create)
|
|
86
|
-
- [`sf force org delete`](#sf-force-org-delete)
|
|
87
|
-
- [`sf force org status`](#sf-force-org-status)
|
|
88
84
|
- [`sf force source deploy`](#sf-force-source-deploy)
|
|
89
85
|
- [`sf force source deploy cancel`](#sf-force-source-deploy-cancel)
|
|
90
86
|
- [`sf force source deploy report`](#sf-force-source-deploy-report)
|
|
@@ -92,7 +88,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
92
88
|
- [`sf force source push`](#sf-force-source-push)
|
|
93
89
|
- [`sf force source retrieve`](#sf-force-source-retrieve)
|
|
94
90
|
- [`sf force source status`](#sf-force-source-status)
|
|
95
|
-
- [`sf force user password generate`](#sf-force-user-password-generate)
|
|
96
91
|
- [`sf help [COMMANDS]`](#sf-help-commands)
|
|
97
92
|
- [`sf info releasenotes display`](#sf-info-releasenotes-display)
|
|
98
93
|
- [`sf lightning generate app`](#sf-lightning-generate-app)
|
|
@@ -844,14 +839,15 @@ list all the commands
|
|
|
844
839
|
|
|
845
840
|
```
|
|
846
841
|
USAGE
|
|
847
|
-
$ sf commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter <value>]
|
|
848
|
-
[--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
|
|
842
|
+
$ sf commands [--json] [--deprecated] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter <value>]
|
|
843
|
+
[--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
|
|
849
844
|
|
|
850
845
|
FLAGS
|
|
851
846
|
-h, --help Show CLI help.
|
|
852
847
|
-x, --extended show extra columns
|
|
853
848
|
--columns=<value> only show provided columns (comma-separated)
|
|
854
849
|
--csv output is csv format [alias: --output=csv]
|
|
850
|
+
--deprecated show deprecated commands
|
|
855
851
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
856
852
|
--hidden show hidden commands
|
|
857
853
|
--no-header hide table header from output
|
|
@@ -868,7 +864,7 @@ DESCRIPTION
|
|
|
868
864
|
list all the commands
|
|
869
865
|
```
|
|
870
866
|
|
|
871
|
-
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.0
|
|
867
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/3.1.0/src/commands/commands.ts)_
|
|
872
868
|
|
|
873
869
|
## `sf config get`
|
|
874
870
|
|
|
@@ -2344,174 +2340,6 @@ FLAG DESCRIPTIONS
|
|
|
2344
2340
|
|
|
2345
2341
|
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/mdapi/retrieve/report.ts)_
|
|
2346
2342
|
|
|
2347
|
-
## `sf force org clone`
|
|
2348
|
-
|
|
2349
|
-
Clone a sandbox org.
|
|
2350
|
-
|
|
2351
|
-
```
|
|
2352
|
-
USAGE
|
|
2353
|
-
$ sf force org clone -o <value> -t sandbox [--json] [--api-version <value>] [-f <value>] [-s] [-a <value>] [-w
|
|
2354
|
-
<value>]
|
|
2355
|
-
|
|
2356
|
-
FLAGS
|
|
2357
|
-
-a, --setalias=<value> Alias for the cloned org.
|
|
2358
|
-
-f, --definitionfile=<value> Path to the sandbox definition file.
|
|
2359
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2360
|
-
configuration variable is already set.
|
|
2361
|
-
-s, --setdefaultusername Set the cloned org as your default.
|
|
2362
|
-
-t, --type=<option> (required) Type of org to create.
|
|
2363
|
-
<options: sandbox>
|
|
2364
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait while polling for status.
|
|
2365
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2366
|
-
|
|
2367
|
-
GLOBAL FLAGS
|
|
2368
|
-
--json Format output as json.
|
|
2369
|
-
|
|
2370
|
-
DESCRIPTION
|
|
2371
|
-
Clone a sandbox org.
|
|
2372
|
-
|
|
2373
|
-
There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the
|
|
2374
|
-
command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either
|
|
2375
|
-
case, you must specify both the "SandboxName" and "SourceSandboxName" options to set the names of the new sandbox and
|
|
2376
|
-
the one being cloned, respectively.
|
|
2377
|
-
|
|
2378
|
-
Set the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is
|
|
2379
|
-
required and must be set to "sandbox".
|
|
2380
|
-
|
|
2381
|
-
EXAMPLES
|
|
2382
|
-
$ sf force org clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
|
|
2383
|
-
|
|
2384
|
-
$ sf force org clone -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
|
|
2385
|
-
|
|
2386
|
-
FLAG DESCRIPTIONS
|
|
2387
|
-
-w, --wait=<value> Number of minutes to wait while polling for status.
|
|
2388
|
-
|
|
2389
|
-
Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server
|
|
2390
|
-
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
|
|
2391
|
-
```
|
|
2392
|
-
|
|
2393
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/clone.ts)_
|
|
2394
|
-
|
|
2395
|
-
## `sf force org create`
|
|
2396
|
-
|
|
2397
|
-
Create a scratch org or sandbox.
|
|
2398
|
-
|
|
2399
|
-
```
|
|
2400
|
-
USAGE
|
|
2401
|
-
$ sf force org create [--json] [-o <value>] [-v <value>] [--api-version <value>] [-t scratch|sandbox] [-f <value>]
|
|
2402
|
-
[-n] [-c] [-i <value>] [-s] [-a <value>] [-w <value>] [-d <value>]
|
|
2403
|
-
|
|
2404
|
-
FLAGS
|
|
2405
|
-
-a, --setalias=<value> Alias for the created org.
|
|
2406
|
-
-c, --noancestors Do not include second-generation package ancestors in the scratch org.
|
|
2407
|
-
-d, --durationdays=<value> [default: 7] Duration of the scratch org (in days) (default:7, min:1, max:30).
|
|
2408
|
-
-f, --definitionfile=<value> Path to an org definition file.
|
|
2409
|
-
-i, --clientid=<value> Connected app consumer key; not supported for sandbox org creation.
|
|
2410
|
-
-n, --nonamespace Create the scratch org with no namespace.
|
|
2411
|
-
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
|
|
2412
|
-
-s, --setdefaultusername Set the created org as the default username.
|
|
2413
|
-
-t, --type=<option> [default: scratch] Type of org to create.
|
|
2414
|
-
<options: scratch|sandbox>
|
|
2415
|
-
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration
|
|
2416
|
-
variable is already set.
|
|
2417
|
-
-w, --wait=<value> [default: [object Object]] Streaming client socket timeout (in minutes).
|
|
2418
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2419
|
-
|
|
2420
|
-
GLOBAL FLAGS
|
|
2421
|
-
--json Format output as json.
|
|
2422
|
-
|
|
2423
|
-
DESCRIPTION
|
|
2424
|
-
Create a scratch org or sandbox.
|
|
2425
|
-
|
|
2426
|
-
Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you
|
|
2427
|
-
specify on the command line. Values specified on the command line override values in the configuration file. Specify a
|
|
2428
|
-
configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs,
|
|
2429
|
-
—targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a
|
|
2430
|
-
production org with sandbox licenses. The —type (-t) is required if creating a sandbox.
|
|
2431
|
-
|
|
2432
|
-
EXAMPLES
|
|
2433
|
-
$ sf force org create -f config/enterprise-scratch-def.json -a MyScratchOrg
|
|
2434
|
-
|
|
2435
|
-
$ sf force org create edition=Developer -a MyScratchOrg -s -v devHub
|
|
2436
|
-
|
|
2437
|
-
$ sf force org create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org
|
|
2438
|
-
|
|
2439
|
-
$ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
|
|
2440
|
-
```
|
|
2441
|
-
|
|
2442
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/create.ts)_
|
|
2443
|
-
|
|
2444
|
-
## `sf force org delete`
|
|
2445
|
-
|
|
2446
|
-
Delete a scratch or sandbox org.
|
|
2447
|
-
|
|
2448
|
-
```
|
|
2449
|
-
USAGE
|
|
2450
|
-
$ sf force org delete -o <value> [--json] [--api-version <value>] [-p]
|
|
2451
|
-
|
|
2452
|
-
FLAGS
|
|
2453
|
-
-o, --target-org=<value> (required) Username or alias of the target org.
|
|
2454
|
-
-p, --no-prompt No prompt to confirm deletion.
|
|
2455
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2456
|
-
|
|
2457
|
-
GLOBAL FLAGS
|
|
2458
|
-
--json Format output as json.
|
|
2459
|
-
|
|
2460
|
-
DESCRIPTION
|
|
2461
|
-
Delete a scratch or sandbox org.
|
|
2462
|
-
|
|
2463
|
-
Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for
|
|
2464
|
-
sandboxes) and then deletes all local references to the org from your computer.
|
|
2465
|
-
|
|
2466
|
-
To mark the org for deletion without being prompted to confirm, specify --noprompt.
|
|
2467
|
-
|
|
2468
|
-
EXAMPLES
|
|
2469
|
-
$ sf force org delete -u me@my.org
|
|
2470
|
-
|
|
2471
|
-
$ sf force org delete -u MyOrgAlias -p
|
|
2472
|
-
```
|
|
2473
|
-
|
|
2474
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/delete.ts)_
|
|
2475
|
-
|
|
2476
|
-
## `sf force org status`
|
|
2477
|
-
|
|
2478
|
-
Check the status of a sandbox, and if complete, authenticate to it.
|
|
2479
|
-
|
|
2480
|
-
```
|
|
2481
|
-
USAGE
|
|
2482
|
-
$ sf force org status -o <value> -n <value> [--json] [--api-version <value>] [-s] [-a <value>] [-w <value>]
|
|
2483
|
-
|
|
2484
|
-
FLAGS
|
|
2485
|
-
-a, --setalias=<value> Alias for the created or cloned org.
|
|
2486
|
-
-n, --sandboxname=<value> (required) Name of the sandbox org to check status for.
|
|
2487
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
2488
|
-
configuration variable is already set.
|
|
2489
|
-
-s, --setdefaultusername Set the created or cloned org as your default.
|
|
2490
|
-
-w, --wait=<value> [default: [object Object]] Number of minutes to wait while polling for status.
|
|
2491
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
2492
|
-
|
|
2493
|
-
GLOBAL FLAGS
|
|
2494
|
-
--json Format output as json.
|
|
2495
|
-
|
|
2496
|
-
DESCRIPTION
|
|
2497
|
-
Check the status of a sandbox, and if complete, authenticate to it.
|
|
2498
|
-
|
|
2499
|
-
Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to
|
|
2500
|
-
it.
|
|
2501
|
-
|
|
2502
|
-
Use the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or
|
|
2503
|
-
clone to complete before returning control of the terminal to you.
|
|
2504
|
-
|
|
2505
|
-
Set the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.
|
|
2506
|
-
|
|
2507
|
-
EXAMPLES
|
|
2508
|
-
$ sf force org status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg
|
|
2509
|
-
|
|
2510
|
-
$ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
|
|
2511
|
-
```
|
|
2512
|
-
|
|
2513
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.1.7/src/commands/force/org/status.ts)_
|
|
2514
|
-
|
|
2515
2343
|
## `sf force source deploy`
|
|
2516
2344
|
|
|
2517
2345
|
Deploy source to an org.
|
|
@@ -3135,71 +2963,6 @@ EXAMPLES
|
|
|
3135
2963
|
|
|
3136
2964
|
_See code: [@salesforce/plugin-source](https://github.com/salesforcecli/plugin-source/blob/3.0.10/src/commands/force/source/status.ts)_
|
|
3137
2965
|
|
|
3138
|
-
## `sf force user password generate`
|
|
3139
|
-
|
|
3140
|
-
Generate a random password for scratch org users.
|
|
3141
|
-
|
|
3142
|
-
```
|
|
3143
|
-
USAGE
|
|
3144
|
-
$ sf force user password generate -u <value> [--json] [-o <value>] [-l <value>] [-c <value>] [--api-version <value>]
|
|
3145
|
-
|
|
3146
|
-
FLAGS
|
|
3147
|
-
-c, --complexity=<value> [default: 5] Level of password complexity or strength; the higher the value, the
|
|
3148
|
-
stronger the password.
|
|
3149
|
-
-l, --length=<value> [default: 13] Number of characters in the generated password; valid values are between
|
|
3150
|
-
8 and 100.
|
|
3151
|
-
-o, --on-behalf-of=<value>... Comma-separated list of usernames or aliases to assign the password to; must have been
|
|
3152
|
-
created locally with the "org create user" command.
|
|
3153
|
-
-u, --target-org=<value> (required) Scratch org alias or login user.
|
|
3154
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3155
|
-
|
|
3156
|
-
GLOBAL FLAGS
|
|
3157
|
-
--json Format output as json.
|
|
3158
|
-
|
|
3159
|
-
DESCRIPTION
|
|
3160
|
-
Generate a random password for scratch org users.
|
|
3161
|
-
|
|
3162
|
-
By default, new scratch orgs contain one admin user with no password. Use this command to generate or change a
|
|
3163
|
-
password for this admin user. After it's set, you can’t unset a password, you can only change it.
|
|
3164
|
-
|
|
3165
|
-
You can also use the --on-behalf-of flag to generate a password for a scratch org user that you've created locally
|
|
3166
|
-
with the "org create user" command. This command doesn't work for users you created in the scratch org using Setup.
|
|
3167
|
-
|
|
3168
|
-
To change the password strength, set the --complexity flag to a value between 0 and 5. Each value specifies the types
|
|
3169
|
-
of characters used in the generated password:
|
|
3170
|
-
|
|
3171
|
-
0 - lower case letters only
|
|
3172
|
-
1 - lower case letters and numbers only
|
|
3173
|
-
2 - lower case letters and symbols only
|
|
3174
|
-
3 - lower and upper case letters and numbers only
|
|
3175
|
-
4 - lower and upper case letters and symbols only
|
|
3176
|
-
5 - lower and upper case letters and numbers and symbols only
|
|
3177
|
-
|
|
3178
|
-
To see a password that was previously generated, run "org display user".
|
|
3179
|
-
|
|
3180
|
-
EXAMPLES
|
|
3181
|
-
Generate a password for the original admin user of your default scratch org:
|
|
3182
|
-
|
|
3183
|
-
$ sf force user password generate
|
|
3184
|
-
|
|
3185
|
-
Generate a password that contains 12 characters for the original admin user of the scratch org with alias
|
|
3186
|
-
"my-scratch":
|
|
3187
|
-
|
|
3188
|
-
$ sf force user password generate --length 12 --target-org my-scratch
|
|
3189
|
-
|
|
3190
|
-
Generate a password for your default scratch org admin user that uses lower and upper case letters and numbers only:
|
|
3191
|
-
|
|
3192
|
-
$ sf force user password generate --complexity 3
|
|
3193
|
-
|
|
3194
|
-
Generate a password for the specified users in the default scratch org; these users must have been created locally
|
|
3195
|
-
with the "org create user" command:
|
|
3196
|
-
|
|
3197
|
-
$ sf force user password generate --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of \
|
|
3198
|
-
user3@my.org
|
|
3199
|
-
```
|
|
3200
|
-
|
|
3201
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.1.5/src/commands/force/user/password/generate.ts)_
|
|
3202
|
-
|
|
3203
2966
|
## `sf help [COMMANDS]`
|
|
3204
2967
|
|
|
3205
2968
|
Display help for sf.
|
|
@@ -3580,7 +3343,7 @@ EXAMPLES
|
|
|
3580
3343
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
3581
3344
|
```
|
|
3582
3345
|
|
|
3583
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3346
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/assign/permset.ts)_
|
|
3584
3347
|
|
|
3585
3348
|
## `sf org assign permsetlicense`
|
|
3586
3349
|
|
|
@@ -3624,7 +3387,7 @@ EXAMPLES
|
|
|
3624
3387
|
user3
|
|
3625
3388
|
```
|
|
3626
3389
|
|
|
3627
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3390
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/assign/permsetlicense.ts)_
|
|
3628
3391
|
|
|
3629
3392
|
## `sf org create sandbox`
|
|
3630
3393
|
|
|
@@ -3729,7 +3492,7 @@ FLAG DESCRIPTIONS
|
|
|
3729
3492
|
sandbox.
|
|
3730
3493
|
```
|
|
3731
3494
|
|
|
3732
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3495
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/create/sandbox.ts)_
|
|
3733
3496
|
|
|
3734
3497
|
## `sf org create scratch`
|
|
3735
3498
|
|
|
@@ -3882,7 +3645,7 @@ FLAG DESCRIPTIONS
|
|
|
3882
3645
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
3883
3646
|
```
|
|
3884
3647
|
|
|
3885
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3648
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/create/scratch.ts)_
|
|
3886
3649
|
|
|
3887
3650
|
## `sf org create user`
|
|
3888
3651
|
|
|
@@ -3981,7 +3744,7 @@ FLAG DESCRIPTIONS
|
|
|
3981
3744
|
might be different than what you specify in the definition file.
|
|
3982
3745
|
```
|
|
3983
3746
|
|
|
3984
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3747
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/create/user.ts)_
|
|
3985
3748
|
|
|
3986
3749
|
## `sf org delete sandbox`
|
|
3987
3750
|
|
|
@@ -4025,7 +3788,7 @@ EXAMPLES
|
|
|
4025
3788
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
4026
3789
|
```
|
|
4027
3790
|
|
|
4028
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3791
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/delete/sandbox.ts)_
|
|
4029
3792
|
|
|
4030
3793
|
## `sf org delete scratch`
|
|
4031
3794
|
|
|
@@ -4067,7 +3830,7 @@ EXAMPLES
|
|
|
4067
3830
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
4068
3831
|
```
|
|
4069
3832
|
|
|
4070
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3833
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/delete/scratch.ts)_
|
|
4071
3834
|
|
|
4072
3835
|
## `sf org disable tracking`
|
|
4073
3836
|
|
|
@@ -4105,7 +3868,7 @@ EXAMPLES
|
|
|
4105
3868
|
$ sf org disable tracking
|
|
4106
3869
|
```
|
|
4107
3870
|
|
|
4108
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3871
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/disable/tracking.ts)_
|
|
4109
3872
|
|
|
4110
3873
|
## `sf org display`
|
|
4111
3874
|
|
|
@@ -4149,7 +3912,7 @@ EXAMPLES
|
|
|
4149
3912
|
$ sf org display --target-org TestOrg1 --verbose
|
|
4150
3913
|
```
|
|
4151
3914
|
|
|
4152
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3915
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/display.ts)_
|
|
4153
3916
|
|
|
4154
3917
|
## `sf org display user`
|
|
4155
3918
|
|
|
@@ -4187,7 +3950,7 @@ EXAMPLES
|
|
|
4187
3950
|
$ sf org display user --target-org me@my.org --json
|
|
4188
3951
|
```
|
|
4189
3952
|
|
|
4190
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
3953
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/display/user.ts)_
|
|
4191
3954
|
|
|
4192
3955
|
## `sf org enable tracking`
|
|
4193
3956
|
|
|
@@ -4228,7 +3991,7 @@ EXAMPLES
|
|
|
4228
3991
|
$ sf org enable tracking
|
|
4229
3992
|
```
|
|
4230
3993
|
|
|
4231
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
3994
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/enable/tracking.ts)_
|
|
4232
3995
|
|
|
4233
3996
|
## `sf org generate password`
|
|
4234
3997
|
|
|
@@ -4293,7 +4056,7 @@ EXAMPLES
|
|
|
4293
4056
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
4294
4057
|
```
|
|
4295
4058
|
|
|
4296
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
4059
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/generate/password.ts)_
|
|
4297
4060
|
|
|
4298
4061
|
## `sf org list`
|
|
4299
4062
|
|
|
@@ -4331,7 +4094,7 @@ EXAMPLES
|
|
|
4331
4094
|
$ sf org list --clean
|
|
4332
4095
|
```
|
|
4333
4096
|
|
|
4334
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4097
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list.ts)_
|
|
4335
4098
|
|
|
4336
4099
|
## `sf org list auth`
|
|
4337
4100
|
|
|
@@ -4362,7 +4125,7 @@ EXAMPLES
|
|
|
4362
4125
|
$ sf org list auth
|
|
4363
4126
|
```
|
|
4364
4127
|
|
|
4365
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
4128
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/list/auth.ts)_
|
|
4366
4129
|
|
|
4367
4130
|
## `sf org list limits`
|
|
4368
4131
|
|
|
@@ -4401,7 +4164,7 @@ EXAMPLES
|
|
|
4401
4164
|
$ sf org list limits --target-org my-scratch-org
|
|
4402
4165
|
```
|
|
4403
4166
|
|
|
4404
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0
|
|
4167
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.0/src/commands/org/list/limits.ts)_
|
|
4405
4168
|
|
|
4406
4169
|
## `sf org list metadata`
|
|
4407
4170
|
|
|
@@ -4466,7 +4229,7 @@ FLAG DESCRIPTIONS
|
|
|
4466
4229
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
4467
4230
|
```
|
|
4468
4231
|
|
|
4469
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4232
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list/metadata.ts)_
|
|
4470
4233
|
|
|
4471
4234
|
## `sf org list metadata-types`
|
|
4472
4235
|
|
|
@@ -4520,7 +4283,7 @@ FLAG DESCRIPTIONS
|
|
|
4520
4283
|
Override the api version used for api requests made by this command
|
|
4521
4284
|
```
|
|
4522
4285
|
|
|
4523
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4286
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list/metadata-types.ts)_
|
|
4524
4287
|
|
|
4525
4288
|
## `sf org list sobject record-counts`
|
|
4526
4289
|
|
|
@@ -4565,7 +4328,7 @@ EXAMPLES
|
|
|
4565
4328
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
4566
4329
|
```
|
|
4567
4330
|
|
|
4568
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.0
|
|
4331
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.1.0/src/commands/org/list/sobject/record-counts.ts)_
|
|
4569
4332
|
|
|
4570
4333
|
## `sf org list users`
|
|
4571
4334
|
|
|
@@ -4602,7 +4365,7 @@ EXAMPLES
|
|
|
4602
4365
|
$ sf org list users --target-org me@my.org
|
|
4603
4366
|
```
|
|
4604
4367
|
|
|
4605
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.
|
|
4368
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.2.0/src/commands/org/list/users.ts)_
|
|
4606
4369
|
|
|
4607
4370
|
## `sf org login access-token`
|
|
4608
4371
|
|
|
@@ -4655,7 +4418,7 @@ FLAG DESCRIPTIONS
|
|
|
4655
4418
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4656
4419
|
```
|
|
4657
4420
|
|
|
4658
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
4421
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/access-token.ts)_
|
|
4659
4422
|
|
|
4660
4423
|
## `sf org login device`
|
|
4661
4424
|
|
|
@@ -4714,7 +4477,7 @@ FLAG DESCRIPTIONS
|
|
|
4714
4477
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4715
4478
|
```
|
|
4716
4479
|
|
|
4717
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
4480
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/device.ts)_
|
|
4718
4481
|
|
|
4719
4482
|
## `sf org login jwt`
|
|
4720
4483
|
|
|
@@ -4770,7 +4533,7 @@ ALIASES
|
|
|
4770
4533
|
$ sf auth jwt grant
|
|
4771
4534
|
|
|
4772
4535
|
EXAMPLES
|
|
4773
|
-
Log into an org with username jdoe@example.org and on the default instance URL (https://login.salesforce.
|
|
4536
|
+
Log into an org with username jdoe@example.org and on the default instance URL (https://login.salesforce.com). The
|
|
4774
4537
|
private key is stored in the file /Users/jdoe/JWT/server.key and the command uses the connected app with consumer
|
|
4775
4538
|
key (client id) 04580y4051234051.
|
|
4776
4539
|
|
|
@@ -4803,7 +4566,7 @@ FLAG DESCRIPTIONS
|
|
|
4803
4566
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4804
4567
|
```
|
|
4805
4568
|
|
|
4806
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
4569
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/jwt.ts)_
|
|
4807
4570
|
|
|
4808
4571
|
## `sf org login sfdx-url`
|
|
4809
4572
|
|
|
@@ -4861,7 +4624,7 @@ EXAMPLES
|
|
|
4861
4624
|
$ sf org login sfdx-url --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg
|
|
4862
4625
|
```
|
|
4863
4626
|
|
|
4864
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
4627
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/sfdx-url.ts)_
|
|
4865
4628
|
|
|
4866
4629
|
## `sf org login web`
|
|
4867
4630
|
|
|
@@ -4946,7 +4709,7 @@ FLAG DESCRIPTIONS
|
|
|
4946
4709
|
To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
|
|
4947
4710
|
```
|
|
4948
4711
|
|
|
4949
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
4712
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/login/web.ts)_
|
|
4950
4713
|
|
|
4951
4714
|
## `sf org logout`
|
|
4952
4715
|
|
|
@@ -5006,7 +4769,7 @@ FLAG DESCRIPTIONS
|
|
|
5006
4769
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
5007
4770
|
```
|
|
5008
4771
|
|
|
5009
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.0
|
|
4772
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.1.0/src/commands/org/logout.ts)_
|
|
5010
4773
|
|
|
5011
4774
|
## `sf org open`
|
|
5012
4775
|
|
|
@@ -5072,7 +4835,7 @@ EXAMPLES
|
|
|
5072
4835
|
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
|
|
5073
4836
|
```
|
|
5074
4837
|
|
|
5075
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4838
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/open.ts)_
|
|
5076
4839
|
|
|
5077
4840
|
## `sf org resume sandbox`
|
|
5078
4841
|
|
|
@@ -5134,7 +4897,7 @@ FLAG DESCRIPTIONS
|
|
|
5134
4897
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
5135
4898
|
```
|
|
5136
4899
|
|
|
5137
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4900
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/resume/sandbox.ts)_
|
|
5138
4901
|
|
|
5139
4902
|
## `sf org resume scratch`
|
|
5140
4903
|
|
|
@@ -5180,7 +4943,7 @@ FLAG DESCRIPTIONS
|
|
|
5180
4943
|
The job ID is valid for 24 hours after you start the scratch org creation.
|
|
5181
4944
|
```
|
|
5182
4945
|
|
|
5183
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.
|
|
4946
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/resume/scratch.ts)_
|
|
5184
4947
|
|
|
5185
4948
|
## `sf package1 version create`
|
|
5186
4949
|
|
|
@@ -6376,7 +6139,7 @@ EXAMPLES
|
|
|
6376
6139
|
$ sf plugins
|
|
6377
6140
|
```
|
|
6378
6141
|
|
|
6379
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
6142
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/index.ts)_
|
|
6380
6143
|
|
|
6381
6144
|
## `sf plugins discover`
|
|
6382
6145
|
|
|
@@ -6420,7 +6183,7 @@ EXAMPLES
|
|
|
6420
6183
|
$ sf plugins inspect myplugin
|
|
6421
6184
|
```
|
|
6422
6185
|
|
|
6423
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
6186
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/inspect.ts)_
|
|
6424
6187
|
|
|
6425
6188
|
## `sf plugins:install PLUGIN...`
|
|
6426
6189
|
|
|
@@ -6464,7 +6227,7 @@ EXAMPLES
|
|
|
6464
6227
|
$ sf plugins install someuser/someplugin
|
|
6465
6228
|
```
|
|
6466
6229
|
|
|
6467
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
6230
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/install.ts)_
|
|
6468
6231
|
|
|
6469
6232
|
## `sf plugins:link PLUGIN`
|
|
6470
6233
|
|
|
@@ -6494,7 +6257,7 @@ EXAMPLES
|
|
|
6494
6257
|
$ sf plugins link myplugin
|
|
6495
6258
|
```
|
|
6496
6259
|
|
|
6497
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
6260
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/link.ts)_
|
|
6498
6261
|
|
|
6499
6262
|
## `sf plugins reset`
|
|
6500
6263
|
|
|
@@ -6505,7 +6268,7 @@ USAGE
|
|
|
6505
6268
|
$ sf plugins reset
|
|
6506
6269
|
```
|
|
6507
6270
|
|
|
6508
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
6271
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/reset.ts)_
|
|
6509
6272
|
|
|
6510
6273
|
## `sf plugins trust verify`
|
|
6511
6274
|
|
|
@@ -6561,7 +6324,7 @@ EXAMPLES
|
|
|
6561
6324
|
$ sf plugins uninstall myplugin
|
|
6562
6325
|
```
|
|
6563
6326
|
|
|
6564
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
6327
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/uninstall.ts)_
|
|
6565
6328
|
|
|
6566
6329
|
## `sf plugins update`
|
|
6567
6330
|
|
|
@@ -6579,7 +6342,7 @@ DESCRIPTION
|
|
|
6579
6342
|
Update installed plugins.
|
|
6580
6343
|
```
|
|
6581
6344
|
|
|
6582
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.
|
|
6345
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/4.1.14/src/commands/plugins/update.ts)_
|
|
6583
6346
|
|
|
6584
6347
|
## `sf project convert mdapi`
|
|
6585
6348
|
|
|
@@ -8454,7 +8217,7 @@ EXAMPLES
|
|
|
8454
8217
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
8455
8218
|
```
|
|
8456
8219
|
|
|
8457
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0
|
|
8220
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.0/src/commands/sobject/describe.ts)_
|
|
8458
8221
|
|
|
8459
8222
|
## `sf sobject list`
|
|
8460
8223
|
|
|
@@ -8492,7 +8255,7 @@ EXAMPLES
|
|
|
8492
8255
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
8493
8256
|
```
|
|
8494
8257
|
|
|
8495
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.0
|
|
8258
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.1.0/src/commands/sobject/list.ts)_
|
|
8496
8259
|
|
|
8497
8260
|
## `sf static-resource generate`
|
|
8498
8261
|
|