@salesforce/plugin-auth 2.6.1 → 2.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/lib/commands/{auth/list.d.ts → org/list/auth.d.ts} +1 -1
  2. package/lib/commands/{auth/list.js → org/list/auth.js} +10 -10
  3. package/lib/commands/org/list/auth.js.map +1 -0
  4. package/lib/commands/{auth/accesstoken/store.d.ts → org/login/access-token.d.ts} +1 -1
  5. package/lib/commands/{auth/accesstoken/store.js → org/login/access-token.js} +17 -16
  6. package/lib/commands/org/login/access-token.js.map +1 -0
  7. package/lib/commands/{auth/device/login.d.ts → org/login/device.d.ts} +1 -1
  8. package/lib/commands/{auth/device/login.js → org/login/device.js} +16 -18
  9. package/lib/commands/org/login/device.js.map +1 -0
  10. package/lib/commands/{auth/jwt/grant.d.ts → org/login/jwt.d.ts} +1 -1
  11. package/lib/commands/{auth/jwt/grant.js → org/login/jwt.js} +21 -20
  12. package/lib/commands/org/login/jwt.js.map +1 -0
  13. package/lib/commands/{auth/sfdxurl/store.d.ts → org/login/sfdx-url.d.ts} +1 -1
  14. package/lib/commands/{auth/sfdxurl/store.js → org/login/sfdx-url.js} +14 -14
  15. package/lib/commands/org/login/sfdx-url.js.map +1 -0
  16. package/lib/commands/{auth/web/login.d.ts → org/login/web.d.ts} +1 -1
  17. package/lib/commands/{auth/web/login.js → org/login/web.js} +22 -20
  18. package/lib/commands/org/login/web.js.map +1 -0
  19. package/lib/commands/{auth → org}/logout.d.ts +2 -1
  20. package/lib/commands/org/logout.js +188 -0
  21. package/lib/commands/org/logout.js.map +1 -0
  22. package/messages/accesstoken.store.md +7 -5
  23. package/messages/device.login.md +14 -7
  24. package/messages/jwt.grant.md +31 -11
  25. package/messages/list.md +6 -4
  26. package/messages/logout.md +54 -18
  27. package/messages/messages.md +23 -15
  28. package/messages/sfdxurl.store.md +18 -12
  29. package/messages/web.login.md +31 -11
  30. package/oclif.manifest.json +145 -126
  31. package/package.json +56 -39
  32. package/lib/commands/auth/accesstoken/store.js.map +0 -1
  33. package/lib/commands/auth/device/login.js.map +0 -1
  34. package/lib/commands/auth/jwt/grant.js.map +0 -1
  35. package/lib/commands/auth/list.js.map +0 -1
  36. package/lib/commands/auth/logout.js +0 -98
  37. package/lib/commands/auth/logout.js.map +0 -1
  38. package/lib/commands/auth/sfdxurl/store.js.map +0 -1
  39. package/lib/commands/auth/web/login.js.map +0 -1
