@salesforce/plugin-org 2.2.23 → 2.2.25

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 (103) hide show
  1. package/README.md +4 -0
  2. package/lib/commands/force/org/clone.d.ts +21 -9
  3. package/lib/commands/force/org/clone.js +50 -82
  4. package/lib/commands/force/org/clone.js.map +1 -1
  5. package/lib/commands/force/org/create.d.ts +27 -12
  6. package/lib/commands/force/org/create.js +85 -105
  7. package/lib/commands/force/org/create.js.map +1 -1
  8. package/lib/commands/force/org/delete.d.ts +14 -7
  9. package/lib/commands/force/org/delete.js +26 -16
  10. package/lib/commands/force/org/delete.js.map +1 -1
  11. package/lib/commands/force/org/status.d.ts +18 -6
  12. package/lib/commands/force/org/status.js +43 -37
  13. package/lib/commands/force/org/status.js.map +1 -1
  14. package/lib/commands/org/create/sandbox.d.ts +40 -0
  15. package/lib/commands/org/create/sandbox.js +244 -0
  16. package/lib/commands/org/create/sandbox.js.map +1 -0
  17. package/lib/commands/org/create/scratch.d.ts +30 -0
  18. package/lib/commands/org/create/scratch.js +183 -0
  19. package/lib/commands/org/create/scratch.js.map +1 -0
  20. package/lib/commands/org/delete/sandbox.d.ts +18 -0
  21. package/lib/commands/org/delete/sandbox.js +59 -0
  22. package/lib/commands/org/delete/sandbox.js.map +1 -0
  23. package/lib/commands/org/delete/scratch.d.ts +18 -0
  24. package/lib/commands/org/delete/scratch.js +52 -0
  25. package/lib/commands/org/delete/scratch.js.map +1 -0
  26. package/lib/commands/org/display.d.ts +20 -0
  27. package/lib/commands/{force/org → org}/display.js +38 -27
  28. package/lib/commands/org/display.js.map +1 -0
  29. package/lib/commands/org/list.d.ts +26 -0
  30. package/lib/commands/org/list.js +192 -0
  31. package/lib/commands/org/list.js.map +1 -0
  32. package/lib/commands/org/open.d.ts +25 -0
  33. package/lib/commands/{force/org → org}/open.js +47 -33
  34. package/lib/commands/org/open.js.map +1 -0
  35. package/lib/commands/org/resume/sandbox.d.ts +26 -0
  36. package/lib/commands/org/resume/sandbox.js +199 -0
  37. package/lib/commands/org/resume/sandbox.js.map +1 -0
  38. package/lib/commands/org/resume/scratch.d.ts +14 -0
  39. package/lib/commands/org/resume/scratch.js +61 -0
  40. package/lib/commands/org/resume/scratch.js.map +1 -0
  41. package/lib/shared/orgHighlighter.d.ts +2 -2
  42. package/lib/shared/orgHighlighter.js +7 -5
  43. package/lib/shared/orgHighlighter.js.map +1 -1
  44. package/lib/shared/orgHooks.d.ts +24 -0
  45. package/lib/shared/orgHooks.js +9 -0
  46. package/lib/shared/orgHooks.js.map +1 -0
  47. package/lib/shared/orgListUtil.d.ts +15 -25
  48. package/lib/shared/orgListUtil.js +71 -81
  49. package/lib/shared/orgListUtil.js.map +1 -1
  50. package/lib/shared/orgTypes.d.ts +39 -11
  51. package/lib/shared/sandboxCommandBase.d.ts +33 -0
  52. package/lib/shared/sandboxCommandBase.js +168 -0
  53. package/lib/shared/sandboxCommandBase.js.map +1 -0
  54. package/lib/shared/sandboxProgress.d.ts +28 -0
  55. package/lib/shared/sandboxProgress.js +104 -0
  56. package/lib/shared/sandboxProgress.js.map +1 -0
  57. package/lib/shared/sandboxReporter.d.ts +1 -1
  58. package/lib/shared/sandboxRequest.d.ts +9 -0
  59. package/lib/shared/sandboxRequest.js +58 -0
  60. package/lib/shared/sandboxRequest.js.map +1 -0
  61. package/lib/shared/scratchOrgOutput.d.ts +9 -0
  62. package/lib/shared/scratchOrgOutput.js +47 -0
  63. package/lib/shared/scratchOrgOutput.js.map +1 -0
  64. package/lib/shared/stagedProgress.d.ts +33 -0
  65. package/lib/shared/stagedProgress.js +98 -0
  66. package/lib/shared/stagedProgress.js.map +1 -0
  67. package/lib/shared/timeUtils.d.ts +10 -0
  68. package/lib/shared/timeUtils.js +37 -0
  69. package/lib/shared/timeUtils.js.map +1 -0
  70. package/lib/shared/utils.d.ts +1 -1
  71. package/lib/shared/utils.js.map +1 -1
  72. package/messages/clone.md +67 -0
  73. package/messages/create.md +125 -0
  74. package/messages/create.sandbox.md +123 -0
  75. package/messages/create_scratch.md +109 -0
  76. package/messages/delete.md +47 -0
  77. package/messages/delete_sandbox.md +46 -0
  78. package/messages/delete_scratch.md +42 -0
  79. package/messages/display.md +33 -0
  80. package/messages/list.md +65 -0
  81. package/messages/messages.md +81 -0
  82. package/messages/open.md +63 -0
  83. package/messages/resume.sandbox.md +71 -0
  84. package/messages/resume_scratch.md +41 -0
  85. package/messages/sandboxbase.md +17 -0
  86. package/messages/status.md +33 -0
  87. package/oclif.manifest.json +1194 -1
  88. package/package.json +138 -28
  89. package/lib/commands/force/org/display.d.ts +0 -11
  90. package/lib/commands/force/org/display.js.map +0 -1
  91. package/lib/commands/force/org/list.d.ts +0 -15
  92. package/lib/commands/force/org/list.js +0 -191
  93. package/lib/commands/force/org/list.js.map +0 -1
  94. package/lib/commands/force/org/open.d.ts +0 -15
  95. package/lib/commands/force/org/open.js.map +0 -1
  96. package/messages/clone.json +0 -24
  97. package/messages/create.json +0 -37
  98. package/messages/delete.json +0 -13
  99. package/messages/display.json +0 -11
  100. package/messages/list.json +0 -19
  101. package/messages/messages.json +0 -24
  102. package/messages/open.json +0 -19
  103. package/messages/status.json +0 -13
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getSecondsToHuman = exports.getTimeComponentsFromSeconds = exports.getClockForSeconds = void 0;
4
+ /*
5
+ * Copyright (c) 2022, salesforce.com, inc.
6
+ * All rights reserved.
7
+ * Licensed under the BSD 3-Clause license.
8
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
9
+ */
10
+ const kit_1 = require("@salesforce/kit");
11
+ const getClockForSeconds = (timeInSec) => {
12
+ const tc = (0, exports.getTimeComponentsFromSeconds)(timeInSec);
13
+ const dDisplay = tc.days.days > 0 ? `${tc.days.days.toString()}:` : '';
14
+ const hDisplay = tc.hours.hours.toString().padStart(2, '0');
15
+ const mDisplay = tc.minutes.minutes.toString().padStart(2, '0');
16
+ const sDisplay = tc.seconds.seconds.toString().padStart(2, '0');
17
+ return `${dDisplay}${hDisplay}:${mDisplay}:${sDisplay}`;
18
+ };
19
+ exports.getClockForSeconds = getClockForSeconds;
20
+ const getTimeComponentsFromSeconds = (timeInSec) => {
21
+ const days = kit_1.Duration.days(Math.floor(timeInSec / 86400));
22
+ const hours = kit_1.Duration.hours(Math.floor((timeInSec % 86400) / 3600));
23
+ const minutes = kit_1.Duration.minutes(Math.floor((timeInSec % 3600) / 60));
24
+ const seconds = kit_1.Duration.seconds(Math.floor(timeInSec % 60));
25
+ return { days, hours, minutes, seconds };
26
+ };
27
+ exports.getTimeComponentsFromSeconds = getTimeComponentsFromSeconds;
28
+ const getSecondsToHuman = (timeInSec) => {
29
+ const tc = (0, exports.getTimeComponentsFromSeconds)(timeInSec);
30
+ const dDisplay = tc.days.days > 0 ? tc.days.toString() + ' ' : '';
31
+ const hDisplay = tc.hours.hours > 0 ? tc.hours.toString() + ' ' : '';
32
+ const mDisplay = tc.minutes.minutes > 0 ? tc.minutes.toString() + ' ' : '';
33
+ const sDisplay = tc.seconds.seconds > 0 ? tc.seconds.toString() : '';
34
+ return (dDisplay + hDisplay + mDisplay + sDisplay).trim();
35
+ };
36
+ exports.getSecondsToHuman = getSecondsToHuman;
37
+ //# sourceMappingURL=timeUtils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"timeUtils.js","sourceRoot":"","sources":["../../src/shared/timeUtils.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yCAA2C;AASpC,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAU,EAAE;IAC9D,MAAM,EAAE,GAAG,IAAA,oCAA4B,EAAC,SAAS,CAAC,CAAC;IAEnD,MAAM,QAAQ,GAAW,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/E,MAAM,QAAQ,GAAW,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAExE,OAAO,GAAG,QAAQ,GAAG,QAAQ,IAAI,QAAQ,IAAI,QAAQ,EAAE,CAAC;AAC1D,CAAC,CAAC;AATW,QAAA,kBAAkB,sBAS7B;AACK,MAAM,4BAA4B,GAAG,CAAC,SAAiB,EAAkB,EAAE;IAChF,MAAM,IAAI,GAAG,cAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,KAAM,CAAC,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,cAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,KAAM,CAAC,GAAG,IAAK,CAAC,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,cAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,IAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,cAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC;IAE7D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AAC3C,CAAC,CAAC;AAPW,QAAA,4BAA4B,gCAOvC;AACK,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAU,EAAE;IAC7D,MAAM,EAAE,GAAG,IAAA,oCAA4B,EAAC,SAAS,CAAC,CAAC;IAEnD,MAAM,QAAQ,GAAW,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1E,MAAM,QAAQ,GAAW,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7E,MAAM,QAAQ,GAAW,EAAE,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACnF,MAAM,QAAQ,GAAW,EAAE,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7E,OAAO,CAAC,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;AAC5D,CAAC,CAAC;AATW,QAAA,iBAAiB,qBAS5B"}
@@ -1,5 +1,5 @@
1
1
  import { ChildProcess } from 'child_process';
