@salesforce/plugin-auth 2.5.1 → 2.6.0

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} +18 -17
  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} +20 -19
  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} +19 -18
  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} +15 -15
  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} +23 -21
  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 +36 -25
  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.5.1",
2
+ "version": "2.6.0",
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,18 +160,19 @@
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": [
163
- "setdefaultdevhub"
167
+ "setdefaultdevhub",
168
+ "setdefaultdevhubusername"
164
169
  ]
165
170
  },
166
171
  "set-default": {
167
172
  "name": "set-default",
168
173
  "type": "boolean",
169
174
  "char": "s",
170
- "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.",
171
176
  "allowNo": false,
172
177
  "deprecateAliases": true,
173
178
  "aliases": [
@@ -178,7 +183,7 @@
178
183
  "name": "alias",
179
184
  "type": "option",
180
185
  "char": "a",
181
- "summary": "set an alias for the authenticated org",
186
+ "summary": "Alias for the org.",
182
187
  "multiple": false,
183
188
  "deprecateAliases": true,
184
189
  "aliases": [
@@ -189,7 +194,7 @@
189
194
  "name": "no-prompt",
190
195
  "type": "boolean",
191
196
  "char": "p",
192
- "summary": "do not prompt for confirmation",
197
+ "summary": "Don't prompt for confirmation.",
193
198
  "required": false,
194
199
  "allowNo": false,
195
200
  "deprecateAliases": true,
@@ -210,21 +215,22 @@
210
215
  },
211
216
  "args": {}
212
217
  },
213
- "auth:device:login": {
214
- "id": "auth:device:login",
215
- "summary": "authorize an org using a device code",
216
- "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.",
217
222
  "strict": true,
218
223
  "pluginName": "@salesforce/plugin-auth",
219
224
  "pluginAlias": "@salesforce/plugin-auth",
220
225
  "pluginType": "core",
221
226
  "aliases": [
222
- "force:auth:device:login"
227
+ "force:auth:device:login",
228
+ "auth:device:login"
223
229
  ],
224
230
  "examples": [
225
- "$ <%= config.bin %> <%= command.id %> -d -a TestOrg1",
226
- "$ <%= config.bin %> <%= command.id %> -i <OAuth client id>",
227
- "$ <%= 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"
228
234
  ],
229
235
  "flags": {
230
236
  "json": {
@@ -238,7 +244,7 @@
238
244
  "name": "client-id",
239
245
  "type": "option",
240
246
  "char": "i",
241
- "summary": "OAuth client ID (sometimes called the consumer key)",
247
+ "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
242
248
  "multiple": false,
243
249
  "aliases": [
244
250
  "clientid"
@@ -248,7 +254,8 @@
248
254
  "name": "instance-url",
249
255
  "type": "option",
250
256
  "char": "r",
251
- "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.",
252
259
  "multiple": false,
253
260
  "aliases": [
254
261
  "instanceurl"
@@ -258,17 +265,18 @@
258
265
  "name": "set-default-dev-hub",
259
266
  "type": "boolean",
260
267
  "char": "d",
261
- "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.",
262
269
  "allowNo": false,
263
270
  "aliases": [
264
- "setdefaultdevhub"
271
+ "setdefaultdevhub",
272
+ "setdefaultdevhubusername"
265
273
  ]
266
274
  },
267
275
  "set-default": {
268
276
  "name": "set-default",
269
277
  "type": "boolean",
270
278
  "char": "s",
271
- "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.",
272
280
  "allowNo": false,
273
281
  "aliases": [
274
282
  "setdefaultusername"
@@ -278,7 +286,7 @@
278
286
  "name": "alias",
279
287
  "type": "option",
280
288
  "char": "a",
281
- "summary": "set an alias for the authenticated org",
289
+ "summary": "Alias for the org.",
282
290
  "multiple": false,
283
291
  "aliases": [
284
292
  "setalias"
@@ -287,7 +295,7 @@
287
295
  "disable-masking": {
288
296
  "name": "disable-masking",
289
297
  "type": "boolean",
290
- "summary": "disable masking of user input (for use with problematic terminals)",
298
+ "summary": "Disable masking of user input; use with problematic terminals.",
291
299
  "hidden": true,
292
300
  "allowNo": false,
293
301
  "aliases": [
@@ -306,21 +314,23 @@
306
314
  },
307
315
  "args": {}
308
316
  },
309
- "auth:jwt:grant": {
310
- "id": "auth:jwt:grant",
311
- "summary": "authorize an org using the JWT flow",
312
- "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.",
313
321
  "strict": true,
314
322
  "pluginName": "@salesforce/plugin-auth",
315
323
  "pluginAlias": "@salesforce/plugin-auth",
316
324
  "pluginType": "core",
317
325
  "aliases": [
318
- "force:auth:jwt:grant"
326
+ "force:auth:jwt:grant",
327
+ "auth:jwt:grant"
319
328
  ],
320
329
  "examples": [
321
- "$ <%= config.bin %> <%= command.id %> -o me@my.org -f <path to jwt key file> -i <OAuth client id>",
322
- "$ <%= config.bin %> <%= command.id %> -o me@my.org -f <path to jwt key file> -i <OAuth client id> -s -a MyDefaultOrg",
323
- "$ <%= 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"
324
334
  ],
325
335
  "flags": {
326
336
  "json": {
@@ -334,7 +344,7 @@
334
344
  "name": "username",
335
345
  "type": "option",
336
346
  "char": "o",
337
- "summary": "authentication username",
347
+ "summary": "Username of the user logging in.",
338
348
  "required": true,
339
349
  "multiple": false,
340
350
  "aliases": [
@@ -345,7 +355,7 @@
345
355
  "name": "jwt-key-file",
346
356
  "type": "option",
347
357
  "char": "f",
348
- "summary": "path to a file containing the private key",
358
+ "summary": "Path to a file containing the private key.",
349
359
  "required": true,
350
360
  "multiple": false,
351
361
  "aliases": [
@@ -356,7 +366,7 @@
356
366
  "name": "client-id",
357
367
  "type": "option",
358
368
  "char": "i",
359
- "summary": "OAuth client ID (sometimes called the consumer key)",
369
+ "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
360
370
  "required": true,
361
371
  "multiple": false,
362
372
  "aliases": [
@@ -367,7 +377,8 @@
367
377
  "name": "instance-url",
368
378
  "type": "option",
369
379
  "char": "r",
370
- "summary": "the login URL of the instance the org lives on",
380
+ "summary": "URL of the instance that the org lives on.",
381
+ "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.",
371
382
  "multiple": false,
372
383
  "aliases": [
373
384
  "instanceurl"
@@ -377,17 +388,18 @@
377
388
  "name": "set-default-dev-hub",
378
389
  "type": "boolean",
379
390
  "char": "d",
380
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
391
+ "summary": "Set the authenticated org as the default Dev Hub.",
381
392
  "allowNo": false,
382
393
  "aliases": [
383
- "setdefaultdevhub"
394
+ "setdefaultdevhub",
395
+ "setdefaultdevhubusername"
384
396
  ]
385
397
  },
386
398
  "set-default": {
387
399
  "name": "set-default",
388
400
  "type": "boolean",
389
401
  "char": "s",
390
- "summary": "set the authenticated org as the default username that all commands run against",
402
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
391
403
  "allowNo": false,
392
404
  "aliases": [
393
405
  "setdefaultusername"
@@ -397,7 +409,7 @@
397
409
  "name": "alias",
398
410
  "type": "option",
399
411
  "char": "a",
400
- "summary": "set an alias for the authenticated org",
412
+ "summary": "Alias for the org.",
401
413
  "multiple": false,
402
414
  "aliases": [
403
415
  "setalias"
@@ -407,7 +419,7 @@
407
419
  "name": "no-prompt",
408
420
  "type": "boolean",
409
421
  "char": "p",
410
- "summary": "do not prompt for auth confirmation in demo mode",
422
+ "summary": "Don't prompt for confirmation.",
411
423
  "hidden": true,
412
424
  "required": false,
413
425
  "allowNo": false,
@@ -427,20 +439,21 @@
427
439
  },
428
440
  "args": {}
429
441
  },
430
- "auth:sfdxurl:store": {
431
- "id": "auth:sfdxurl:store",
432
- "summary": "authorize an org using an SFDX auth URL stored within a file",
433
- "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.",
442
+ "org:login:sfdx-url": {
443
+ "id": "org:login:sfdx-url",
444
+ "summary": "Authorize an org using a Salesforce DX authorization URL stored in a file.",
445
+ "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.",
434
446
  "strict": true,
435
447
  "pluginName": "@salesforce/plugin-auth",
436
448
  "pluginAlias": "@salesforce/plugin-auth",
437
449
  "pluginType": "core",
438
450
  "aliases": [
439
- "force:auth:sfdxurl:store"
451
+ "force:auth:sfdxurl:store",
452
+ "auth:sfdxurl:store"
440
453
  ],
441
454
  "examples": [
442
- "$ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file>",
443
- "$ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg"
455
+ "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",
456
+ "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"
444
457
  ],
445
458
  "flags": {
446
459
  "json": {
@@ -454,7 +467,7 @@
454
467
  "name": "sfdx-url-file",
455
468
  "type": "option",
456
469
  "char": "f",
457
- "summary": "path to a file containing the sfdx url",
470
+ "summary": "Path to a file that contains the Salesforce DX authorization URL.",
458
471
  "required": true,
459
472
  "multiple": false,
460
473
  "aliases": [
@@ -465,17 +478,18 @@
465
478
  "name": "set-default-dev-hub",
466
479
  "type": "boolean",
467
480
  "char": "d",
468
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
481
+ "summary": "Set the authenticated org as the default Dev Hub.",
469
482
  "allowNo": false,
470
483
  "aliases": [
471
- "setdefaultdevhub"
484
+ "setdefaultdevhub",
485
+ "setdefaultdevhubusername"
472
486
  ]
473
487
  },
474
488
  "set-default": {
475
489
  "name": "set-default",
476
490
  "type": "boolean",
477
491
  "char": "s",
478
- "summary": "set the authenticated org as the default username that all commands run against",
492
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
479
493
  "allowNo": false,
480
494
  "aliases": [
481
495
  "setdefaultusername"
@@ -485,7 +499,7 @@
485
499
  "name": "alias",
486
500
  "type": "option",
487
501
  "char": "a",
488
- "summary": "set an alias for the authenticated org",
502
+ "summary": "Alias for the org.",
489
503
  "multiple": false,
490
504
  "aliases": [
491
505
  "setalias"
@@ -495,7 +509,7 @@
495
509
  "name": "no-prompt",
496
510
  "type": "boolean",
497
511
  "char": "p",
498
- "summary": "do not prompt for auth confirmation in demo mode",
512
+ "summary": "Don't prompt for confirmation.",
499
513
  "hidden": true,
500
514
  "required": false,
501
515
  "allowNo": false,
@@ -515,22 +529,24 @@
515
529
  },
516
530
  "args": {}
517
531
  },
518
- "auth:web:login": {
519
- "id": "auth:web:login",
520
- "summary": "authorize an org using the web login flow",
521
- "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.",
532
+ "org:login:web": {
533
+ "id": "org:login:web",
534
+ "summary": "Log in to a Salesforce org using the web server flow.",
535
+ "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.",
522
536
  "strict": true,
523
537
  "pluginName": "@salesforce/plugin-auth",
524
538
  "pluginAlias": "@salesforce/plugin-auth",
525
539
  "pluginType": "core",
526
540
  "aliases": [
527
- "force:auth:web:login"
541
+ "force:auth:web:login",
542
+ "auth:web:login"
528
543
  ],
529
544
  "examples": [
530
- "$ <%= config.bin %> <%= command.id %> -a TestOrg1",
531
- "$ <%= config.bin %> <%= command.id %> -i <OAuth client id>",
532
- "$ <%= config.bin %> <%= command.id %> -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com",
533
- "$ <%= config.bin %> <%= command.id %> -a TestOrg1 -b firefox"
545
+ "Run the command with no flags to open the default Salesforce login page (https://login.salesforce.com):\n<%= config.bin %> <%= command.id %>",
546
+ "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",
547
+ "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",
548
+ "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",
549
+ "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"
534
550
  ],
535
551
  "deprecateAliases": true,
536
552
  "flags": {
@@ -546,7 +562,8 @@
546
562
  "name": "browser",
547
563
  "type": "option",
548
564
  "char": "b",
549
- "summary": "browser where the org opens",
565
+ "summary": "Browser in which to open the org.",
566
+ "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.",
550
567
  "multiple": false,
551
568
  "options": [
552
569
  "chrome",
@@ -559,7 +576,7 @@
559
576
  "name": "client-id",
560
577
  "type": "option",
561
578
  "char": "i",
562
- "summary": "OAuth client ID (sometimes called the consumer key)",
579
+ "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
563
580
  "multiple": false,
564
581
  "deprecateAliases": true,
565
582
  "aliases": [
@@ -570,7 +587,8 @@
570
587
  "name": "instance-url",
571
588
  "type": "option",
572
589
  "char": "r",
573
- "summary": "the login URL of the instance the org lives on",
590
+ "summary": "URL of the instance that the org lives on.",
591
+ "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.",
574
592
  "multiple": false,
575
593
  "deprecateAliases": true,
576
594
  "aliases": [
@@ -581,18 +599,19 @@
581
599
  "name": "set-default-dev-hub",
582
600
  "type": "boolean",
583
601
  "char": "d",
584
- "summary": "set the authenticated org as the default dev hub org for scratch org creation",
602
+ "summary": "Set the authenticated org as the default Dev Hub.",
585
603
  "allowNo": false,
586
604
  "deprecateAliases": true,
587
605
  "aliases": [
588
- "setdefaultdevhubusername"
606
+ "setdefaultdevhubusername",
607
+ "setdefaultdevhub"
589
608
  ]
590
609
  },
591
610
  "set-default": {
592
611
  "name": "set-default",
593
612
  "type": "boolean",
594
613
  "char": "s",
595
- "summary": "set the authenticated org as the default username that all commands run against",
614
+ "summary": "Set the authenticated org as the default that all org-related commands run against.",
596
615
  "allowNo": false,
597
616
  "deprecateAliases": true,
598
617
  "aliases": [
@@ -603,7 +622,7 @@
603
622
  "name": "alias",
604
623
  "type": "option",
605
624
  "char": "a",
606
- "summary": "set an alias for the authenticated org",
625
+ "summary": "Alias for the org.",
607
626
  "multiple": false,
608
627
  "deprecateAliases": true,
609
628
  "aliases": [
@@ -613,7 +632,7 @@
613
632
  "disable-masking": {
614
633
  "name": "disable-masking",
615
634
  "type": "boolean",
616
- "summary": "disable masking of user input (for use with problematic terminals)",
635
+ "summary": "Disable masking of user input; use with problematic terminals.",
617
636
  "hidden": true,
618
637
  "allowNo": false,
619
638
  "deprecateAliases": true,
@@ -625,7 +644,7 @@
625
644
  "name": "no-prompt",
626
645
  "type": "boolean",
627
646
  "char": "p",
628
- "summary": "do not prompt for auth confirmation in demo mode",
647
+ "summary": "Don't prompt for confirmation.",
629
648
  "hidden": true,
630
649
  "required": false,
631
650
  "allowNo": false,