package/oclif.manifest.json CHANGED
@@ -1,58 +1,23 @@
1
1
  {
2
- "version": "2.6.1",
2
+ "version": "2.7.1",
3
3
  "commands": {
4
- "auth:list": {
5
- "id": "auth:list",
6
- "summary": "List auth connection information",
7
- "description": "list auth connection information",
4
+ "org:logout": {
5
+ "id": "org:logout",
6
+ "summary": "Log out of a Salesforce org.",
7
+ "description": "If you run this command with no flags, it first displays a list of orgs you've created or logged into, with none of the orgs selected. Use the arrow keys to scroll through the list and the space bar to select the orgs you want to log out of. Press Enter when you're done; the command asks for a final confirmation before logging out of the selected orgs.\n\nThe process is similar if you specify --all, except that in the initial list of orgs, they're all selected. Use --target-org to logout of a specific org. In both these cases by default, you must still confirm that you want to log out. Use --no-prompt to never be asked for confirmation when also using --all or --target-org.\n\nBe careful! If you log out of a scratch org without having access to its password, you can't access the scratch org again, either through the CLI or the Salesforce UI.",
8
8
  "strict": true,
9
9
  "pluginName": "@salesforce/plugin-auth",
10
10
  "pluginAlias": "@salesforce/plugin-auth",
11
11
  "pluginType": "core",
12
12
  "aliases": [
13
- "force:auth:list"
13
+ "force:auth:logout",
14
+ "auth:logout"
14
15
  ],
15
16
  "examples": [
16
- "$ <%= config.bin %> <%= command.id %>"
17
- ],
18
- "deprecateAliases": true,
19
- "flags": {
20
- "json": {
21
- "name": "json",
22
- "type": "boolean",
23
- "description": "Format output as json.",
24
- "helpGroup": "GLOBAL",
25
- "allowNo": false,
26
- "deprecateAliases": true
27
- },
28
- "loglevel": {
29
- "name": "loglevel",
30
- "type": "option",
31
- "hidden": true,
32
- "multiple": false,
33
- "deprecated": {
34
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
35
- },
36
- "deprecateAliases": true
37
- }
38
- },
39
- "args": {}
40
- },
41
- "auth:logout": {
42
- "id": "auth:logout",
43
- "summary": "log out from authorized orgs",
44
- "description": "log out from authorized orgs\nBy default, this command logs you out from your default scratch org.",
45
- "strict": true,
46
- "pluginName": "@salesforce/plugin-auth",
47
- "pluginAlias": "@salesforce/plugin-auth",
48
- "pluginType": "core",
49
- "aliases": [
50
- "force:auth:logout"
51
- ],
52
- "examples": [
53
- "$ <%= config.bin %> <%= command.id %> -o me@my.org",
54
- "$ <%= config.bin %> <%= command.id %> -a",
55
- "$ <%= config.bin %> <%= command.id %> -p"
17
+ "Interactively select the orgs to log out of:\n<%= config.bin %> <%= command.id %>",
18
+ "Log out of the org with username me@my.org:\n<%= config.bin %> <%= command.id %> --target-org me@my.org",
19
+ "Log out of all orgs after confirmation:\n<%= config.bin %> <%= command.id %> --all",
20
+ "Logout of the org with alias my-scratch and don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --target-org my-scratch --no-prompt"
56
21
  ],
57
22
  "deprecateAliases": true,
58
23
  "flags": {
@@ -80,8 +45,8 @@
80
45
  "name": "all",
81
46
  "type": "boolean",
82
47
  "char": "a",
83
- "summary": "include all authenticated orgs",
84
- "description": "Includes all authenticated orgs: for example, Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.",
48
+ "summary": "Include all authenticated orgs.",
49
+ "description": "All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.",
85
50
  "required": false,
86
51
  "allowNo": false,
87
52
  "exclusive": [
@@ -93,7 +58,7 @@
93
58
  "name": "no-prompt",
94
59
  "type": "boolean",
95
60
  "char": "p",
96
- "summary": "do not prompt for confirmation",
61
+ "summary": "Don't prompt for confirmation.",
97
62
  "required": false,
98
63
  "allowNo": false,
99
64
  "deprecateAliases": true,
@@ -114,21 +79,59 @@
114
79
  },
115
80
  "args": {}
116
81
  },
117
- "auth:accesstoken:store": {
118
- "id": "auth:accesstoken:store",
119
- "summary": "authorize an org using an existing Salesforce access token",
120
- "description": "authorize an org using an existing Salesforce access token\nBy default, the command runs interactively and asks you for the access token. If you previously authorized the org, the command prompts whether you want to overwrite the local file. Specify --no-prompt to not be prompted.\nTo use the command in a CI/CD script, set the SFDX_ACCESS_TOKEN environment variable to the access token. Then run the command with the --no-prompt parameter.",
82
+ "org:list:auth": {
83
+ "id": "org:list:auth",
84
+ "summary": "List authorization information about the orgs you created or logged into.",
85
+ "description": "This command uses local authorization information that Salesforce CLI caches when you create a scratch org or log into an org. The command doesn't actually connect to the orgs to verify that they're still active. As a result, this command executes very quickly. If you want to view live information about your authorized orgs, such as their connection status, use the \"org list\" command.",
86
+ "strict": true,
87
+ "pluginName": "@salesforce/plugin-auth",
88
+ "pluginAlias": "@salesforce/plugin-auth",
89
+ "pluginType": "core",
90
+ "aliases": [
91
+ "force:auth:list",
92
+ "auth:list"
93
+ ],
94
+ "examples": [
95
+ "List local authorization information about your orgs:\n<%= config.bin %> <%= command.id %>"
96
+ ],
97
+ "deprecateAliases": true,
98
+ "flags": {
99
+ "json": {
100
+ "name": "json",
101
+ "type": "boolean",
102
+ "description": "Format output as json.",
103
+ "helpGroup": "GLOBAL",
104
+ "allowNo": false,
105
+ "deprecateAliases": true
106
+ },
107
+ "loglevel": {
108
+ "name": "loglevel",
109
+ "type": "option",
110
+ "hidden": true,
111
+ "multiple": false,
112
+ "deprecated": {
113
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
114
+ },
115
+ "deprecateAliases": true
116
+ }
117
+ },
118
+ "args": {}
119
+ },
120
+ "org:login:access-token": {
121
+ "id": "org:login:access-token",
122
+ "summary": "Authorize an org using an existing Salesforce access token.",
123
+ "description": "By default, the command runs interactively and asks you for the access token. If you previously authorized the org, the command prompts whether you want to overwrite the local file. Specify --no-prompt to not be prompted.\n\nTo use the command in a CI/CD script, set the SFDX_ACCESS_TOKEN environment variable to the access token. Then run the command with the --no-prompt parameter.",
121
124
  "strict": true,
122
125
  "pluginName": "@salesforce/plugin-auth",
123
126
  "pluginAlias": "@salesforce/plugin-auth",
124
127
  "pluginType": "core",
125
128
  "aliases": [
126
- "force:auth:accesstoken:store"
129
+ "force:auth:accesstoken:store",
130
+ "auth:accesstoken:store"
127
131
  ],
128
132
  "examples": [
129
- "$ <%= config.bin %> <%= command.id %> --instance-url https://mycompany.my.salesforce.com",
130
- "$ export SFDX_ACCESS_TOKEN=00Dxx0000000000!xxxxx",
131
- "$ <%= config.bin %> <%= command.id %> --instance-url https://dev-hub.my.salesforce.com --no-prompt"
133
+ "Authorize an org on https://mycompany.my.salesforce.com; the command prompts you for the access token:\n<%= config.bin %> <%= command.id %> --instance-url https://mycompany.my.salesforce.com",
134
+ "Authorize the org without being prompted; you must have previously set the SFDX_ACCESS_TOKEN environment variable to the access token:\n<%= config.bin %> <%= command.id %> --instance-url https://dev-hub.my.salesforce.com --no-prompt"
132
135
  ],
133
136
  "deprecateAliases": true,
134
137
  "flags": {
@@ -144,7 +147,8 @@
144
147
  "name": "instance-url",
145
148
  "type": "option",
146
149
  "char": "r",
147
- "summary": "the login URL of the instance the org lives on",
150
+ "summary": "URL of the instance that the org lives on.",
151
+ "description": "If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.\n\nTo specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.\n\nTo specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.",
148
152
  "required": true,
149
153
  "multiple": false,
150
154
  "deprecateAliases": true,
@@ -156,7 +160,7 @@
156
160
  "name": "set-default-dev-hub",
157
161
  "type": "boolean",
158
162
  "char": "d",
159
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
163
+ "summary": "Set the authenticated org as the default Dev Hub.",
160
164
  "allowNo": false,
161
165
  "deprecateAliases": true,
162
166
  "aliases": [
@@ -168,7 +172,7 @@
168
172
  "name": "set-default",
169
173
  "type": "boolean",
170
174
  "char": "s",
171
- "summary": "set the authenticated org as the default username that all commands run against",
175
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
172
176
  "allowNo": false,
173
177
  "deprecateAliases": true,
174
178
  "aliases": [
@@ -179,7 +183,7 @@
179
183
  "name": "alias",
180
184
  "type": "option",
181
185
  "char": "a",
182
- "summary": "set an alias for the authenticated org",
186
+ "summary": "Alias for the org.",
183
187
  "multiple": false,
184
188
  "deprecateAliases": true,
185
189
  "aliases": [
@@ -190,7 +194,7 @@
190
194
  "name": "no-prompt",
191
195
  "type": "boolean",
192
196
  "char": "p",
193
- "summary": "do not prompt for confirmation",
197
+ "summary": "Don't prompt for confirmation.",
194
198
  "required": false,
195
199
  "allowNo": false,
196
200
  "deprecateAliases": true,
@@ -211,21 +215,22 @@
211
215
  },
212
216
  "args": {}
213
217
  },
214
- "auth:device:login": {
215
- "id": "auth:device:login",
216
- "summary": "authorize an org using a device code",
217
- "description": "authorize an org using a device code\nYou must open a browser, navigate to the verification URL, and enter the code. Log in, if not already logged in, and you’ll be prompted to allow the device to connect to the org.",
218
+ "org:login:device": {
219
+ "id": "org:login:device",
220
+ "summary": "Authorize an org using a device code.",
221
+ "description": "Use this command to allow a device to connect to an org.\n\nWhen you run this command, it first displays an 8-digit device code and the URL for verifying the code on your org. The default instance URL is https://login.salesforce.com, so if the org you're authorizing is on a different instance, use the --instance-url. The command waits while you complete the verification. Open a browser and navigate to the displayed verification URL, enter the code, then click Connect. If you aren't already logged into your org, log in, and then you're prompted to allow the device to connect to the org. After you successfully authorize the org, you can close the browser window.",
218
222
  "strict": true,
219
223
  "pluginName": "@salesforce/plugin-auth",
220
224
  "pluginAlias": "@salesforce/plugin-auth",
221
225
  "pluginType": "core",
222
226
  "aliases": [
223
- "force:auth:device:login"
227
+ "force:auth:device:login",
228
+ "auth:device:login"
224
229
  ],
225
230
  "examples": [
226
- "$ <%= config.bin %> <%= command.id %> -d -a TestOrg1",
227
- "$ <%= config.bin %> <%= command.id %> -i <OAuth client id>",
228
- "$ <%= config.bin %> <%= command.id %> -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com"
231
+ "Authorize an org using a device code, give the org the alias TestOrg1, and set it as your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --set-default-dev-hub --alias TestOrg1",
232
+ "Authorize an org in which you've created a custom connected app with the specified client ID (consumer key):\n<%= config.bin %> <%= command.id %> --client-id <OAuth client id>",
233
+ "Authorize a sandbox org with the specified instance URL:\n<%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com"
229
234
  ],
230
235
  "flags": {
231
236
  "json": {
@@ -239,7 +244,7 @@
239
244
  "name": "client-id",
240
245
  "type": "option",
241
246
  "char": "i",
242
- "summary": "OAuth client ID (sometimes called the consumer key)",
247
+ "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
243
248
  "multiple": false,
244
249
  "aliases": [
245
250
  "clientid"
@@ -249,7 +254,8 @@
249
254
  "name": "instance-url",
250
255
  "type": "option",
251
256
  "char": "r",
252
- "summary": "the login URL of the instance the org lives on",
257
+ "summary": "URL of the instance that the org lives on.",
258
+ "description": "If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.\n\nTo specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.\n\nTo specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.",
253
259
  "multiple": false,
254
260
  "aliases": [
255
261
  "instanceurl"
@@ -259,7 +265,7 @@
259
265
  "name": "set-default-dev-hub",
260
266
  "type": "boolean",
261
267
  "char": "d",
262
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
268
+ "summary": "Set the authenticated org as the default Dev Hub.",
263
269
  "allowNo": false,
264
270
  "aliases": [
265
271
  "setdefaultdevhub",
@@ -270,7 +276,7 @@
270
276
  "name": "set-default",
271
277
  "type": "boolean",
272
278
  "char": "s",
273
- "summary": "set the authenticated org as the default username that all commands run against",
279
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
274
280
  "allowNo": false,
275
281
  "aliases": [
276
282
  "setdefaultusername"
@@ -280,7 +286,7 @@
280
286
  "name": "alias",
281
287
  "type": "option",
282
288
  "char": "a",
283
- "summary": "set an alias for the authenticated org",
289
+ "summary": "Alias for the org.",
284
290
  "multiple": false,
285
291
  "aliases": [
286
292
  "setalias"
@@ -289,7 +295,7 @@
289
295
  "disable-masking": {
290
296
  "name": "disable-masking",
291
297
  "type": "boolean",
292
- "summary": "disable masking of user input (for use with problematic terminals)",
298
+ "summary": "Disable masking of user input; use with problematic terminals.",
293
299
  "hidden": true,
294
300
  "allowNo": false,
295
301
  "aliases": [
@@ -308,21 +314,23 @@
308
314
  },
309
315
  "args": {}
310
316
  },
311
- "auth:jwt:grant": {
312
- "id": "auth:jwt:grant",
313
- "summary": "authorize an org using the JWT flow",
314
- "description": "authorize an org using the JWT flow\nUse a certificate associated with your private key that has been uploaded to a personal connected app.\nIf you specify an --instanc-eurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.",
317
+ "org:login:jwt": {
318
+ "id": "org:login:jwt",
319
+ "summary": "Log in to a Salesforce org using a JSON web token (JWT).",
320
+ "description": "Use this command in automated environments where you can’t interactively log in with a browser, such as in CI/CD scripts.\n\nLogging into an org authorizes the CLI to run other commands that connect to that org, such as deploying or retrieving a project. You can log into many types of orgs, such as sandboxes, Dev Hubs, Env Hubs, production orgs, and scratch orgs.\n\nComplete these steps before you run this command:\n\n 1. Create a digital certificate (also called digital signature) and the private key to sign the certificate. You can use your own key and certificate issued by a certification authority. Or use OpenSSL to create a key and a self-signed digital certificate.\n 2. Store the private key in a file on your computer. When you run this command, you set the --jwt-key-file flag to this file.\n 3. Create a custom connected app in your org using the digital certificate. Make note of the consumer key (also called client id) that’s generated for you. Be sure the username of the user logging in is approved to use the connected app. When you run this command, you set the --client-id flag to the consumer key.\n\nSee https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_jwt_flow.htm for more information.\n\nWe recommend that you set an alias when you log into an org. Aliases make it easy to later reference this org when running commands that require it. If you don’t set an alias, you use the username that you specified when you logged in to the org. If you run multiple commands that reference the same org, consider setting the org as your default. Use --set-default for your default scratch org or sandbox, or --set-default-dev-hub for your default Dev Hub.",
315
321
  "strict": true,
316
322
  "pluginName": "@salesforce/plugin-auth",
317
323
  "pluginAlias": "@salesforce/plugin-auth",
318
324
  "pluginType": "core",
319
325
  "aliases": [
320
- "force:auth:jwt:grant"
326
+ "force:auth:jwt:grant",
327
+ "auth:jwt:grant"
321
328
  ],
322
329
  "examples": [
323
- "$ <%= config.bin %> <%= command.id %> -o me@my.org -f <path to jwt key file> -i <OAuth client id>",
324
- "$ <%= config.bin %> <%= command.id %> -o me@my.org -f <path to jwt key file> -i <OAuth client id> -s -a MyDefaultOrg",
325
- "$ <%= config.bin %> <%= command.id %> -o me@acme.org -f <path to jwt key file> -i <OAuth client id> -r https://acme.my.salesforce.com"
330
+ "Log into an org with username jdoe@example.org and on the default instance URL (https://login.salesforce.org). The private key is stored in the file /Users/jdoe/JWT/server.key and the command uses the connected app with consumer key (client id) 04580y4051234051.\n<%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051",
331
+ "Set the org as the default and give it an alias:\n<%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051 --alias ci-org --set-default",
332
+ "Set the org as the default Dev Hub and give it an alias:\n<%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051 --alias ci-dev-hub --set-default-dev-hub",
333
+ "Log in to a sandbox using URL https://MyDomainName--SandboxName.sandbox.my.salesforce.com:\n<%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051 --alias ci-org --set-default --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com"
326
334
  ],
327
335
  "flags": {
328
336
  "json": {
@@ -336,7 +344,7 @@
336
344
  "name": "username",
337
345
  "type": "option",
338
346
  "char": "o",
339
- "summary": "authentication username",
347
+ "summary": "Username of the user logging in.",
340
348
  "required": true,
341
349
  "multiple": false,
342
350
  "aliases": [
@@ -347,18 +355,19 @@
347
355
  "name": "jwt-key-file",
348
356
  "type": "option",
349
357
  "char": "f",
350
- "summary": "path to a file containing the private key",
358
+ "summary": "Path to a file containing the private key.",
351
359
  "required": true,
352
360
  "multiple": false,
353
361
  "aliases": [
354
- "jwtkeyfile"
362
+ "jwtkeyfile",
363
+ "keyfile"
355
364
  ]
356
365
  },
357
366
  "client-id": {
358
367
  "name": "client-id",
359
368
  "type": "option",
360
369
  "char": "i",
361
- "summary": "OAuth client ID (sometimes called the consumer key)",
370
+ "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
362
371
  "required": true,
363
372
  "multiple": false,
364
373
  "aliases": [
@@ -369,28 +378,31 @@
369
378
  "name": "instance-url",
370
379
  "type": "option",
371
380
  "char": "r",
372
- "summary": "the login URL of the instance the org lives on",
381
+ "summary": "URL of the instance that the org lives on.",
382
+ "description": "If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.\n\nTo specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.\n\nTo specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.",
373
383
  "multiple": false,
374
384
  "aliases": [
375
- "instanceurl"
385
+ "instanceurl",
386
+ "l"
376
387
  ]
377
388
  },
378
389
  "set-default-dev-hub": {
379
390
  "name": "set-default-dev-hub",
380
391
  "type": "boolean",
381
392
  "char": "d",
382
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
393
+ "summary": "Set the authenticated org as the default Dev Hub.",
383
394
  "allowNo": false,
384
395
  "aliases": [
385
396
  "setdefaultdevhub",
386
- "setdefaultdevhubusername"
397
+ "setdefaultdevhubusername",
398
+ "v"
387
399
  ]
388
400
  },
389
401
  "set-default": {
390
402
  "name": "set-default",
391
403
  "type": "boolean",
392
404
  "char": "s",
393
- "summary": "set the authenticated org as the default username that all commands run against",
405
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
394
406
  "allowNo": false,
395
407
  "aliases": [
396
408
  "setdefaultusername"
@@ -400,7 +412,7 @@
400
412
  "name": "alias",
401
413
  "type": "option",
402
414
  "char": "a",
403
- "summary": "set an alias for the authenticated org",
415
+ "summary": "Alias for the org.",
404
416
  "multiple": false,
405
417
  "aliases": [
406
418
  "setalias"
@@ -410,7 +422,7 @@
410
422
  "name": "no-prompt",
411
423
  "type": "boolean",
412
424
  "char": "p",
413
- "summary": "do not prompt for auth confirmation in demo mode",
425
+ "summary": "Don't prompt for confirmation.",
414
426
  "hidden": true,
415
427
  "required": false,
416
428
  "allowNo": false,
@@ -430,20 +442,21 @@
430
442
  },
431
443
  "args": {}
432
444
  },
433
- "auth:sfdxurl:store": {
434
- "id": "auth:sfdxurl:store",
435
- "summary": "authorize an org using an SFDX auth URL stored within a file",
436
- "description": "authorize an org using an SFDX auth URL stored within a file\nThe SFDX auth URL must have the format \"force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>\". NOTE: The SFDX auth URL uses the \"force\" protocol, and not \"http\" or \"https\". Also, the \"instanceUrl\" inside the SFDX auth URL doesn't include the protocol (\"https://\").\n\nYou have three options when creating the auth file. The easiest option is to redirect the output of the `<%= config.bin %> org:display --verbose --json` command into a file. For example, using an org you have already authorized:\n\n $ <%= config.bin %> org:display -o <OrgUsername> --verbose --json > authFile.json\n $ <%= config.bin %> <%= command.id %> -f authFile.json\n\nThe resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object. NOTE: The `org:display --verbose` command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow.\n\nYou can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the auth URL. Finally, you can create a normal text file that includes just the URL and nothing else.",
445
+ "org:login:sfdx-url": {
446
+ "id": "org:login:sfdx-url",
447
+ "summary": "Authorize an org using a Salesforce DX authorization URL stored in a file.",
448
+ "description": "The Salesforce DX (SFDX) authorization URL must have the format \"force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>\". NOTE: The SFDX authorization URL uses the \"force\" protocol, and not \"http\" or \"https\". Also, the \"instanceUrl\" inside the SFDX authorization URL doesn't include the protocol (\"https://\").\n\nYou have three options when creating the authorization file. The easiest option is to redirect the output of the \"<%= config.bin %> org display --verbose --json\" command into a file. For example, using an org with alias my-org that you've already authorized:\n\n $ <%= config.bin %> org display --target-org my-org --verbose --json > authFile.json\n\nThe resulting JSON file contains the URL in the \"sfdxAuthUrl\" property of the \"result\" object. You can then reference the file when running this command:\n\n $ <%= config.bin %> <%= command.id %> --sfdx-url-file authFile.json\n\nNOTE: The \"<%= config.bin %> org display --verbose\" command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow.\n\nYou can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the authorization URL. Finally, you can create a normal text file that includes just the URL and nothing else.",
437
449
  "strict": true,
438
450
  "pluginName": "@salesforce/plugin-auth",
439
451
  "pluginAlias": "@salesforce/plugin-auth",
440
452
  "pluginType": "core",
441
453
  "aliases": [
442
- "force:auth:sfdxurl:store"
454
+ "force:auth:sfdxurl:store",
455
+ "auth:sfdxurl:store"
443
456
  ],
444
457
  "examples": [
445
- "$ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file>",
446
- "$ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg"
458
+ "Authorize an org using the SFDX authorization URL in the files/authFile.json file:\n<%= config.bin %> <%= command.id %> --sfdx-url-file files/authFile.json",
459
+ "Similar to previous example, but set the org as your default and give it an alias MyDefaultOrg:\n<%= config.bin %> <%= command.id %> --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg"
447
460
  ],
448
461
  "flags": {
449
462
  "json": {
@@ -457,7 +470,7 @@
457
470
  "name": "sfdx-url-file",
458
471
  "type": "option",
459
472
  "char": "f",
460
- "summary": "path to a file containing the sfdx url",
473
+ "summary": "Path to a file that contains the Salesforce DX authorization URL.",
461
474
  "required": true,
462
475
  "multiple": false,
463
476
  "aliases": [
@@ -468,7 +481,7 @@
468
481
  "name": "set-default-dev-hub",
469
482
  "type": "boolean",
470
483
  "char": "d",
471
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
484
+ "summary": "Set the authenticated org as the default Dev Hub.",
472
485
  "allowNo": false,
473
486
  "aliases": [
474
487
  "setdefaultdevhub",
@@ -479,7 +492,7 @@
479
492
  "name": "set-default",
480
493
  "type": "boolean",
481
494
  "char": "s",
482
- "summary": "set the authenticated org as the default username that all commands run against",
495
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
483
496
  "allowNo": false,
484
497
  "aliases": [
485
498
  "setdefaultusername"
@@ -489,7 +502,7 @@
489
502
  "name": "alias",
490
503
  "type": "option",
491
504
  "char": "a",
492
- "summary": "set an alias for the authenticated org",
505
+ "summary": "Alias for the org.",
493
506
  "multiple": false,
494
507
  "aliases": [
495
508
  "setalias"
@@ -499,7 +512,7 @@
499
512
  "name": "no-prompt",
500
513
  "type": "boolean",
501
514
  "char": "p",
502
- "summary": "do not prompt for auth confirmation in demo mode",
515
+ "summary": "Don't prompt for confirmation.",
503
516
  "hidden": true,
504
517
  "required": false,
505
518
  "allowNo": false,
@@ -519,22 +532,24 @@
519
532
  },
520
533
  "args": {}
521
534
  },
522
- "auth:web:login": {
523
- "id": "auth:web:login",
524
- "summary": "authorize an org using the web login flow",
525
- "description": "authorize an org using the web login flow\nIf you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To log in to a sandbox, set --instanceurl to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.\nTo open in a specific browser, use the --browser parameter. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
535
+ "org:login:web": {
536
+ "id": "org:login:web",
537
+ "summary": "Log in to a Salesforce org using the web server flow.",
538
+ "description": "Opens a Salesforce instance URL in a web browser so you can enter your credentials and log in to your org. After you log in, you can close the browser window.\n\nLogging into an org authorizes the CLI to run other commands that connect to that org, such as deploying or retrieving metadata. You can log into many types of orgs, such as sandboxes, Dev Hubs, Env Hubs, production orgs, and scratch orgs.\n\nWe recommend that you set an alias when you log into an org. Aliases make it easy to later reference this org when running commands that require it. If you don’t set an alias, you use the username that you specified when you logged in to the org. If you run multiple commands that reference the same org, consider setting the org as your default. Use --set-default for your default scratch org or sandbox, or --set-default-dev-hub for your default Dev Hub.\n\nBy default, this command uses the global out-of-the-box connected app in your org. If you need more security or control, such as setting the refresh token timeout or specifying IP ranges, create your own connected app using a digital certificate. Make note of the consumer key (also called cliend id) that’s generated for you. Then specify the consumer key with the --client-id flag.",
526
539
  "strict": true,
527
540
  "pluginName": "@salesforce/plugin-auth",
528
541
  "pluginAlias": "@salesforce/plugin-auth",
529
542
  "pluginType": "core",
530
543
  "aliases": [
531
- "force:auth:web:login"
544
+ "force:auth:web:login",
545
+ "auth:web:login"
532
546
  ],
533
547
  "examples": [
534
- "$ <%= config.bin %> <%= command.id %> -a TestOrg1",
535
- "$ <%= config.bin %> <%= command.id %> -i <OAuth client id>",
536
- "$ <%= config.bin %> <%= command.id %> -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com",
537
- "$ <%= config.bin %> <%= command.id %> -a TestOrg1 -b firefox"
548
+ "Run the command with no flags to open the default Salesforce login page (https://login.salesforce.com):\n<%= config.bin %> <%= command.id %>",
549
+ "Log in to your Dev Hub, set it as your default Dev Hub, and set an alias that you reference later when you create a scratch org:\n<%= config.bin %> <%= command.id %> --set-default-dev-hub --alias dev-hub",
550
+ "Log in to a sandbox and set it as your default org:\n<%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default",
551
+ "Use --browser to specify a specific browser, such as Google Chrome:\n<%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default --browser chrome",
552
+ "Use your own connected app by specifying its consumer key (also called client ID):\n<%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default --browser chrome --client-id 04580y4051234051"
538
553
  ],
539
554
  "deprecateAliases": true,
540
555
  "flags": {
@@ -550,7 +565,8 @@
550
565
  "name": "browser",
551
566
  "type": "option",
552
567
  "char": "b",
553
- "summary": "browser where the org opens",
568
+ "summary": "Browser in which to open the org.",
569
+ "description": "If you don’t specify --browser, the command uses your default browser. The exact names of the browser applications differ depending on the operating system you're on; check your documentation for details.",
554
570
  "multiple": false,
555
571
  "options": [
556
572
  "chrome",
@@ -563,7 +579,7 @@
563
579
  "name": "client-id",
564
580
  "type": "option",
565
581
  "char": "i",
566
- "summary": "OAuth client ID (sometimes called the consumer key)",
582
+ "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
567
583
  "multiple": false,
568
584
  "deprecateAliases": true,
569
585
  "aliases": [
@@ -574,30 +590,33 @@
574
590
  "name": "instance-url",
575
591
  "type": "option",
576
592
  "char": "r",
577
- "summary": "the login URL of the instance the org lives on",
593
+ "summary": "URL of the instance that the org lives on.",
594
+ "description": "If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.\n\nTo specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.\n\nTo specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.",
578
595
  "multiple": false,
579
596
  "deprecateAliases": true,
580
597
  "aliases": [
581
- "instanceurl"
598
+ "instanceurl",
599
+ "l"
582
600
  ]
583
601
  },
584
602
  "set-default-dev-hub": {
585
603
  "name": "set-default-dev-hub",
586
604
  "type": "boolean",
587
605
  "char": "d",
588
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
606
+ "summary": "Set the authenticated org as the default Dev Hub.",
589
607
  "allowNo": false,
590
608
  "deprecateAliases": true,
591
609
  "aliases": [
610
+ "setdefaultdevhubusername",
592
611
  "setdefaultdevhub",
593
- "setdefaultdevhubusername"
612
+ "v"
594
613
  ]
595
614
  },
596
615
  "set-default": {
597
616
  "name": "set-default",
598
617
  "type": "boolean",
599
618
  "char": "s",
600
- "summary": "set the authenticated org as the default username that all commands run against",
619
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
601
620
  "allowNo": false,
602
621
  "deprecateAliases": true,
603
622
  "aliases": [
@@ -608,7 +627,7 @@
608
627
  "name": "alias",
609
628
  "type": "option",
610
629
  "char": "a",
611
- "summary": "set an alias for the authenticated org",
630
+ "summary": "Alias for the org.",
612
631
  "multiple": false,
613
632
  "deprecateAliases": true,
614
633
  "aliases": [
@@ -618,7 +637,7 @@
618
637
  "disable-masking": {
619
638
  "name": "disable-masking",
620
639
  "type": "boolean",
621
- "summary": "disable masking of user input (for use with problematic terminals)",
640
+ "summary": "Disable masking of user input; use with problematic terminals.",
622
641
  "hidden": true,
623
642
  "allowNo": false,
624
643
  "deprecateAliases": true,
@@ -630,7 +649,7 @@
630
649
  "name": "no-prompt",
631
650
  "type": "boolean",
632
651
  "char": "p",
633
- "summary": "do not prompt for auth confirmation in demo mode",
652
+ "summary": "Don't prompt for confirmation.",
634
653
  "hidden": true,
635
654
  "required": false,
636
655
  "allowNo": false,