@salesforce/plugin-auth 2.6.0 → 2.6.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/{org/login/access-token.d.ts → auth/accesstoken/store.d.ts} +1 -1
  2. package/lib/commands/{org/login/access-token.js → auth/accesstoken/store.js} +17 -19
  3. package/lib/commands/auth/accesstoken/store.js.map +1 -0
  4. package/lib/commands/{org/login/device.d.ts → auth/device/login.d.ts} +1 -1
  5. package/lib/commands/{org/login/device.js → auth/device/login.js} +15 -16
  6. package/lib/commands/auth/device/login.js.map +1 -0
  7. package/lib/commands/{org/login/jwt.d.ts → auth/jwt/grant.d.ts} +1 -1
  8. package/lib/commands/{org/login/jwt.js → auth/jwt/grant.js} +17 -18
  9. package/lib/commands/auth/jwt/grant.js.map +1 -0
  10. package/lib/commands/{org/list/auth.d.ts → auth/list.d.ts} +1 -1
  11. package/lib/commands/{org/list/auth.js → auth/list.js} +10 -10
  12. package/lib/commands/auth/list.js.map +1 -0
  13. package/lib/commands/{org → auth}/logout.d.ts +1 -2
  14. package/lib/commands/auth/logout.js +98 -0
  15. package/lib/commands/auth/logout.js.map +1 -0
  16. package/lib/commands/{org/login/sfdx-url.d.ts → auth/sfdxurl/store.d.ts} +1 -1
  17. package/lib/commands/{org/login/sfdx-url.js → auth/sfdxurl/store.js} +14 -14
  18. package/lib/commands/auth/sfdxurl/store.js.map +1 -0
  19. package/lib/commands/{org/login/web.d.ts → auth/web/login.d.ts} +1 -1
  20. package/lib/commands/{org/login/web.js → auth/web/login.js} +19 -21
  21. package/lib/commands/auth/web/login.js.map +1 -0
  22. package/messages/accesstoken.store.md +5 -7
  23. package/messages/device.login.md +7 -14
  24. package/messages/jwt.grant.md +11 -31
  25. package/messages/list.md +4 -6
  26. package/messages/logout.md +18 -54
  27. package/messages/messages.md +15 -23
  28. package/messages/sfdxurl.store.md +12 -18
  29. package/messages/web.login.md +11 -31
  30. package/oclif.manifest.json +123 -137
  31. package/package.json +29 -39
  32. package/lib/commands/org/list/auth.js.map +0 -1
  33. package/lib/commands/org/login/access-token.js.map +0 -1
  34. package/lib/commands/org/login/device.js.map +0 -1
  35. package/lib/commands/org/login/jwt.js.map +0 -1
  36. package/lib/commands/org/login/sfdx-url.js.map +0 -1
  37. package/lib/commands/org/login/web.js.map +0 -1
  38. package/lib/commands/org/logout.js +0 -188
  39. package/lib/commands/org/logout.js.map +0 -1
