Skip to content

Commit 1291f7b

Browse files
authored
Merge pull request #331 from salesforcecli/jshackell-long-desc
Add back missing long description for "wait"
2 parents 25ad4aa + 0d3792f commit 1291f7b

File tree

6 files changed

+18
-14
lines changed

6 files changed

+18
-14
lines changed

messages/clone.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
"setalias": "alias for the cloned org",
1313
"definitionfile": "path to the sandbox definition file"
1414
},
15+
"flagsLong": {
16+
"wait": "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."
17+
},
1518
"commandSuccess": "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.",
1619
"missingLicenseType": "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.",
1720
"commandOrganizationTypeNotSupport": "The only supported org type is: %s",

messages/display.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"description": "get the description for the current or target org\nOutput includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\nUse --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.\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using auth:web:login (not auth:jwt:grant)",
33
"examples": [
4-
"sfdx force:org:display",
5-
"sfdx force:org:display -u [email protected]",
6-
"sfdx force:org:display -u TestOrg1 --json",
7-
"sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json"
4+
"$ sfdx force:org:display",
5+
"$ sfdx force:org:display -u [email protected]",
6+
"$ sfdx force:org:display -u TestOrg1 --json",
7+
"$ sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json"
88
],
99
"noScratchOrgInfoError": "No information for scratch org with ID %s found in Dev Hub %s.",
1010
"noScratchOrgInfoAction": "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."

messages/list.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"description": "list all orgs you’ve created or authenticated to",
33
"examples": [
4-
"sfdx force:org:list",
5-
"sfdx force:org:list --verbose --json",
6-
"sfdx force:org:list --verbose --json > tmp/MyOrgList.json"
4+
"$ sfdx force:org:list",
5+
"$ sfdx force:org:list --verbose --json",
6+
"$ sfdx force:org:list --verbose --json > tmp/MyOrgList.json"
77
],
88
"verbose": "list more information about each org",
99
"all": "include expired, deleted, and unknown-status scratch orgs",

messages/open.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"description": "open your default scratch org, or another specified org\nTo open a specific page, specify the portion of the URL after \"https://MyDomainName.my.salesforce.com/\" as --path.\nFor example, specify \"--path lightning\" to open Lightning Experience, or specify \"--path /apex/YourPage\" to open a Visualforce page.\nTo generate a URL but not launch it in your browser, specify --urlonly.\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.",
33
"examples": [
4-
"sfdx force:org:open",
5-
"sfdx force:org:open -u [email protected]",
6-
"sfdx force:org:open -u MyTestOrg1",
7-
"sfdx force:org:open -r -p lightning",
8-
"sfdx force:org:open -u [email protected] -b firefox"
4+
"$ sfdx force:org:open",
5+
"$ sfdx force:org:open -u [email protected]",
6+
"$ sfdx force:org:open -u MyTestOrg1",
7+
"$ sfdx force:org:open -r -p lightning",
8+
"$ sfdx force:org:open -u [email protected] -b firefox"
99
],
1010
"browser": "browser where the org opens",
1111
"cliPath": "navigation URL path",

messages/status.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"examples": [
3-
"sfdx force:org:status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
4-
"sfdx force:org:status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
3+
"$ sfdx force:org:status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
4+
"$ sfdx force:org:status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
55
],
66
"description": "report status of sandbox creation or clone and authenticate to it\nUse this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to it.\nUse the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or clone to complete before returning control of the terminal to you.\nSet the --targetusername (-u) parameter to the username or alias of the production org that contains the sandbox license.",
77
"flags": {

src/commands/force/org/clone.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export class OrgCloneCommand extends SfdxCommand {
5858
wait: flags.minutes({
5959
char: 'w',
6060
description: messages.getMessage('flags.wait'),
61+
longDescription: messages.getMessage('flagsLong.wait'),
6162
min: Duration.minutes(2),
6263
default: Duration.minutes(6),
6364
}),

0 commit comments

Comments
 (0)