@salesforce/plugin-org 2.2.24 → 2.3.0

package/messages/list.md

@@ -0,0 +1,65 @@
+# summary
+
+List all orgs you’ve created or authenticated to.
+
+# examples
+
+- List all orgs you've created or authenticated to:
+
+  $ <%= config.bin %> <%= command.id %>
+
+- List all orgs, including expired, deleted, and unknown-status orgs; don't include the connection status:
+
+  $ <%= config.bin %> <%= command.id %> --skip-connection-status --all
+
+- List orgs and remove local org authorization info about non-active scratch orgs:
+
+  $ <%= config.bin %> <%= command.id %> --clean
+
+# flags.verbose.summary
+
+List more information about each org.
+
+# flags.all.summary
+
+Include expired, deleted, and unknown-status scratch orgs.
+
+# flags.clean.summary
+
+Remove all local org authorizations for non-active scratch orgs. Use auth:logout to remove non-scratch orgs.
+
+# flags.noPrompt.summary
+
+Don't prompt for confirmation.
+
+# flags.skipConnectionStatus.summary
+
+Skip retrieving the connection status of non-scratch orgs.
+
+# prompt
+
+Found (%s) org configurations to delete. Are you sure (yes/no)?
+
+# noActiveScratchOrgs
+
+No active scratch orgs found. Specify --all to see all scratch orgs.
+
+# deleteOrgs
+
+You have %s expired or deleted local scratch org authorizations. To remove authorizations for inactive orgs, run org:list --clean.
+
+# noOrgsFound
+
+No orgs can be found.
+
+# noOrgsFoundAction
+
+Use one of the auth commands or org:create:scratch to add or create a scratch org.
+
+# noResultsFound
+
+No non-scratch orgs found.
+
+# cleanWarning
+
+Unable to clean org with username %s. You can run "sfdx org:delete:scratch -o %s" to remove it.`

package/messages/messages.md

@@ -0,0 +1,81 @@
+# HelpDefaults
+
+If not supplied, the apiversion, template, and outputdir use default values.
+
+# HelpOutputDirRelative
+
+The outputdir can be an absolute path or relative to the current working directory.
+
+# HelpOutputDirRelativeLightning
+
+If you don’t specify an outputdir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.
+
+# HelpExamplesTitle
+
+Examples:
+
+# OutputDirFlagDescription
+
+folder for saving the created files
+
+# OutputDirFlagLongDescription
+
+The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.
+
+# TemplateFlagDescription
+
+template to use for file creation
+
+# TemplateFlagLongDescription
+
+The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.
+
+# TargetDirOutput
+
+target dir = %s
+
+# App
+
+app
+
+# Event
+
+event
+
+# Interface
+
+interface
+
+# Test
+
+test
+
+# Component
+
+component
+
+# Page
+
+page
+
+# AlphaNumericNameError
+
+Name must contain only alphanumeric characters.
+
+# NameMustStartWithLetterError
+
+Name must start with a letter.
+
+# EndWithUnderscoreError
+
+Name can't end with an underscore.
+
+# DoubleUnderscoreError
+
+Name can't contain 2 consecutive underscores.
+
+# SecurityWarning
+
+This command will expose sensitive information that allows for subsequent activity using your current authenticated session.
+Sharing this information is equivalent to logging someone in under the current credential, resulting in unintended access and escalation of privilege.
+For additional information, please review the authorization section of the https://developer.salesforce.com/docs/atlas.en-us.234.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_web_flow.htm

package/messages/open.md

@@ -0,0 +1,63 @@
+# summary
+
+Open your default scratch org, or another specified org, in a browser.
+
+# description
+
+To open a specific page, specify the portion of the URL after "https://MyDomainName.my.salesforce.com/" as the value for the --path flag. For example, specify "--path lightning" to open Lightning Experience, or specify "--path /apex/YourPage" to open a Visualforce page.
+
+To generate a URL but not launch it in your browser, specify --url-only.
+
+To open in a specific browser, use the --browser flag. Supported browsers are "chrome", "edge", and "firefox". If you don't specify --browser, the org opens in your default browser.
+
+# examples
+
+- Open your default org in your default browser:
+
+  $ <%= config.bin %> <%= command.id %>
+
+- Open the org with alias MyTestOrg1 in the Firefox browser:
+
+  $ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox
+
+- Display the navigation URL for the Lightning Experience page for your default org, but don't open the page in a browser:
+
+  $ <%= config.bin %> <%= command.id %> --url-only --path lightning
+
+# flags.browser.summary
+
+Browser where the org opens.
+
+# flags.path.summary
+
+Navigation URL path to open a specific page.
+
+# flags.url-only.summary
+
+Display navigation URL, but don’t launch browser.
+
+# containerAction
+
+You are in a headless environment. To access the org %s, open this URL in a browser:
+
+%s
+
+# humanSuccess
+
+Access org %s as user %s with the following URL: %s
+
+# humanSuccessNoUrl
+
+Opening org %s as user %s
+
+# domainWaiting
+
+Waiting to resolve the Lightning Experience-enabled custom domain...
+
+# domainTimeoutError
+
+The Lightning Experience-enabled custom domain is unavailable.
+
+# domainTimeoutAction
+
+The Lightning Experience-enabled custom domain may take a few more minutes to resolve. Try the "org:open" command again.

package/messages/resume.sandbox.md

@@ -0,0 +1,71 @@
+# summary
+
+Check the status of a sandbox creation, and log in to it if it's ready.
+
+# description
+
+Sandbox creation can take a long time. If the original "<%= config.bin %> org create sandbox" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.
+
+You can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.
+
+# examples
+
+- Check the status of a sandbox creation using its name and specify a production org with alias "prodOrg":
+
+  <%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg
+
+- Check the status using the job ID:
+
+  <%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx
+
+- Check the status of the most recent sandbox create request:
+
+  <%= config.bin %> <%= command.id %> --use-most-recent
+
+# flags.id.summary
+
+Job ID of the incomplete sandbox creation that you want to check the status of.
+
+# flags.id.description
+
+The job ID is valid for 24 hours after you start the sandbox creation.
+
+# flags.targetOrg.summary
+
+Username or alias of the production org that contains the sandbox license.
+
+# flags.targetOrg.description
+
+When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.
+
+# flags.name.summary
+
+Name of the sandbox org.
+
+# flags.wait.summary
+
+Number of minutes to wait for the sandbox org to be ready.
+
+# flags.wait.description
+
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command.
+
+# flags.use-most-recent.summary
+
+Use the most recent sandbox create request.
+
+# error.NoSandboxNameOrJobId
+
+No sandbox name or job ID were provided.
+
+# error.LatestSandboxRequestNotFound
+
+Retry the command using either the --name or --job-id flags.
+
+# error.NoSandboxRequestFound
+
+Couldn't find a sandbox creation request using the provided sandbox name or job ID.
+
+# error.SandboxNameLength
+
+The sandbox name "%s" should be 10 or fewer characters.

package/messages/resume_scratch.md

@@ -0,0 +1,41 @@
+# summary
+
+Resume the creation of an incomplete scratch org.
+
+# description
+
+When the original "<%= config.bin %> org create scratch" command either times out or is run with the --async flag, it displays a job ID.
+
+Run this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.
+
+# examples
+
+- Resume a scratch org create with a job ID:
+
+  <%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY
+
+- Resume your most recent incomplete scratch org:
+
+  <%= config.bin %> <%= command.id %> --use-most-recent
+
+# flags.job-id.summary
+
+Job ID of the incomplete scratch org create that you want to resume.
+
+# flags.job-id.description
+
+The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.
+
+The job ID is valid for 24 hours after you start the scratch org creation.
+
+# flags.use-most-recent.summary
+
+Use the job ID of the most recent incomplete scratch org.
+
+# error.NoRecentJobId
+
+There are no recent job IDs (ScratchOrgInfo requests) in your cache. Maybe it completed or already resumed?
+
+# success
+
+Your scratch org is ready.

package/messages/sandboxbase.md

@@ -0,0 +1,17 @@
+# sandboxSuccess
+
+The sandbox org creation was successful.
+
+# sandboxSuccess.actions
+
+The username for the sandbox is %s.
+You can open the org by running "%s org open -e %s"
+
+# checkSandboxStatus
+
+Run "%s org resume sandbox --job-id %s -o %s" to check for status.
+If the org is ready, checking the status also authorizes the org for use with Salesforce CLI.
+
+# warning.ClientTimeoutWaitingForSandboxCreate
+
+The wait time for the sandbox creation has been exhausted. Please see the results below for more information.

package/messages/status.md

@@ -0,0 +1,33 @@
+# summary
+
+Check the status of a sandbox, and if complete, authenticate to it.
+
+# examples
+
+- $ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg
+
+- $ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
+
+# description
+
+Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to it.
+
+Use 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.
+
+Set the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.
+
+# flags.sandboxname
+
+Name of the sandbox org to check status for.
+
+# flags.wait
+
+Number of minutes to wait while polling for status.
+
+# flags.setdefaultusername
+
+Set the created or cloned org as your default.
+
+# flags.setalias
+
+Alias for the created or cloned org.