@@ -1,23 +1,58 @@
1
1
  {
2
- "version": "2.6.0",
2
+ "version": "2.6.1",
3
3
  "commands": {
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.",
4
+ "auth:list": {
5
+ "id": "auth:list",
6
+ "summary": "List auth connection information",
7
+ "description": "list auth connection information",
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:logout",
14
- "auth:logout"
13
+ "force:auth:list"
15
14
  ],
16
15
  "examples": [
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"
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"
21
56
  ],
22
57
  "deprecateAliases": true,
23
58
  "flags": {
@@ -45,8 +80,8 @@
45
80
  "name": "all",
46
81
  "type": "boolean",
47
82
  "char": "a",
48
- "summary": "Include all authenticated orgs.",
49
- "description": "All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.",
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.",
50
85
  "required": false,
51
86
  "allowNo": false,
52
87
  "exclusive": [
@@ -58,7 +93,7 @@
58
93
  "name": "no-prompt",
59
94
  "type": "boolean",
60
95
  "char": "p",
61
- "summary": "Don't prompt for confirmation.",
96
+ "summary": "do not prompt for confirmation",
62
97
  "required": false,
63
98
  "allowNo": false,
64
99
  "deprecateAliases": true,
@@ -79,59 +114,21 @@
79
114
  },
80
115
  "args": {}
81
116
  },
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.",
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.",
124
121
  "strict": true,
125
122
  "pluginName": "@salesforce/plugin-auth",
126
123
  "pluginAlias": "@salesforce/plugin-auth",
127
124
  "pluginType": "core",
128
125
  "aliases": [
129
- "force:auth:accesstoken:store",
130
- "auth:accesstoken:store"
126
+ "force:auth:accesstoken:store"
131
127
  ],
132
128
  "examples": [
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"
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"
135
132
  ],
136
133
  "deprecateAliases": true,
137
134
  "flags": {
@@ -147,8 +144,7 @@
147
144
  "name": "instance-url",
148
145
  "type": "option",
149
146
  "char": "r",
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.",
147
+ "summary": "the login URL of the instance the org lives on",
152
148
  "required": true,
153
149
  "multiple": false,
154
150
  "deprecateAliases": true,
@@ -160,7 +156,7 @@
160
156
  "name": "set-default-dev-hub",
161
157
  "type": "boolean",
162
158
  "char": "d",
163
- "summary": "Set the authenticated org as the default Dev Hub.",
159
+ "summary": "set the authenticated org as the default dev hub org for scratch org creation",
164
160
  "allowNo": false,
165
161
  "deprecateAliases": true,
166
162
  "aliases": [
@@ -172,7 +168,7 @@
172
168
  "name": "set-default",
173
169
  "type": "boolean",
174
170
  "char": "s",
175
- "summary": "Set the authenticated org as the default that all org-related commands run against.",
171
+ "summary": "set the authenticated org as the default username that all commands run against",
176
172
  "allowNo": false,
177
173
  "deprecateAliases": true,
178
174
  "aliases": [
@@ -183,7 +179,7 @@
183
179
  "name": "alias",
184
180
  "type": "option",
185
181
  "char": "a",
186
- "summary": "Alias for the org.",
182
+ "summary": "set an alias for the authenticated org",
187
183
  "multiple": false,
188
184
  "deprecateAliases": true,
189
185
  "aliases": [
@@ -194,7 +190,7 @@
194
190
  "name": "no-prompt",
195
191
  "type": "boolean",
196
192
  "char": "p",
197
- "summary": "Don't prompt for confirmation.",
193
+ "summary": "do not prompt for confirmation",
198
194
  "required": false,
199
195
  "allowNo": false,
200
196
  "deprecateAliases": true,
@@ -215,22 +211,21 @@
215
211
  },
216
212
  "args": {}
217
213
  },
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.",
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.",
222
218
  "strict": true,
223
219
  "pluginName": "@salesforce/plugin-auth",
224
220
  "pluginAlias": "@salesforce/plugin-auth",
225
221
  "pluginType": "core",
226
222
  "aliases": [
227
- "force:auth:device:login",
228
- "auth:device:login"
223
+ "force:auth:device:login"
229
224
  ],
230
225
  "examples": [
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"
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"
234
229
  ],
235
230
  "flags": {
236
231
  "json": {
@@ -244,7 +239,7 @@
244
239
  "name": "client-id",
245
240
  "type": "option",
246
241
  "char": "i",
247
- "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
242
+ "summary": "OAuth client ID (sometimes called the consumer key)",
248
243
  "multiple": false,
249
244
  "aliases": [
250
245
  "clientid"
@@ -254,8 +249,7 @@
254
249
  "name": "instance-url",
255
250
  "type": "option",
256
251
  "char": "r",
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
+ "summary": "the login URL of the instance the org lives on",
259
253
  "multiple": false,
260
254
  "aliases": [
261
255
  "instanceurl"
@@ -265,7 +259,7 @@
265
259
  "name": "set-default-dev-hub",
266
260
  "type": "boolean",
267
261
  "char": "d",
268
- "summary": "Set the authenticated org as the default Dev Hub.",
262
+ "summary": "set the authenticated org as the default dev hub org for scratch org creation",
269
263
  "allowNo": false,
270
264
  "aliases": [
271
265
  "setdefaultdevhub",
@@ -276,7 +270,7 @@
276
270
  "name": "set-default",
277
271
  "type": "boolean",
278
272
  "char": "s",
279
- "summary": "Set the authenticated org as the default that all org-related commands run against.",
273
+ "summary": "set the authenticated org as the default username that all commands run against",
280
274
  "allowNo": false,
281
275
  "aliases": [
282
276
  "setdefaultusername"
@@ -286,7 +280,7 @@
286
280
  "name": "alias",
287
281
  "type": "option",
288
282
  "char": "a",
289
- "summary": "Alias for the org.",
283
+ "summary": "set an alias for the authenticated org",
290
284
  "multiple": false,
291
285
  "aliases": [
292
286
  "setalias"
@@ -295,7 +289,7 @@
295
289
  "disable-masking": {
296
290
  "name": "disable-masking",
297
291
  "type": "boolean",
298
- "summary": "Disable masking of user input; use with problematic terminals.",
292
+ "summary": "disable masking of user input (for use with problematic terminals)",
299
293
  "hidden": true,
300
294
  "allowNo": false,
301
295
  "aliases": [
@@ -314,23 +308,21 @@
314
308
  },
315
309
  "args": {}
316
310
  },
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.",
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.",
321
315
  "strict": true,
322
316
  "pluginName": "@salesforce/plugin-auth",
323
317
  "pluginAlias": "@salesforce/plugin-auth",
324
318
  "pluginType": "core",
325
319
  "aliases": [
326
- "force:auth:jwt:grant",
327
- "auth:jwt:grant"
320
+ "force:auth:jwt:grant"
328
321
  ],
329
322
  "examples": [
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"
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"
334
326
  ],
335
327
  "flags": {
336
328
  "json": {
@@ -344,7 +336,7 @@
344
336
  "name": "username",
345
337
  "type": "option",
346
338
  "char": "o",
347
- "summary": "Username of the user logging in.",
339
+ "summary": "authentication username",
348
340
  "required": true,
349
341
  "multiple": false,
350
342
  "aliases": [
@@ -355,7 +347,7 @@
355
347
  "name": "jwt-key-file",
356
348
  "type": "option",
357
349
  "char": "f",
358
- "summary": "Path to a file containing the private key.",
350
+ "summary": "path to a file containing the private key",
359
351
  "required": true,
360
352
  "multiple": false,
361
353
  "aliases": [
@@ -366,7 +358,7 @@
366
358
  "name": "client-id",
367
359
  "type": "option",
368
360
  "char": "i",
369
- "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
361
+ "summary": "OAuth client ID (sometimes called the consumer key)",
370
362
  "required": true,
371
363
  "multiple": false,
372
364
  "aliases": [
@@ -377,8 +369,7 @@
377
369
  "name": "instance-url",
378
370
  "type": "option",
379
371
  "char": "r",
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.",
372
+ "summary": "the login URL of the instance the org lives on",
382
373
  "multiple": false,
383
374
  "aliases": [
384
375
  "instanceurl"
@@ -388,7 +379,7 @@
388
379
  "name": "set-default-dev-hub",
389
380
  "type": "boolean",
390
381
  "char": "d",
391
- "summary": "Set the authenticated org as the default Dev Hub.",
382
+ "summary": "set the authenticated org as the default dev hub org for scratch org creation",
392
383
  "allowNo": false,
393
384
  "aliases": [
394
385
  "setdefaultdevhub",
@@ -399,7 +390,7 @@
399
390
  "name": "set-default",
400
391
  "type": "boolean",
401
392
  "char": "s",
402
- "summary": "Set the authenticated org as the default that all org-related commands run against.",
393
+ "summary": "set the authenticated org as the default username that all commands run against",
403
394
  "allowNo": false,
404
395
  "aliases": [
405
396
  "setdefaultusername"
@@ -409,7 +400,7 @@
409
400
  "name": "alias",
410
401
  "type": "option",
411
402
  "char": "a",
412
- "summary": "Alias for the org.",
403
+ "summary": "set an alias for the authenticated org",
413
404
  "multiple": false,
414
405
  "aliases": [
415
406
  "setalias"
@@ -419,7 +410,7 @@
419
410
  "name": "no-prompt",
420
411
  "type": "boolean",
421
412
  "char": "p",
422
- "summary": "Don't prompt for confirmation.",
413
+ "summary": "do not prompt for auth confirmation in demo mode",
423
414
  "hidden": true,
424
415
  "required": false,
425
416
  "allowNo": false,
@@ -439,21 +430,20 @@
439
430
  },
440
431
  "args": {}
441
432
  },
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.",
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.",
446
437
  "strict": true,
447
438
  "pluginName": "@salesforce/plugin-auth",
448
439
  "pluginAlias": "@salesforce/plugin-auth",
449
440
  "pluginType": "core",
450
441
  "aliases": [
451
- "force:auth:sfdxurl:store",
452
- "auth:sfdxurl:store"
442
+ "force:auth:sfdxurl:store"
453
443
  ],
454
444
  "examples": [
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"
445
+ "$ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file>",
446
+ "$ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg"
457
447
  ],
458
448
  "flags": {
459
449
  "json": {
@@ -467,7 +457,7 @@
467
457
  "name": "sfdx-url-file",
468
458
  "type": "option",
469
459
  "char": "f",
470
- "summary": "Path to a file that contains the Salesforce DX authorization URL.",
460
+ "summary": "path to a file containing the sfdx url",
471
461
  "required": true,
472
462
  "multiple": false,
473
463
  "aliases": [
@@ -478,7 +468,7 @@
478
468
  "name": "set-default-dev-hub",
479
469
  "type": "boolean",
480
470
  "char": "d",
481
- "summary": "Set the authenticated org as the default Dev Hub.",
471
+ "summary": "set the authenticated org as the default dev hub org for scratch org creation",
482
472
  "allowNo": false,
483
473
  "aliases": [
484
474
  "setdefaultdevhub",
@@ -489,7 +479,7 @@
489
479
  "name": "set-default",
490
480
  "type": "boolean",
491
481
  "char": "s",
492
- "summary": "Set the authenticated org as the default that all org-related commands run against.",
482
+ "summary": "set the authenticated org as the default username that all commands run against",
493
483
  "allowNo": false,
494
484
  "aliases": [
495
485
  "setdefaultusername"
@@ -499,7 +489,7 @@
499
489
  "name": "alias",
500
490
  "type": "option",
501
491
  "char": "a",
502
- "summary": "Alias for the org.",
492
+ "summary": "set an alias for the authenticated org",
503
493
  "multiple": false,
504
494
  "aliases": [
505
495
  "setalias"
@@ -509,7 +499,7 @@
509
499
  "name": "no-prompt",
510
500
  "type": "boolean",
511
501
  "char": "p",
512
- "summary": "Don't prompt for confirmation.",
502
+ "summary": "do not prompt for auth confirmation in demo mode",
513
503
  "hidden": true,
514
504
  "required": false,
515
505
  "allowNo": false,
@@ -529,24 +519,22 @@
529
519
  },
530
520
  "args": {}
531
521
  },
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
+ "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.",
536
526
  "strict": true,
537
527
  "pluginName": "@salesforce/plugin-auth",
538
528
  "pluginAlias": "@salesforce/plugin-auth",
539
529
  "pluginType": "core",
540
530
  "aliases": [
541
- "force:auth:web:login",
542
- "auth:web:login"
531
+ "force:auth:web:login"
543
532
  ],
544
533
  "examples": [
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
+ "$ <%= 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"
550
538
  ],
551
539
  "deprecateAliases": true,
552
540
  "flags": {
@@ -562,8 +550,7 @@
562
550
  "name": "browser",
563
551
  "type": "option",
564
552
  "char": "b",
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.",
553
+ "summary": "browser where the org opens",
567
554
  "multiple": false,
568
555
  "options": [
569
556
  "chrome",
@@ -576,7 +563,7 @@
576
563
  "name": "client-id",
577
564
  "type": "option",
578
565
  "char": "i",
579
- "summary": "OAuth client ID (also called consumer key) of your custom connected app.",
566
+ "summary": "OAuth client ID (sometimes called the consumer key)",
580
567
  "multiple": false,
581
568
  "deprecateAliases": true,
582
569
  "aliases": [
@@ -587,8 +574,7 @@
587
574
  "name": "instance-url",
588
575
  "type": "option",
589
576
  "char": "r",
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.",
577
+ "summary": "the login URL of the instance the org lives on",
592
578
  "multiple": false,
593
579
  "deprecateAliases": true,
594
580
  "aliases": [
@@ -599,19 +585,19 @@
599
585
  "name": "set-default-dev-hub",
600
586
  "type": "boolean",
601
587
  "char": "d",
602
- "summary": "Set the authenticated org as the default Dev Hub.",
588
+ "summary": "set the authenticated org as the default dev hub org for scratch org creation",
603
589
  "allowNo": false,
604
590
  "deprecateAliases": true,
605
591
  "aliases": [
606
- "setdefaultdevhubusername",
607
- "setdefaultdevhub"
592
+ "setdefaultdevhub",
593
+ "setdefaultdevhubusername"
608
594
  ]
609
595
  },
610
596
  "set-default": {
611
597
  "name": "set-default",
612
598
  "type": "boolean",
613
599
  "char": "s",
614
- "summary": "Set the authenticated org as the default that all org-related commands run against.",
600
+ "summary": "set the authenticated org as the default username that all commands run against",
615
601
  "allowNo": false,
616
602
  "deprecateAliases": true,
617
603
  "aliases": [
@@ -622,7 +608,7 @@
622
608
  "name": "alias",
623
609
  "type": "option",
624
610
  "char": "a",
625
- "summary": "Alias for the org.",
611
+ "summary": "set an alias for the authenticated org",
626
612
  "multiple": false,
627
613
  "deprecateAliases": true,
628
614
  "aliases": [
@@ -632,7 +618,7 @@
632
618
  "disable-masking": {
633
619
  "name": "disable-masking",
634
620
  "type": "boolean",
635
- "summary": "Disable masking of user input; use with problematic terminals.",
621
+ "summary": "disable masking of user input (for use with problematic terminals)",
636
622
  "hidden": true,
637
623
  "allowNo": false,
638
624
  "deprecateAliases": true,
@@ -644,7 +630,7 @@
644
630
  "name": "no-prompt",
645
631
  "type": "boolean",
646
632
  "char": "p",
647
- "summary": "Don't prompt for confirmation.",
633
+ "summary": "do not prompt for auth confirmation in demo mode",
648
634
  "hidden": true,
649
635
  "required": false,
650
636
  "allowNo": false,