2
2
  import * as open from 'open';
3
- export declare const getAliasByUsername: (username: string) => Promise<string>;
3
+ export declare const getAliasByUsername: (username: string) => Promise<string | undefined>;
4
4
  export declare const openUrl: (url: string, options: open.Options) => Promise<ChildProcess>;
5
5
  export declare const lowerToUpper: (object: Record<string, unknown>) => Record<string, unknown>;
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/shared/utils.ts"],"names":[],"mappings":";;;AAOA,yCAA6C;AAC7C,2CAAmD;AACnD,6BAA6B;AAEtB,MAAM,kBAAkB,GAAG,KAAK,EAAE,QAAgB,EAAmB,EAAE;IAC5E,MAAM,eAAe,GAAG,MAAM,sBAAe,CAAC,WAAW,EAAE,CAAC;IAC5D,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtD,sDAAsD;IACtD,OAAO,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1D,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,GAAW,EAAE,OAAqB,EAAyB,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAAlG,QAAA,OAAO,WAA2F;AAExG,MAAM,YAAY,GAAG,CAAC,MAA+B,EAA2B,EAAE;AACvF,2GAA2G;AAC3G,qGAAqG;AACrG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,gBAAU,EAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAHhF,QAAA,YAAY,gBAGoE"}
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/shared/utils.ts"],"names":[],"mappings":";;;AAOA,yCAA6C;AAC7C,2CAAmD;AACnD,6BAA6B;AAEtB,MAAM,kBAAkB,GAAG,KAAK,EAAE,QAAgB,EAA+B,EAAE;IACxF,MAAM,eAAe,GAAG,MAAM,sBAAe,CAAC,WAAW,EAAE,CAAC;IAC5D,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtD,sDAAsD;IACtD,OAAO,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1D,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,GAAW,EAAE,OAAqB,EAAyB,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAAlG,QAAA,OAAO,WAA2F;AAExG,MAAM,YAAY,GAAG,CAAC,MAA+B,EAA2B,EAAE;AACvF,2GAA2G;AAC3G,qGAAqG;AACrG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,gBAAU,EAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAHhF,QAAA,YAAY,gBAGoE"}
@@ -0,0 +1,67 @@
1
+ # summary
2
+
3
+ Clone a sandbox org.
4
+
5
+ # success
6
+
7
+ The sandbox org cloning process %s is in progress. Run "sfdx force:org:status -n %s" to check for status. If the org is ready, checking the status also logs the requesting user in to the sandbox org and authorizes the org for use with Salesforce CLI.
8
+
9
+ # description
10
+
11
+ There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either case, you must specify both the "SandboxName" and "SourceSandboxName" options to set the names of the new sandbox and the one being cloned, respectively.
12
+
13
+ Set the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is required and must be set to "sandbox".
14
+
15
+ # examples
16
+
17
+ - $ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
18
+
19
+ - $ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
20
+
21
+ # flags.type
22
+
23
+ Type of org to create.
24
+
25
+ # flags.wait
26
+
27
+ Number of minutes to wait while polling for status.
28
+
29
+ # flags.setdefaultusername
30
+
31
+ Set the cloned org as your default.
32
+
33
+ # flags.setalias
34
+
35
+ Alias for the cloned org.
36
+
37
+ # flags.definitionfile
38
+
39
+ Path to the sandbox definition file.
40
+
41
+ # flagsLong.wait
42
+
43
+ Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
44
+
45
+ # commandSuccess
46
+
47
+ The sandbox org cloning process %s is in progress. Run "sfdx force:org:status -n %s" to check for status. If the org is ready, checking the status also logs the requesting user in to the sandbox org and authorizes the org for use with Salesforce CLI.
48
+
49
+ # missingLicenseType
50
+
51
+ The sandbox license type is required, but you didn't provide a value. Specify the license type in the sandbox definition file with the "licenseType" option, or specify the option as a name-value pair at the command-line. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm for more information.
52
+
53
+ # commandOrganizationTypeNotSupport
54
+
55
+ The only supported org type is: %s
56
+
57
+ # commandOrganizationTypeNotSupportAction
58
+
59
+ force:org:clone -t %s
60
+
61
+ # missingSourceSandboxName
62
+
63
+ Specify a value for %s in a definition file or on the command line.
64
+
65
+ # missingSourceSandboxNameAction
66
+
67
+ To indicate which sandbox org you want to clone, specify %s in a definition file or as a command line argument.
@@ -0,0 +1,125 @@
1
+ # summary
2
+
3
+ Create a scratch org or sandbox.
4
+
5
+ # deprecation
6
+
7
+ The force:org:create command is deprecated. Use org:create:scratch or org:create:sandbox.
8
+
9
+ # description
10
+
11
+ Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you specify on the command line. Values specified on the command line override values in the configuration file. Specify a configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs, —targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a production org with sandbox licenses. The —type (-t) is required if creating a sandbox.
12
+
13
+ # examples
14
+
15
+ - $ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a MyScratchOrg
16
+
17
+ - $ <%= config.bin %> <%= command.id %> edition=Developer -a MyScratchOrg -s -v devHub
18
+
19
+ - $ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org
20
+
21
+ - $ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
22
+
23
+ # flags.clientId
24
+
25
+ Connected app consumer key; not supported for sandbox org creation.
26
+
27
+ # flags.setDefaultUsername
28
+
29
+ Set the created org as the default username.
30
+
31
+ # flags.setAlias
32
+
33
+ Alias for the created org.
34
+
35
+ # flags.definitionFile
36
+
37
+ Path to an org definition file.
38
+
39
+ # flags.definitionJson
40
+
41
+ Org definition in JSON format.
42
+
43
+ # flags.noNamespace
44
+
45
+ Create the scratch org with no namespace.
46
+
47
+ # flags.noAncestors
48
+
49
+ Do not include second-generation package ancestors in the scratch org.
50
+
51
+ # flags.env
52
+
53
+ Environment where the scratch org is created: %s.
54
+
55
+ # flags.type
56
+
57
+ Type of org to create.
58
+
59
+ # flags.durationDays
60
+
61
+ Duration of the scratch org (in days) (default:7, min:1, max:30).
62
+
63
+ # flags.retry
64
+
65
+ Number of scratch org auth retries after scratch org is successfully signed up.
66
+
67
+ # flags.wait
68
+
69
+ Streaming client socket timeout (in minutes).
70
+
71
+ # scratchOrgCreateSuccess
72
+
73
+ Successfully created scratch org: %s, username: %s.
74
+
75
+ # clientIdNotSupported
76
+
77
+ -i | --clientid is not supported for the sandbox org create command. Its value, %s, has been ignored.
78
+
79
+ # noNamespaceNotSupported
80
+
81
+ -n | --nonamespace is not supported for the sandbox org create command. Its value, %s, has been ignored.
82
+
83
+ # noAncestorsNotSupported
84
+
85
+ -c | --noancestors is not supported for the sandbox org create command. Its value, %s, has been ignored.
86
+
87
+ # durationDaysNotSupported
88
+
89
+ -d | --durationdays is not supported for the sandbox org create command. Its value, %s, has been ignored.
90
+
91
+ # retryIsNotValidForSandboxes
92
+
93
+ One cannot use flag retry with Sandbox org create.
94
+
95
+ # sandboxSuccess
96
+
97
+ The sandbox org creation process %s is in progress. Run "sfdx force:org:status -n %s -u %s" to check for status. If the org is ready, checking the status also authorizes the org for use with Salesforce CLI.
98
+
99
+ # requiresUsername
100
+
101
+ This command requires a username. Specify it with the -u parameter or with the "sfdx config:set defaultusername=<username>" command.
102
+
103
+ # missingLicenseType
104
+
105
+ The sandbox license type is required, but you didn't provide a value. Specify the license type in the sandbox definition file with the "licenseType" option, or specify the option as a name-value pair at the command-line. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm for more information.
106
+
107
+ # dnsTimeout
108
+
109
+ The sandbox was successfully created and authenticated. However, the sandbox DNS records aren't ready yet and so the sandbox may not be available. Run "org:list" and check if the sandbox is listed correctly. If it isn't listed, run "force:org:status" to view its status and, if necessary, authenticate to it again. If this issue happens frequently, try setting the SFDX_DNS_TIMEOUT environment variable to a larger number; the default value is 3 seconds.
110
+
111
+ # partialSuccess
112
+
113
+ If you specified the -a or -s parameters, but the sandbox wasn't immediately available, the "force:org:create" command may not have finished setting the alias or defaultusername. If so, set the alias manually with "sfdx alias:set" and the defaultusername with "sfdx config:set".
114
+
115
+ # noConfig
116
+
117
+ Please specify an org configuration via file and/or key=value pairs.
118
+
119
+ # RequiresDevhubUsernameError
120
+
121
+ This command requires a dev hub org username set either with a flag or by default in the config.
122
+
123
+ # secretPrompt
124
+
125
+ OAuth client secret of personal connected app?
@@ -0,0 +1,123 @@
1
+ # summary
2
+
3
+ Create a sandbox org.
4
+
5
+ # description
6
+
7
+ There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.
8
+
9
+ # examples
10
+
11
+ - Create a sandbox org using a definition file and give it the alias "MyDevSandbox". The production org that contains the sandbox license has the alias "prodOrg".
12
+
13
+ <%= config.bin %> <%= command.id %> -f config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg
14
+
15
+ - Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.
16
+
17
+ <%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default
18
+
19
+ # flags.setDefault.summary
20
+
21
+ Set the sandbox org as your default org.
22
+
23
+ # flags.alias.summary
24
+
25
+ Alias for the sandbox org.
26
+
27
+ # flags.alias.description
28
+
29
+ When you create a sandbox, the generated usernames are based on the usernames present in the production org. To ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username "user@example.com" in the production org results in the username "user@example.com.mysandbox" in a sandbox named "mysandbox". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running this command.
30
+
31
+ # flags.targetOrg.summary
32
+
33
+ Username or alias of the production org that contains the sandbox license.
34
+
35
+ # flags.targetOrg.description
36
+
37
+ When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.
38
+
39
+ # flags.definitionFile.summary
40
+
41
+ Path to a sandbox definition file.
42
+
43
+ # flags.definitionFile.description
44
+
45
+ The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the defintion file.
46
+
47
+ # flags.name.summary
48
+
49
+ Name of the sandbox org.
50
+
51
+ # flags.name.description
52
+
53
+ The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a name while a sandbox is in the process of being deleted.
54
+
55
+ # flags.clone.summary
56
+
57
+ Name of the sandbox org to clone.
58
+
59
+ # flags.clone.description
60
+
61
+ The value of clone must be an existing sandbox in the same target-org.
62
+
63
+ # flags.licenseType.summary
64
+
65
+ Type of sandbox license.
66
+
67
+ # flags.wait.summary
68
+
69
+ Number of minutes to wait for the sandbox org to be ready.
70
+
71
+ # flags.wait.description
72
+
73
+ If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the "<%= config.bin %> org resume sandbox" command you run to check the status of the create. The displayed command includes the job ID for the running sandbox creation.
74
+
75
+ # flags.poll-interval.summary
76
+
77
+ Number of seconds to wait between retries.
78
+
79
+ # flags.async.summary
80
+
81
+ Request the sandbox creation, but don't wait for it to complete.
82
+
83
+ # flags.async.description
84
+
85
+ The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox creation, run "<%= config.bin %> org resume sandbox".
86
+
87
+ # flags.noPrompt.summary
88
+
89
+ Don't prompt for confirmation about the sandbox configuration.
90
+
91
+ # flags.no-track-source.summary
92
+
93
+ Do not use source tracking for this sandbox.
94
+
95
+ # flags.no-track-source.description
96
+
97
+ We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the sandbox, and to detect any conflicts between the two.
98
+
99
+ To disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the sandbox.
100
+
101
+ # isConfigurationOk
102
+
103
+ Is the configuration correct?
104
+
105
+ # warning.NoSandboxNameDefined
106
+
107
+ No SandboxName defined, generating new SandboxName: %s.
108
+
109
+ # error.SandboxNameLength
110
+
111
+ The sandbox name "%s" should be 10 or fewer characters.
112
+
113
+ # error.UserNotSatisfiedWithSandboxConfig
114
+
115
+ The sandbox request configuration isn't acceptable.
116
+
117
+ # error.pollIntervalGreaterThanWait
118
+
119
+ The poll interval (%d seconds) can't be larger that wait (%d in seconds)
120
+
121
+ # error.noCloneSource
122
+
123
+ Could not find the clone sandbox name "%s" in the target org.
@@ -0,0 +1,109 @@
1
+ # summary
2
+
3
+ Create a scratch org.
4
+
5
+ # description
6
+
7
+ There are two ways to create a scratch org: specify a definition file that contains the options or use the --edition flag to specify the one required option. If you want to set options other than the edition, such as org features or settings, you must use a definition file.
8
+
9
+ You must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default Dev Hub with the target-dev-hub configuration variable.
10
+
11
+ # examples
12
+
13
+ - Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:
14
+
15
+ <%= config.bin %> <%= command.id %> --edition=developer --alias my-scratch-org
16
+
17
+ - Specify the Dev Hub using its alias and a scratch org definition file. Set the scratch org as your default and specify that it expires in 3 days:
18
+
19
+ <%= config.bin %> <%= command.id %> --target-dev-hub=MyHub --definition-file config/project-scratch-def.json --set-default --duration-days 3
20
+
21
+ # flags.target-hub.summary
22
+
23
+ Username or alias of the Dev Hub org.
24
+
25
+ # flags.target-hub.description
26
+
27
+ Overrides the value of the target-dev-hub configuration variable, if set.
28
+
29
+ # flags.alias.summary
30
+
31
+ Alias for the scratch org.
32
+
33
+ # flags.alias.description
34
+
35
+ New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this username.
36
+
37
+ # flags.set-default.summary
38
+
39
+ Set the scratch org as your default org
40
+
41
+ # flags.no-ancestors.summary
42
+
43
+ Don't include second-generation managed package (2GP) ancestors in the scratch org.
44
+
45
+ # flags.edition.summary
46
+
47
+ Salesforce edition of the scratch org.
48
+
49
+ # flags.async.summary
50
+
51
+ Request the org, but don't wait for it to complete.
52
+
53
+ # flags.async.description
54
+
55
+ The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To resume the scratch org creation, run "<%= config.bin %> org resume scratch".
56
+
57
+ # flags.edition.description
58
+
59
+ The editions that begin with "partner-" are available only if the Dev Hub org is a Partner Business Org.
60
+
61
+ # flags.definition-file.summary
62
+
63
+ Path to a scratch org definition file.
64
+
65
+ # flags.definition-file.description
66
+
67
+ The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in the development life cycle, such as acceptance testing, packaging, or production. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for all the option you can specify in the definition file.
68
+
69
+ # flags.client-id.summary
70
+
71
+ Consumer key of the Dev Hub connected app.
72
+
73
+ # flags.wait.summary
74
+
75
+ Number of minutes to wait for the scratch org to be ready.
76
+
77
+ # flags.wait.description
78
+
79
+ If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the job ID. To resume the scratch org creation, run the org resume scratch command and pass it the job ID.
80
+
81
+ # flags.track-source.summary
82
+
83
+ Use source tracking for this scratch org. Set --no-track-source to disable source tracking.
84
+
85
+ # flags.track-source.description
86
+
87
+ We recommend you enable source tracking in scratch orgs, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the scratch org, and to detect any conflicts between the two.
88
+
89
+ To disable source tracking in the new scratch org, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the scratch org.
90
+
91
+ # flags.no-namespace.summary
92
+
93
+ Create the scratch org with no namespace, even if the Dev Hub has a namespace.
94
+
95
+ # flags.duration-days.summary
96
+
97
+ Number of days before the org expires.
98
+
99
+ # prompt.secret
100
+
101
+ OAuth client secret of your personal connected app
102
+
103
+ # success
104
+
105
+ Your scratch org is ready.
106
+
107
+ # action.resume
108
+
109
+ Resume scratch org creation by running "%s org resume scratch --job-id %s"
@@ -0,0 +1,47 @@
1
+ # summary
2
+
3
+ Delete a scratch or sandbox org.
4
+
5
+ # deprecation
6
+
7
+ The force:org:delete command is deprecated. Use org:delete:scratch or org:delete:sandbox.
8
+
9
+ # description
10
+
11
+ Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for sandboxes) and then deletes all local references to the org from your computer.
12
+
13
+ To mark the org for deletion without being prompted to confirm, specify --noprompt.
14
+
15
+ # examples
16
+
17
+ - $ <%= config.bin %> <%= command.id %> -u me@my.org
18
+
19
+ - $ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p
20
+
21
+ # flags.noprompt
22
+
23
+ No prompt to confirm deletion.
24
+
25
+ # confirmDelete
26
+
27
+ Enqueue %s org with name: %s for deletion? Are you sure (y/n)?
28
+
29
+ # sandboxConfigOnlySuccess
30
+
31
+ Successfully deleted sandbox org %s.
32
+
33
+ # ScratchOrgNotFound
34
+
35
+ Attempting to delete an expired or deleted org
36
+
37
+ # deleteOrgConfigOnlyCommandSuccess
38
+
39
+ Successfully deleted scratch org %s.'
40
+
41
+ # deleteOrgCommandSuccess
42
+
43
+ Successfully marked scratch org %s for deletion
44
+
45
+ # commandSandboxSuccess
46
+
47
+ The sandbox org %s has been successfully removed from your list of CLI authorized orgs. If you created the sandbox with one of the force:org commands, it has also been marked for deletion.
@@ -0,0 +1,46 @@
1
+ # summary
2
+
3
+ Delete a sandbox.
4
+
5
+ # description
6
+
7
+ Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.
8
+ Specify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run "<%= config.bin %> org list" to view all your orgs, including sandboxes, and their aliases.
9
+
10
+ # examples
11
+
12
+ - Delete a sandbox with alias my-sandbox:
13
+
14
+ <%= config.bin %> <%= command.id %> --target-org=my-sandbox
15
+
16
+ - Specify a username instead of an alias:
17
+
18
+ <%= config.bin %> <%= command.id %> --target-org=myusername@example.com.qa
19
+
20
+ - Delete the sandbox without prompting to confirm :
21
+
22
+ <%= config.bin %> <%= command.id %> --target-org=my-sandbox --no-prompt
23
+
24
+ # flags.target-org.summary
25
+
26
+ Sandbox alias or login user.
27
+
28
+ # flags.no-prompt.summary
29
+
30
+ Don't prompt the user to confirm the deletion.
31
+
32
+ # prompt.confirm
33
+
34
+ Are you sure you want to delete the sandbox with name: %s?
35
+
36
+ # success
37
+
38
+ Successfully marked sandbox %s for deletion.
39
+
40
+ # success.Idempotent
41
+
42
+ There is no sandbox with the username %s.
43
+
44
+ # error.isNotSandbox
45
+
46
+ The target org, %s, is not a sandbox.
@@ -0,0 +1,42 @@
1
+ # summary
2
+
3
+ Delete a scratch org.
4
+
5
+ # description
6
+
7
+ Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.
8
+ Specify a scratch org with either the username or the alias you gave the scratch org when you created it. Run "<%= config.bin %> org list" to view all your orgs, including scratch orgs, and their aliases.
9
+
10
+ # examples
11
+
12
+ - Delete a scratch org with alias my-scratch-org:
13
+
14
+ <%= config.bin %> <%= command.id %> --target-org=my-scratch-org
15
+
16
+ - Specify a username instead of an alias:
17
+
18
+ <%= config.bin %> <%= command.id %> --target-org=test-123456-abcdefg@example.com
19
+
20
+ - Delete the scratch org without prompting to confirm :
21
+
22
+ <%= config.bin %> <%= command.id %> --target-org=my-scratch-org --no-prompt
23
+
24
+ # flags.target-org.summary
25
+
26
+ Scratch org alias or login user.
27
+
28
+ # flags.no-prompt.summary
29
+
30
+ Don't prompt the user to confirm the deletion.
31
+
32
+ # prompt.confirm
33
+
34
+ Are you sure you want to delete the scratch org with name: %s?
35
+
36
+ # success
37
+
38
+ Successfully marked scratch org %s for deletion.
39
+
40
+ # success.Idempotent
41
+
42
+ Successfully deleted scratch org %s.
@@ -0,0 +1,33 @@
1
+ # summary
2
+
3
+ Display information about an org.
4
+
5
+ # description
6
+
7
+ Output includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.
8
+
9
+ Use --verbose to include the SFDX auth URL. WARNING: The SFDX auth URL contains sensitive information, such as a refresh token that can be used to access an org. Don't share or distribute this URL or token.
10
+
11
+ Including --verbose displays the sfdxAuthUrl property only if you authenticated to the org using auth:web:login (not auth:jwt:grant).
12
+
13
+ # flags.verbose.summary
14
+
15
+ Display the sfdxAuthUrl property.
16
+
17
+ # examples
18
+
19
+ - Display information about your default org:
20
+
21
+ $ <%= config.bin %> <%= command.id %>
22
+
23
+ - Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:
24
+
25
+ $ <%= config.bin %> <%= command.id %> --target-org TestOrg1 --verbose
26
+
27
+ # noScratchOrgInfoError
28
+
29
+ No information for scratch org with ID %s found in Dev Hub %s.
30
+
31
+ # noScratchOrgInfoAction
32
+
33
+ First check that you can access your Dev Hub. Then check that the ScratchOrgInfo standard object in your Dev Hub contains a record for your scratch org. In Setup, navigate to the Dev Hub page and click the Scratch Org Infos tab. If you find your scratch org, try again.