1 | "use strict";
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 | const os = require("os");
|
9 | const util = require("util");
|
10 | const ts_types_1 = require("@salesforce/ts-types");
|
11 | const TARGET_USERNAME_PARAM = 'targetusername';
|
12 | const PERF_LOG_LEVEL_PARAM = 'perflog';
|
13 | const messages = {
|
14 | default: {
|
15 | en_US: {
|
16 |
|
17 | actionRequiredHeader: 'Action Required!',
|
18 |
|
19 | WildCardError: 'ERROR: This command doesn\'t support wildcards. Remove the wildcard, and run the command again.\nSee --help for examples.',
|
20 | GeneralCommandFailure: 'This command failed.',
|
21 | InvalidProjectWorkspace: 'This directory does not contain a valid Salesforce DX project.',
|
22 | MissingClientConfig: 'Missing a client configuration. Please run the config command.',
|
23 | TestMessage: 'This is a test message do not change.',
|
24 | MissingAppConfig: 'The current project is invalid. sfdx-project.json is missing.',
|
25 | OldSfdxWorkspaceJsonPresent: 'Project file %s/sfdx-workspace.json needs to be renamed to sfdx-project.json',
|
26 | UndefinedLocalizationLabel: 'Missing label %s:%s for locale %s.',
|
27 | LoginServerNotFound: 'The hostname for the login server is not found: %s:%s',
|
28 | InvalidProjectDescriptor: 'This project descriptor is in invalid. The attribute [%s] is not found.',
|
29 | MissingRequiredParameter: 'A required parameter [%s] is missing.',
|
30 | InvalidParameter: 'Invalid [%s] parameter: %s',
|
31 | MissingScratchOrgNamespace: 'The [NamespacePrefix] is missing from the ScratchOrgInfo.',
|
32 | MaxOrgIds: 'The maximum number of local orgs (%s) has been reached',
|
33 | MaxOrgIdsAction: 'Use "sfdx force:org:list --clean" to remove outdated org configurations.',
|
34 | UserSessionIsInvalid: '%s: The user session for this org is expired or invalid. Please run config.',
|
35 | MissingScratchOrgDef: 'A scratch org definition file not found at %s. Please create it.',
|
36 | NonScratchOrgPush: 'You can push source only to scratch orgs using this command. ' +
|
37 | 'Use "sfdx force:source:deploy" or "sfdx force:mdapi:deploy" to deploy changes to orgs that don’t have change tracking.',
|
38 | ProblemQueryingOrganizationSettingsDetail: 'No organization settings found',
|
39 | ProblemSettingOrgPrefs: 'Cannot set org preferences. %s',
|
40 | ProblemDeployingSettings: 'Failed to deploy settings to scratch org.',
|
41 | PathDoesNotExist: 'The specified path [%s] does not exist',
|
42 | InvalidArgumentFilePath: 'Invalid argument to --%s. You specified a directory path [%s], but a file is required.',
|
43 | InvalidArgumentDirectoryPath: 'Invalid argument to --%s. You specified a file path [%s], but a directory is required.',
|
44 | InvalidValueForDefaultPath: 'In sfdx-project.json, set the default to true or false. Example: [{ "path": "packageDirectory1", "default": true }, { "path": "packageDirectory2", "default": false }]',
|
45 | MultipleDefaultPaths: 'In sfdx-project.json, indicate only one package directory (path) as the default.',
|
46 | MissingDefaultPath: 'In sfdx-project.json, be sure to specify which package directory (path) is the default. Example: [{ "path": "packageDirectory1", "default": true }, { "path": "packageDirectory2" }]',
|
47 | InvalidPackageDirectory: 'The path %s, specified in sfdx-project.json, does not exist. Be sure this directory is included in your project root.',
|
48 | InvalidAbsolutePath: 'The path %s, specified in sfdx-project.json, must be indicated as a relative path to the project root.',
|
49 | IncorrectLogLevel: 'valid values are {%s}',
|
50 | LoggerNameRequired: 'A logger name is required',
|
51 | InvalidVariableReference: 'Invalid variable reference: variable "%s" not found or unset.',
|
52 | ValidationSchemaFieldErrors: 'Schema validation failed with following errors:\n%s',
|
53 | ValidationSchemaUnknown: 'Schema validation failed with unknown error',
|
54 | InvalidJson: 'An error occurred parsing "%s"',
|
55 | JsonParseError: 'Parse error in file %s on line %s\n%s\n',
|
56 | InvalidJsonCasing: 'All JSON input must have heads down camelcase keys. E.g., { sfdcLoginUrl: "https://login.salesforce.com" }\nFound "%s" in\n%s',
|
57 | NoWorkspaceOrUser: `Command must be executed in a project directory or with the --${TARGET_USERNAME_PARAM} flag.`,
|
58 | OrgDataNotAvailableError: 'An attempt to refresh the authentication token failed with a "Data Not Found Error". The org identified by username %s doesn\'t appear to exist. Likely cause is that the org was deleted by another user or has expired.',
|
59 | OrgDataNotAvailableErrorAction: 'Run "sfdx force:org:list --clean" to remove stale org authentications.\nUse "sfdx force:config" to update the defaultusername.\nUse "sfdx force:org:create" to create a new org.\nUse "sfdx force:auth" to authenticate an existing org.',
|
60 | InvalidCommandGroup: 'You have specified an invalid command group in which to stash your values. Please verify that you are specifying a valid command or register your command in stash.js under Stash#Commands.',
|
61 |
|
62 | schemaInfoOption: 'display schema information for the --%s configuration file to stdout; if you use this option, all other options except --json are ignored',
|
63 | schemaInfoOptionLong: 'Displays the schema information for the configuration file. If you use this option, all other options, except --json, are ignored.',
|
64 | invalidInstanceUrlForAccessTokenAction: 'Verify that the instanceUrl config setting is set to the instance that the access token belongs to.' +
|
65 | '\nUse "sfdx force:config:list" to view your current setting.' +
|
66 | '\nUse "sfdx force:config:set instanceUrl=<instance URL> --global" to set your instanceUrl to the correct instance.',
|
67 | invalidBooleanConfigValue: 'The config value can only be set to true or false.',
|
68 | cliForceConfigHelp: 'configures this project with a scratch org',
|
69 | cliForceConfigHelpClientId: 'specify the connected app client ID for the master org',
|
70 | cliForceConfigHelpClientSecret: 'specify the connected app client secret for the master org',
|
71 | cliForceConfigHelpClientRedirectUri: 'specify the connected app redirect uri for the master org',
|
72 | cliForceConfigHelpUsername: 'the master org username',
|
73 | cliForceConfigHelpPassword: 'the master org password',
|
74 | cliForceConfigHelpSuccess: 'successfully updated the SFDC accessToken',
|
75 | cliForceSyncHelp: 'synchronize Salesforce source between the scratch org and the project',
|
76 | cliForceSyncUpHelp: 'synchronize project source to the scratch org',
|
77 | cliForceSyncDownHelp: 'synchronize scratch org source to the project',
|
78 | cliForceHelp: 'tools for the Salesforce developer',
|
79 | cliForceSyncTypeHelp: '[All | Changed] Sync all or only the changed source. All is default.',
|
80 | cliForceRefreshHelp: 'Refreshes the auth token for the scratch org.',
|
81 | cliForceRefreshSuccess: 'Successfully reset the org auth token. Chive on!',
|
82 | cliForceCreateHelpType: 'The type of source to create. Values: [ScratchOrg]]',
|
83 | cliForceCreateHelpFile: 'Path to a file containing org signup parameters, in JSON format.',
|
84 | cliForceCreateHelpJson: 'The org signup parameters in JSON format.',
|
85 | cliForceCreateHelpPassword: 'Password for the admin user.',
|
86 | cliForceCreateMessageWrongType: 'Unsupported type. Valid types are [%s].',
|
87 | cliForceCreateMessageSuccess: 'Scratch org successfully created with id: %s',
|
88 | cliForceCreateMessagePassword: 'Setting org password...',
|
89 | cliForceCreateMessagePasswordOk: 'Ok',
|
90 | cliForceCreateNoConfig: 'Please specify an org configuration via file and/or key=value pairs',
|
91 | cliForceTestRunHelp: 'Invoke Apex tests in a given org.',
|
92 | cliForceTestRunHelp_results: 'Wait for results. Display results when tests are complete. If false, use "getTestResults -i [runTestId]" command to get results.',
|
93 | cliForceTestRunHelp_classIds: 'Apex Class Ids to test.',
|
94 | cliForceTestRunHelp_suiteIds: 'Test Suite Ids to test (WIP).',
|
95 | cliForceTestGetResultsHelp: 'Retrieve test results for given runTestId in a given org.',
|
96 | cliForceTestGetResultsHelp_id: 'Id of test run.',
|
97 | oauthBrowserSuccess: 'Successfully updated the auth configuration for the org.',
|
98 | closeTheBrowser: 'You may now close the browser.',
|
99 | urlStateMismatch: 'The Oauth redirect listener encountered an http request that is not trusted. Ignoring.',
|
100 | keyChainItemCreateFailed: 'Attempting to create an encryption key failed. %s',
|
101 | UnsupportedOperatingSystem: 'Unsupported Operating System: %s',
|
102 | invalidEncryptedFormat: 'The encrypted data is not properly formatted.',
|
103 | invalidEncryptedFormatAction: 'If attempting to create a scratch org then re-authorize. Otherwise create a new scratch org.',
|
104 | authDecryptFailed: 'Failed to decipher auth data. reason: %s.',
|
105 | genericTimeoutMessage: 'Socket timeout occurred while listening for results.',
|
106 | genericTimeoutCommandWaitMessageAction: 'Use command "%s" to retry. You may consider increasing --wait parameter value to increase timeout.',
|
107 | genericTimeoutWaitMessageAction: 'You may consider increasing the --wait parameter value to increase timeout.',
|
108 | subscriberHandshakeTimeout: 'Subscriber handshake failed due to a socket timeout.',
|
109 | subscriberHandshakeTimeoutAction: 'Check your connection to force.com and try again',
|
110 | herokuTopicDescription: 'tools for the Salesforce developer',
|
111 | invalidApiVersion: 'An invalid api version is being reported by config. (apiVersion=%s)',
|
112 | streamingWait: 'the streaming client socket timeout (in minutes)',
|
113 | streamingWaitLong: 'Sets the streaming client socket timeout, in minutes. ' +
|
114 | 'If the streaming client socket has no contact from the server for a number of minutes, the client exits. ' +
|
115 | 'Specify a longer wait time if timeouts occur frequently.',
|
116 | createOrgCommandDuration: 'duration of the scratch org (in days) (default:7, min:1, max:30)',
|
117 | createOrgCommandDurationLong: 'Sets the duration of the scratch org, in days. ' + 'Valid values are from 1-30. The default is 7 days.',
|
118 | unrecognizedScratchOrgOption: '%s is not a supported option for scratch org configuration.',
|
119 | herokuNamespaceDescription: 'tools for the Salesforce developer',
|
120 | jsonOutputOption: 'format output as json',
|
121 | jsonOutputOptionLong: 'Format output as JSON.',
|
122 | loglevelOption: 'logging level for this command invocation',
|
123 | loglevelOptionLong: 'The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.',
|
124 | usernameOption: 'username or alias for the target org',
|
125 | usernameOptionLong: 'A username or alias for the target org.',
|
126 | targetUsernameOption: 'username or alias for the target org; overrides default target org',
|
127 | targetUsernameOptionLong: 'A username or alias for the target org. Overrides the default target org.',
|
128 | perfLogLevelOption: 'get API performance data',
|
129 | perfLogLevelOptionLong: 'Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json',
|
130 | invalidPortNumber: 'Invalid OAuth redirect port number defined: %s',
|
131 | ClientSecretRequired: 'The client secret is required.',
|
132 | authorizeCommandMissingJwtOption: 'Both username and file must be provided.',
|
133 | authorizeCommandMissingClientId: 'The client ID is required for the JWT-based authentication process',
|
134 | authorizeCommandSuccess: 'Successfully authorized %s with org ID %s',
|
135 | authorizeCommandCloseBrowser: 'You may now close the browser',
|
136 | createOrgCommandSuccess: 'Successfully created scratch org: %s, username: %s',
|
137 | createOrgCommandDescription: 'create a scratch org',
|
138 | createOrgCommandDescriptionLong: 'Creates a scratch org using values specified in a configuration file or ' +
|
139 | 'key=value pairs that you specify on the command line. Values specified on the command line override values in the configuration file.',
|
140 | createOrgCommandHelp: 'To set up a connected app for your new scratch org, specify the value that was ' +
|
141 | 'returned when you created a connected app in your Dev Hub org as --clientid.' +
|
142 | '\n\nExamples:' +
|
143 | '\n $ sfdx force:org:create -f config/enterprise-scratch-def.json -a TestOrg1' +
|
144 | '\n $ sfdx force:org:create -a MyDevOrg -s -v me@myhub.org edition=Developer' +
|
145 | '\n $ sfdx force:org:create -f config/enterprise-scratch-def.json -a OrgWithOverrides username=testuser1@mycompany.org',
|
146 | createOrgCommandClientId: 'connected app consumer key',
|
147 | createOrgCommandClientIdLong: 'Connected app consumer key, as configured in your Dev Hub.',
|
148 | createOrgCommandSet: 'set the created org as the default username',
|
149 | createOrgCommandSetLong: 'Sets the created org as the default username.',
|
150 | createOrgCommandAlias: 'set an alias for the created scratch org',
|
151 | createOrgCommandAliasLong: 'Sets an alias for the created scratch org.',
|
152 | createOrgTargetDevhubUsername: 'username or alias for the dev hub org; overrides default dev hub org',
|
153 | createOrgTargetDevhubUsernameLong: 'A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.',
|
154 | createOrgCommandFile: 'path to a scratch org definition file',
|
155 | createOrgCommandFileLong: 'Path to a scratch org definition file. Either --definitionfile or ' +
|
156 | 'a vararg value for edition (for example, edition=Developer) is required. ' +
|
157 | 'Varargs override the values in the scratch org definition file.',
|
158 | createOrgCommandObject: 'scratch org definition in json format ',
|
159 | createOrgCommandObjectLong: 'Scratch org definition in JSON format. Either --definitionfile or ' + '--definitionjson is required.',
|
160 | createOrgCommandNoNamespace: 'creates the scratch org with no namespace',
|
161 | createOrgCommandNoNamespaceLong: 'Creates the scratch org with no namespace. Useful when using a scratch ' +
|
162 | 'org to test installations of packages with namespaces.',
|
163 | createOrgCommandNoAncestors: 'do not include second-generation package ancestors in the scratch org',
|
164 | createOrgCommandNoAncestorsLong: 'Do not include second-generation package ancestors in the scratch org.',
|
165 | createOrgCommandEnv: 'environment where the scratch org is created: [%s]',
|
166 | createOrgCommandEnvLong: 'Environment where the scratch org is created: [%s].',
|
167 | createOrgCommandUnauthorized: 'You do not have access to the [%s] object',
|
168 | createOrgTimeoutHintNoIdAction: 'Retry creating the org but increase the wait timeout.',
|
169 | apexReportCommandNoTestFound: 'No test found with the given names [%s]',
|
170 | apexReportCommandNoJobId: 'No test run job ID found.',
|
171 | apexReportCommandInvalidJobId: 'Invalid test run job ID: ',
|
172 | apexReportCommandInvalidResponse: 'Invalid API response: %s',
|
173 | apexReportCommandTestResultRetrievalFailed: 'Unable to get test results for job [%s]: [%s]',
|
174 | apexReportCommandCodeCoverageRetrievalFailed: 'Unable to get code coverage for job [%s]: [%s]',
|
175 | CoverageWithoutReporter: 'A result format is required when specifying codecoverage',
|
176 | apexTestApiInvalidReporter: 'Unknown result format type. Must be one of the following values: %s',
|
177 | apexTestApiInvalidTestRunId: 'Test run job ID not found: %s',
|
178 | apexTestApiInvalidTestLevel: 'Unknown testlevel `%s`. Must be one of the following values: [%s]',
|
179 | apexTestApiIncorrectTestLevel: 'When specifying classnames, suitenames, or tests, the provided testlevel must be RunSpecifiedTests',
|
180 | apexTestApiInvalidParams: 'Specify either classnames, suitenames, or tests',
|
181 | InvalidAsyncTestJob: 'Unable to invoke async test job: %s',
|
182 | InvalidAsyncTestJobUnknownAction: 'Try running the tests in the Developer Console by using force:org:open, or create a new scratch org and try again.',
|
183 | InvalidAsyncTestJobNoneFound: 'Unable to invoke any tests. Ensure the tests are loaded into the org or valid inputs are supplied.',
|
184 | unsupportedValueForEnv: 'Unsupported value for env: [%s]',
|
185 | unsupportedValueForDuration: 'Unsupported value for durationdays (must be 1-30): [%s]',
|
186 | invalid_client: 'Invalid client credentials. Verify the OAuth client secret and ID.',
|
187 | signupFailed: 'The request to create a scratch org failed with error code: %s.',
|
188 | signupFailedUnknown: 'An unknown server error occurred. Please try again. If you still see this error, contact Salesforce support for assistance. Include the information from "sfdx force:data:record:get -s ScratchOrgInfo -i %s -u %s".',
|
189 | signupFailedAction: 'See https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_signuprequest.htm for information on error code %s.',
|
190 | signupUnexpected: 'The request to create a scratch org returned an unexpected status',
|
191 | signupFieldsMissing: 'Required fields are missing for org creation: [%s]',
|
192 | signupDuplicateSettingsSpecified: "You cannot use 'settings' and `'orgPreferences' in your scratch definition file, please specify one or the other.",
|
193 | pushCommandAsyncRequestInvalidated: 'Salesforce cancelled the job because the results might not be valid. Is there a newer compile request?',
|
194 | pushCommandAsyncRequestUnexpected: 'An unexpected error occurred during deploy.',
|
195 | pushCommandCliInvalidUsernameOption: 'Invalid value for username',
|
196 | pullCommandConflictMsg: 'We couldn’t complete the pull operation due to conflicts. Verify that you want to keep the remote versions, then run "sfdx force:source:pull -f" with the --forceoverwrite (-f) option.',
|
197 | MissingMetadataExtension: "Expected file at path: %s to end with the '-meta.xml' extension. Please rename the file to %s",
|
198 | MissingMetadataFileWithMetaExt: "Expected metadata file with '-meta.xml' extension at path: %s",
|
199 | MissingMetadataFile: 'Expected metadata file at path: %s',
|
200 | MissingContentFile: 'Expected content file(s) at path(s): %s',
|
201 | MissingContentOrMetadataFile: 'Expected file at path: %s',
|
202 | UnsupportedMimeTypes: 'The following MIME types are not supported: %s',
|
203 | statusCommandCliDescription: 'list local changes and/or changes in a scratch org',
|
204 | statusCommandCliLongDescription: 'Lists changes that have been made locally, in a scratch org, or both.',
|
205 | statusCommandCliHelp: 'Examples:' +
|
206 | '\n $ sfdx force:source:status -l' +
|
207 | '\n $ sfdx force:source:status -r' +
|
208 | '\n $ sfdx force:source:status -a' +
|
209 | '\n $ sfdx force:source:status -a -u me@example.com --json',
|
210 | statusCommandAllOptionDescription: 'list all the changes that have been made',
|
211 | statusCommandAllOptionDescriptionLong: 'Lists all the changes that have been made.',
|
212 | statusCommandLocalOptionDescription: 'list the changes that have been made locally',
|
213 | statusCommandLocalOptionDescriptionLong: 'Lists the changes that have been made locally.',
|
214 | statusCommandRemoteOptionDescription: 'list the changes that have been made in the scratch org',
|
215 | statusCommandRemoteOptionDescriptionLong: 'Lists the changes that have been made in the scratch org.',
|
216 | statusCommandHumanSuccess: 'Source Status',
|
217 | mdapiPullCommandNoDataReturned: 'No metadata was returned by the retrieve',
|
218 |
|
219 | mdapiCliWaitTimeExceededError: 'Your %s request did not complete within the specified wait time [%s minutes]. Try again with a longer wait time.',
|
220 | mdapiCliExclusiveFlagError: 'Specify either --%s or --%s but not both.',
|
221 | mdapiCliInvalidWaitError: 'Specify the number of minutes to wait as a numerical value greater than or equal to -1. You can specify a decimal value if it is greater than 0.',
|
222 | mdapiDeployFailed: 'The metadata deploy operation failed.',
|
223 |
|
224 | mdapiTopicDescription: 'retrieve and deploy metadata using Metadata API',
|
225 | mdapiTopicLongDescription: 'Use the mdapi commands to retrieve and deploy Metadata API–formatted files that ' +
|
226 | 'represent components in an org, or to convert Metadata API–formatted metadata into the source format used in ' +
|
227 | 'Salesforce DX projects.',
|
228 |
|
229 | mdDeployCommandCliInvalidUsernameOption: 'That target username doesn’t exist. Try again with a valid target username.',
|
230 | mdDeployCommandCliZipFileError: 'The --zipfile parameter requires a file path to a zip file. Try again.',
|
231 | mdDeployCommandCliWaitTimeExceededError: 'The deploy request did not complete within the specified wait time [%s minutes].\n' +
|
232 | 'To check the status of this deployment, run "sfdx force:mdapi:deploy:report"',
|
233 | mdDeployCommandCliInvalidJobIdError: 'The job for [%s] doesn’t exist. Try again with a valid job ID.',
|
234 | mdDeployCommandCliInvalidRequestIdError: 'The value [%s] provided for ID is not valid. It should be 15 or 18 characters long.',
|
235 | mdDeployCommandCliInvalidRollbackError: 'The rollbackonerror parameter cannot be %s. Specify either "true" or "false"',
|
236 | mdDeployCommandCliNoRestDeploy: 'REST deploy is not available for this org. This feature is currently for internal Salesforce use only.',
|
237 |
|
238 | mdDescribeMetadataCommandCliDescription: 'display the metadata types enabled for your org',
|
239 | mdDescribeMetadataCommandCliLong: 'Displays details about metadata types enabled for your org. Use this information to identify the ' +
|
240 | 'syntax needed for a <name> element in package.xml. The most recent API version is the default, or you can specify an older version.',
|
241 | mdDescribeMetadataCommandCliHelp: 'The default target username is the admin user for the default scratch org. The username must have ' +
|
242 | 'the Modify All Data permission or the Modify Metadata permission (Beta). For more information about permissions, see Salesforce Help.' +
|
243 | '\n\nExamples:' +
|
244 | '\n $ sfdx force:mdapi:describemetadata -a 43.0' +
|
245 | '\n $ sfdx force:mdapi:describemetadata -u me@example.com' +
|
246 | '\n $ sfdx force:mdapi:describemetadata -f /path/to/outputfilename.txt' +
|
247 | '\n $ sfdx force:mdapi:describemetadata -u me@example.com -f /path/to/outputfilename.txt',
|
248 | mdDescribeMetadataCommandCliApiVersion: 'API version to use (the default is %s)',
|
249 | mdDescribeMetadataCommandCliApiVersionLong: 'The API version to use. The default is the latest API version (%s).',
|
250 | mdDescribeMetadataCommandCliResultFile: 'path to the file where results are stored',
|
251 | mdDescribeMetadataCommandCliResultFileLong: 'The path to the file where the results of the command are stored. Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the console.',
|
252 | mdDescribeMetadataCommandCliFilterKnown: 'filter metadata known by the CLI',
|
253 | mdDescribeMetadataCommandCliFilterKnownLong: 'Filters all the known metadata from the result such that all that is left are the types not yet fully supported by the CLI.',
|
254 | mdDescribeMetadataCommandCliInvalidApiVersionError: 'To display metadata from an earlier API version, use --apiversion and specify a positive numerical value less than or equal to the current API version (%s).',
|
255 |
|
256 | mdListmetadataCommandCliDescription: 'display properties of metadata components of a specified type',
|
257 | mdListmetadataCommandCliLong: 'Displays properties of metadata components of a specified type. This call is useful when you want to identify ' +
|
258 | 'individual components in your manifest file or if you want a high-level view of particular components in your organization. ' +
|
259 | 'For example, you could use this target to return a list of names of all Layout components in your org, then use this information in a retrieve operation that returns a subset of these components.',
|
260 | mdListmetadataCommandCliHelp: 'The default target username is the admin user for the default scratch org.' +
|
261 | '\n\nExamples:' +
|
262 | '\n $ sfdx force:mdapi:listmetadata -m CustomObject' +
|
263 | '\n $ sfdx force:mdapi:listmetadata -m CustomObject -a 43.0' +
|
264 | '\n $ sfdx force:mdapi:listmetadata -m CustomObject -u me@example.com' +
|
265 | '\n $ sfdx force:mdapi:listmetadata -m CustomObject -f /path/to/outputfilename.txt' +
|
266 | '\n $ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername' +
|
267 | '\n $ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -a 43.0' +
|
268 | '\n $ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -u me@example.com' +
|
269 | '\n $ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -f /path/to/outputfilename.txt' +
|
270 | '\n $ sfdx force:mdapi:listmetadata -m CustomObject -u me@example.com -f /path/to/outputfilename.txt',
|
271 | mdListmetadataCommandCliApiVersion: 'API version to use (the default is %s)',
|
272 | mdListmetadataCommandCliApiVersionLong: 'The API version to use. The default is the latest API version (%s).',
|
273 | mdListmetadataCommandCliResultFile: 'path to the file where results are stored',
|
274 | mdListmetadataCommandCliResultFileLong: 'The path to the file where the results of the command are stored. The default output destination is the console.',
|
275 | mdListmetadataCommandCliInvalidApiVersionError: 'To display metadata from an earlier API version, use --apiversion and specify a positive numerical value less than or equal to the current API version (%s).',
|
276 | mdListmetadataCommandCliMetadatatype: 'metadata type to be retrieved, such as CustomObject; metadata type value is case-sensitive',
|
277 | mdListmetadataCommandCliMetadatatypeLong: 'The metadata type to be retrieved, such as CustomObject or Report. The metadata type value is case-sensitive.',
|
278 | mdListmetadataCommandCliFolder: 'folder associated with the component; required for components that use folders; folder names are case-sensitive',
|
279 | mdListmetadataCommandCliFolderLong: 'The folder associated with the component. This parameter is required for components that use folders, such as Dashboard, Document, EmailTemplate, or Report. The folder name value is case-sensitive.',
|
280 |
|
281 | mdRetrieveCommandCliInvalidUsernameOption: 'That target username doesn’t exist. Try again with a valid target username.',
|
282 | mdRetrieveCommandCliWaitTimeExceededError: 'The retrieve request did not complete within the specified wait time [%s minutes].\n' +
|
283 | 'To check the status of this retrieve, run "sfdx force:mdapi:retrieve:report%s"',
|
284 | mdRetrieveCommandCliTooManyPackagesError: 'You specified [%s]. Try again and specify only one package when using --singlepackage.',
|
285 | mdRetrieveCommandCliInvalidProjectError: 'You can’t create a manifest from an artifact when you’re not in a project. ' +
|
286 | 'Move into a valid project or specify the manifest location using a parameter (--packagenames, --unpackaged).',
|
287 | mdRetrieveCommandCliInvalidApiVersionError: 'Specify the API version as a positive numerical value less than or equal to the current API version (%s).',
|
288 | mdapiRetrieveFailed: 'The metadata retrieve operation failed: %s',
|
289 | pollTimeout: 'polling timeout in milliseconds (default %s ms)',
|
290 | pollInterval: 'polling interval in milliseconds (default %s ms)',
|
291 | waitParamValidValueError: 'Invalid value was specified for wait. Please provide a wait value greater than %s minutes.',
|
292 | orgTopicDescription: 'manage your orgs',
|
293 | orgTopicDescriptionLong: 'Use the org commands to manage the orgs you use with Salesforce CLI. Create and delete scratch orgs, ' +
|
294 | 'list your created and authorized orgs, and open orgs in your browser.',
|
295 | orgShapeTopicDescription: 'manage your org shapes',
|
296 | orgShapeTopicDescriptionLong: 'Use the org:shape commands to manage the org shapes you use with Salesforce CLI. Create and delete org shapes, ' +
|
297 | 'and list your created org shapes.',
|
298 | openCommandCliDescription: 'open an org in your browser',
|
299 | openCommandCliDescriptionLong: 'Opens an org in your browser.',
|
300 | openCommandCliHelp: 'Opens your default scratch org, or another org that you specify.' +
|
301 | '\n\nTo open a specific page, specify the portion of the URL after "yourInstance.salesforce.com/" as --path. ' +
|
302 | '\nFor example, specify "--path lightning" to open Lightning Experience, or specify "--path /apex/YourPage" to open ' +
|
303 | 'a Visualforce page.' +
|
304 | '\n\nTo generate a URL but not launch your browser, specify --urlonly.' +
|
305 | '\n\nExamples:' +
|
306 | '\n $ sfdx force:org:open' +
|
307 | '\n $ sfdx force:org:open -u me@my.org' +
|
308 | '\n $ sfdx force:org:open -u MyTestOrg1' +
|
309 | '\n $ sfdx force:org:open -r -p lightning',
|
310 | openCommandCliPath: 'navigation URL path',
|
311 | openCommandCliPathLong: 'Navigation URL path (not including domain).',
|
312 | openCommandUrlonly: 'display navigation URL, but don’t launch browser',
|
313 | openCommandUrlonlyLong: 'Displays a navigation URL, but doesn’t launch your browser.',
|
314 | openCommandContainerAction: `You are in a headless environment. To access the org %s, open this URL in a browser:${os.EOL}${os.EOL}%s`,
|
315 | openCommandHumanSuccess: 'Access org %s as user %s with the following URL: %s',
|
316 | openCommandDomainWaiting: 'Waiting to resolve the Lightning Experience-enabled custom domain...',
|
317 | openCommandDomainTimeoutError: 'The Lightning Experience-enabled custom domain is unavailable.',
|
318 | openCommandDomainTimeoutAction: 'The Lightning Experience-enabled custom domain may take a few more minutes to resolve. Try the "force:org:open" command again.',
|
319 | accessTokenLoginUrlNotSet: 'The instance URL is not set, or is incorrect for the given access token. API Error: %s',
|
320 | displayCommandCliDescription: 'get org description',
|
321 | displayCommandCliDescriptionLong: 'Gets the description for the current or target org.',
|
322 | displayCommandCliHelp: 'Output includes your access token, client ID, connected status, ' +
|
323 | 'org ID, instance URL, username, and alias, if applicable. ' +
|
324 | '\n\nUse --verbose to include the SFDX auth URL. Including --verbose displays the sfdxAuthUrl property ' +
|
325 | 'only if you authenticated to the org using force:auth:web:login (not force:auth:jwt:grant).' +
|
326 | '\n\nExamples:' +
|
327 | '\n $ sfdx force:org:display' +
|
328 | '\n $ sfdx force:org:display -u me@my.org' +
|
329 | '\n $ sfdx force:org:display -u TestOrg1 --json' +
|
330 | '\n $ sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json',
|
331 | displayCommandHumanSuccess: 'Org Description',
|
332 | userTopicDescription: 'perform user-related admin tasks',
|
333 | userTopicDescriptionLong: 'Use the user commands to perform user-related admin tasks.',
|
334 | assignCommandCliDescription: 'assign a permission set to one or more users of an org',
|
335 | assignCommandCliDescriptionLong: 'Assigns a named permission set to one or more users of an org.',
|
336 | assignCommandCliHelp: 'Defaults to the defaultusername.' +
|
337 | '\n\nExamples:' +
|
338 | '\n $ sfdx force:user:permset:assign -n DreamHouse' +
|
339 | '\n $ sfdx force:user:permset:assign -n DreamHouse -u me@my.org' +
|
340 | '\n $ sfdx force:user:permset:assign -n DreamHouse -o user1@my.org,user2,user3',
|
341 | assignCommandCliName: 'the name of the permission set to assign',
|
342 | assignCommandCliNameLong: 'The name of the permission set to assign.',
|
343 | assignCommandPermissionSetNotFoundError: 'Permission set "%s" not found in target org. Do you need to push source?',
|
344 | assignCommandPermissionSetNotFoundForNSError: 'Permission set "%s" for namespace "%s" not found in target org. Do you need to push source or install the package?',
|
345 | assignCommandOnBehalfOf: 'comma-separated list of usernames or aliases to assign the permission set to',
|
346 | assignCommandOnBehalfOfLong: 'Comma-separated list of usernames or aliases to assign the permission set to.',
|
347 | pullCommandMetadataTypeLabel: 'Metadata Type',
|
348 | pullCommandMetadataTypePath: 'Metadata Path',
|
349 | pullCommandCliPreExecute: 'Pulling source changes from org %s as user %s',
|
350 | pullCommandHumanSuccess: 'Pulled Source',
|
351 | packageCliDescription: 'develop and install packages',
|
352 | packageCliDescriptionLong: 'Use the package commands to develop and install packages.',
|
353 | package1CliDescription: 'develop first-generation managed and unmanaged packages',
|
354 | package1CliDescriptionLong: 'Use the package1 commands to create and view first-generation package versions in your Dev Hub org.',
|
355 | package1VersionCreateCommandCliDescription: 'create a first-generation package version in the release org',
|
356 | package1VersionCreateCommandCliDescriptionLong: 'Creates a first-generation package version in the release org.',
|
357 | package1VersionCreateCommandCliHelp: 'The package version is based on the contents of the specified metadata package. Omit -m if you want to create an unmanaged package version.',
|
358 | package1VersionCreateCommandId: 'ID of the metadata package (starts with 033) of which you’re creating a new version',
|
359 | package1VersionCreateCommandIdLong: 'ID of the metadata package (starts with 033) of which you’re creating a new version.',
|
360 | package1VersionCreateCommandName: 'package version name',
|
361 | package1VersionCreateCommandNameLong: 'Package version name.',
|
362 | package1VersionCreateCommandDescription: 'package version description',
|
363 | package1VersionCreateCommandDescriptionLong: 'Package version description.',
|
364 | package1VersionCreateCommandVersion: 'package version in major.minor format, for example, 3.2',
|
365 | package1VersionCreateCommandVersionLong: 'Package version in major.minor format, for example, 3.2.',
|
366 | package1VersionCreateCommandReleaseNotes: 'release notes URL',
|
367 | package1VersionCreateCommandReleaseNotesLong: 'The release notes URL. This link is displayed in the package installation UI to provide release notes ' +
|
368 | 'for this package version to subscribers.',
|
369 | package1VersionCreateCommandPostInstall: 'post install URL',
|
370 | package1VersionCreateCommandPostInstallLong: 'The post-install instructions URL. The contents of the post-installation instructions URL are displayed ' +
|
371 | 'in the UI after installation of the package version.',
|
372 | package1VersionCreateCommandManagedReleased: 'create a managed package version',
|
373 | package1VersionCreateCommandManagedReleasedLong: 'Creates a managed package version. To create a beta version, don’t include this parameter.',
|
374 | package1VersionCreateCommandInstallationKey: 'installation key for key-protected package (default: null)',
|
375 | package1VersionCreateCommandInstallationKeyLong: 'Installation key for creating the key-protected package. The default is null.',
|
376 | package1VersionCreateCommandWait: 'minutes to wait for the package version to be created (default: 2 minutes)',
|
377 | package1VersionCreateCommandWaitLong: 'Minutes to wait for the package version to be created. The default is 2 minutes.',
|
378 | package1VersionCreateCommandNotANumber: 'Field %s must contain only a numeric value: %s.',
|
379 | package1VersionCreateCommandInvalidVersion: 'Version supplied, %s, is not formatted correctly. Enter in major.minor format, for example, 3.2.',
|
380 | package1VersionCreateCommandTimeout: 'Stopped waiting for package upload to finish. Wait time exceeded. waitTimeInMinutes = %s.',
|
381 | package1VersionCreateCommandUploadFailure: `Package upload failed. ${os.EOL}%s`,
|
382 | package1VersionCreateCommandUploadFailureDefault: 'Package version creation failed with unknown error',
|
383 | package1VersionCreateHumanSuccess: 'Successfully created package version: %s for package %s.',
|
384 | package1VersionListCommandLongDescription: 'Lists the versions for the specified package or all first-generation packages in the org.',
|
385 | package1VersionListCommandCliDescription: 'list package versions for the specified first-generation package or for the org',
|
386 | package1VersionListCommandCliHelp: 'If a metadata package ID is specified, lists all versions of the specified package. ' +
|
387 | 'Otherwise, lists all package versions for the org. For each package version, the list includes the package ' +
|
388 | 'version ID, metadata package ID, name, version number, and release state.',
|
389 | package1VersionListCommandPackageId: 'metadata package ID (starts with 033)',
|
390 | package1VersionListCommandPackageIdLong: 'Metadata package ID (starts with 033) whose package versions you want to list. If not specified, shows all versions for all packages (managed and unmanaged) in the org.',
|
391 | package1VersionListHumanSuccess: 'Successfully created the package version list.',
|
392 | package1VersionListAction: 'Verify that you entered a valid package ID and that you are authorized in the org. Then try again.',
|
393 | package1VersionDisplayCommandLongDescription: 'Displays detailed information about an individual first-generation package version.',
|
394 | package1VersionDisplayCommandCliDescription: 'display details about a first-generation package version',
|
395 | package1VersionDisplayCommandCliHelp: 'Display detailed information about an individual package version, including metadata package ID, name, the release state, and build number.',
|
396 | package1VersionDisplayCommandPackageId: 'metadata package version ID (starts with 04t)',
|
397 | package1VersionDisplayCommandPackageIdLong: 'ID (starts with 04t) of the metadata package version whose details you want to display.',
|
398 | package1VersionDisplayHumanSuccess: 'Successfully displayed the package version.',
|
399 | package1VersionDisplayAction: 'Verify that you entered a valid package version ID and try again.',
|
400 | package2VersionUpdateSetAsReleasedYesNo: "Are you sure you want to release package version %s? You can't undo this action. Release package (y/n)?",
|
401 | packageVersionUpdateSetAsReleasedYesNo: "Are you sure you want to release package version %s? You can't undo this action. Release package (y/n)?",
|
402 | attemptingToDeleteExpiredOrDeleted: 'Attempting to delete an expired or deleted org',
|
403 | insufficientAccessToDelete: 'You do not have the appropriate permissions to delete a scratch org. Please contact your Salesforce admin.',
|
404 | deleteOrgConfigOnlyCommandSuccess: 'Successfully deleted scratch org %s.',
|
405 | deleteOrgCommandSuccess: 'Successfully marked scratch org %s for deletion',
|
406 | deleteOrgCommandQueryError: 'Error querying for DevHubMember %s. We received %s results',
|
407 | deleteOrgCommandPathError: 'The scratch org config for scratch org %s does not exist',
|
408 | deleteOrgHubError: 'The Dev Hub org cannot be deleted.',
|
409 | logoutOrgCommandSuccess: 'Successfully logged out of orgs.',
|
410 | defaultOrgNotFound: 'No %s org found',
|
411 | defaultOrgNotFoundAction: 'Run the "sfdx force:auth" commands with --setdefaultusername to connect to an org and set it ' +
|
412 | 'as your default org.\nRun "force:org:create" with --setdefaultusername to create a scratch org and set it as ' +
|
413 | 'your default org.\nRun "sfdx force:config:set defaultusername=<username>" to set your default username.',
|
414 | defaultOrgNotFoundDevHubAction: 'Run the "sfdx force:auth" commands with --setdefaultdevhubusername to connect to a ' +
|
415 | 'Dev Hub org and set it as your default Dev Hub.\nRun "force:org:list" to see a list of locally registered orgs.' +
|
416 | '\nRun "sfdx force:config:set defaultdevhubusername=<username>" to set your default Dev Hub username.',
|
417 | namedOrgNotFound: 'No org configuration found for name %s',
|
418 | noResultsFound: 'No results found',
|
419 | invalidVersionString: 'Invalid API version string.',
|
420 | fullNameIsRequired: 'The fullName attribute is required.',
|
421 | metadataTypeIsRequired: 'The metadata type attribute is required.',
|
422 | unexpectedSmmToolingFullNameFormat: 'Unexpected format for FullName: %s.',
|
423 | invalidResponseFromQuery: 'Invalid response from query: %s.',
|
424 | docTopicDescription: 'display help for force commands',
|
425 | docTopicLongDescription: 'Use the doc commands to display descriptions and help for commands in the force namespace.',
|
426 | docCommandsDisplayDescription: 'display help for force commands',
|
427 | docCommandsDisplayDescriptionLong: 'Displays help for commands in the force namespace.',
|
428 | docCommandsDisplayHelp: 'Displays --help output for commands in the force namespace.' +
|
429 | '\nTo display more details about the commands’ parameters, include the --json flag.',
|
430 | docCommandsListDescription: 'list the force commands',
|
431 | docCommandsListDescriptionLong: 'Lists the commands in the force namespace.',
|
432 | docCommandsListUsageDescription: 'list only docopt usage strings',
|
433 | docCommandsListUsageDescriptionLong: 'Lists docopt usage strings instead of command names and descriptions.',
|
434 | docCommandsListHelp: 'Displays a list of commands in the force namespace and their descriptions.',
|
435 | keyChainServiceCommandFailed: 'Command failed with response.\n%s',
|
436 | keyChainServiceRequired: 'Can’t get or set a keychain value without a service name.',
|
437 | keyChainAccountRequired: 'Can’t get or set a keychain value without an account name.',
|
438 | keyChainPasswordNotFound: 'Could not find password.',
|
439 | keyChainUserCanceled: 'User canceled authentication',
|
440 | keyChainCredentialParseError: 'A parse error occurred while setting a credential.',
|
441 | keychainGetCommandFailedAction: 'Determine why this command failed to get an encryption key for user %s: [%s].',
|
442 | keychainSetCommandFailedAction: 'Determine why this command failed to set an encryption key for user %s: [%s].',
|
443 | keychainPasswordNotFoundAction: 'Ensure a valid password is returned with the following command: [%s].',
|
444 | retrieveKeyChainItemFailedAction: 'Ensure that user %s has a login keychain item named %s. If not re-run authorization.',
|
445 | genericUnixKeychainInvalidPerms: 'Invalid file permissions for secret file',
|
446 | genericUnixKeychainInvalidPermsAction: 'Ensure the file %s has the file permission octal value of %s.',
|
447 | genericUnixKeychainServiceAccountMismatch: 'The service and account specified in %s do not match the version of the toolbelt.',
|
448 | genericUnixKeychainServiceAccountMismatchAction: 'Check your toolbelt version and re-auth.',
|
449 | dataExportInvalidSoql: 'Invalid SOQL query: %s',
|
450 | dataExportSoqlFailed: 'Error invoking SOQL query: %s',
|
451 | dataExportFailed: 'Export failed for soql query: %s. Error: %s.',
|
452 | dataExportQueryMalformed: 'The provided SOQL is malformed: %s',
|
453 | dataExportQueryMalformedAction: 'Check the SOQL syntax and try again.',
|
454 | dataExportRecordCount: 'Processed %s records from query: %s',
|
455 | dataExportRecordCountWarning: 'Query returned more than 200 records. Please run the command using the plan option instead.\n Record Count: %s \nQuery: %s',
|
456 | dataExportSoqlNotProvided: 'Provide a SOQL query statement or file containing a SOQL statement.',
|
457 | dataImportFileNotProvided: 'Provide a data plan or file(s).',
|
458 | dataImportFileNotFound: 'Cannot find data file. Indicate a valid path: %s.',
|
459 | dataImportFileUnknownContentType: 'Unable to determine content type for file: %s.',
|
460 | dataImportFileUnsupported: 'Content type: %s not supported.',
|
461 | dataImportTooManyFiles: 'Specify either sobjecttreefiles or a plan, but not both.',
|
462 | dataImportFileEmpty: 'Data file is empty: %s.',
|
463 | dataImportFileInvalidJson: 'data file is invalid JSON: %s',
|
464 | dataImportFileNoRefId: 'Found references in file, but no reference-id content found (%s). Was parent SObjects saved first?',
|
465 | dataImportFailed: 'Import failed from file: %s. Results: %s.',
|
466 | sourceConflictDetected: 'Source conflict(s) detected.',
|
467 | oauthInvalidGrant: 'This org appears to have a problem with its OAuth configuration. Reason: %s \nusername: %s, \nclientId: %s, \nloginUrl: %s, \nprivateKey: %s',
|
468 | oauthInvalidGrantAction: 'Verify the OAuth configuration for this org. For JWT:' +
|
469 | `${os.EOL}Ensure the private key is correct and the cert associated with the connected app has not expired.` +
|
470 | `${os.EOL}Ensure the following OAuth scopes are configured [api, refresh_token, offline_access].` +
|
471 | `${os.EOL}Ensure the username is assigned to a profile or perm set associated with the connected app.` +
|
472 | `${os.EOL}Ensure the connected app is configured to pre-authorize admins.`,
|
473 | notSpecified: '<Not Specified>',
|
474 | warnApiVersion: 'apiVersion configuration overridden at %s',
|
475 | metadataTypeNotSupported: 'No source tracking support for type: %s. For details, visit ' +
|
476 | 'https://developer.salesforce.com/docs/metadata-coverage and select your API version. Skipping...'
|
477 | }
|
478 | },
|
479 | IndexErrorProcessor: {
|
480 | en_US: {
|
481 | apiMisMatch: 'The configured apiVersion %s is not supported for this org. The max apiVersion is %s',
|
482 | apiMisMatchAction: 'Run "sfdx force" to see if the locally configured apiVersion is same or less than the org’s supported max apiVersion.' +
|
483 | `${os.EOL}Run "sfdx force:config:list" to determine if apiVersion is overridden.` +
|
484 | `${os.EOL}Install the latest version of the salesforcedx plug-in by running sfdx plugins:install salesforcedx@latest.`,
|
485 | server500: 'The salesforce.com servers are temporarily unable to respond to your request. We apologize for the inconvenience.' +
|
486 | `${os.EOL}Thank you for your patience, and please try again in a few moments.`,
|
487 | server500Action: 'Visit http://trust.salesforce.com for current system status and availability.'
|
488 | }
|
489 | },
|
490 | apex: {
|
491 | en_US: {
|
492 | apexTestApiReportHint: 'Run "sfdx force:apex:test:report %s" to retrieve test results.',
|
493 | apexTestApiReportForFormatHint: 'Run "sfdx force:apex:test:report %s --resultformat <format>" to retrieve test results in a different format.',
|
494 | apexTestApiReportHintWithTimeoutAction: 'Run "sfdx force:apex:test:report -i %s" to retrieve the test results. Or increase the streaming timeout by specifying the wait parameter.',
|
495 | description: 'work with Apex code',
|
496 | longDescription: 'Use the apex commands to create Apex classes, execute anonymous blocks, view your logs, run Apex tests, and view Apex test results.',
|
497 | apexCommandParamCodeCoverage: 'retrieve code coverage results',
|
498 | apexCommandParamCodeCoverageLong: 'Retrieves code coverage results.',
|
499 | apexCommandParamTestArtifactDir: 'directory to store test run files',
|
500 | apexCommandParamTestArtifactDirLong: 'Directory to store test run files.',
|
501 | apexTestCommandDescription: 'invoke Apex tests',
|
502 | apexTestCommandDescriptionLong: 'Runs Apex tests.',
|
503 | apexTestCommandHelp: 'By default, runs all Apex tests in the org’s namespace.' +
|
504 | '\n\nTo run specific test classes, specify class names or suite names, or set a --testlevel value.' +
|
505 | '\n\nTo run specific test methods, use --tests.' +
|
506 | '\n\nExamples:' +
|
507 | '\n $ sfdx force:apex:test:run' +
|
508 | '\n $ sfdx force:apex:test:run -n MyClassTest,MyOtherClassTest -r human' +
|
509 | '\n $ sfdx force:apex:test:run -s MySuite,MyOtherSuite -c --json' +
|
510 | '\n $ sfdx force:apex:test:run -t MyClassTest.testCoolFeature,MyClassTest.testAwesomeFeature,AnotherClassTest,namespace.TheirClassTest.testThis -r human' +
|
511 | '\n $ sfdx force:apex:test:run -l RunLocalTests -d <path to outputdir> -u me@my.org',
|
512 | apexTestCommandParamTestNames: 'comma-separated list of Apex test class names to run',
|
513 | apexTestCommandParamTestNamesLong: 'Comma-separated list of Apex test class names to run. You can specify only one of ' +
|
514 | 'classnames, suitenames, or tests.',
|
515 | apexTestCommandParamTestSuites: 'comma-separated list of Apex test suite names to run',
|
516 | apexTestCommandParamTestSuitesLong: 'Comma-separated list of Apex test suite names to run. You can only specify one of ' +
|
517 | 'classnames, suitenames, or tests.',
|
518 | apexTestCommandParamTests: 'comma-separated list of Apex test class names or IDs and, if applicable, test methods to run',
|
519 | apexTestCommandParamTestsLong: 'Comma-separated list of Apex test class names or IDs and test methods, if applicable, ' +
|
520 | 'to run. You can only specify one of classnames, suitenames, or tests.',
|
521 | apexTestCommandParamTestLevel: 'testlevel enum value',
|
522 | apexTestCommandParamTestLevelLong: 'Specifies which tests to run, using one of these TestLevel enum values:' +
|
523 | '\nRunSpecifiedTests—Only the tests that you specify are run.' +
|
524 | '\nRunLocalTests—All tests in your org are run, except the ones that originate from installed managed packages.' +
|
525 | '\nRunAllTestsInOrg—All tests are in your org and in installed managed packages are run.',
|
526 | apexTestCommandParamReporter: 'test result format emitted to stdout; --json flag overrides this parameter',
|
527 | apexTestCommandParamReporterLong: 'Format to use when displaying test results. If you also specify the --json flag, --json overrides this parameter.',
|
528 | apexTestCommandParamSynchronous: 'run tests from a single class synchronously',
|
529 | apexTestCommandParamSynchronousLong: "Runs test methods from a single Apex class synchronously. If you don't specify this flag, tests are run asynchronously.",
|
530 | apexTestCommandResultFormatDeprecation: 'In salesforcedx v41 and earlier, the --resultformat parameter caused the ' +
|
531 | 'apex:test:run command to wait for test results rather than finishing immediately and returning a test run ID. In salesforcedx v42 and later, the --resultformat parameter will no longer cause the command to wait. To wait for test results, include the --wait parameter.',
|
532 | apexTestCommandInvalidTestlevel: 'To use the testlevel value RunSpecifiedTests, specify either classnames or suitenames.',
|
533 | apexTestCommandInvalidSynchronousParams: 'Synchronous test runs can include test methods from only one Apex class. Omit the --synchronous flag or include tests from only one class.',
|
534 | apexTestSynchronousRunFailed: 'Unable to run tests synchronously: [%s]',
|
535 | apexReportCommandDescription: 'display test results',
|
536 | apexReportCommandDescriptionLong: 'Displays the test results for a specific test run.',
|
537 | apexReportCommandHelp: 'Displays test results for an enqueued or completed asynchronous Apex test run.' +
|
538 | '\n\nExamples:' +
|
539 | '\n $ sfdx force:apex:test:report -i <test run id>' +
|
540 | '\n $ sfdx force:apex:test:report -i <test run id> -r junit' +
|
541 | '\n $ sfdx force:apex:test:report -i <test run id> -c --json',
|
542 | apexReportCommandParamTestRunId: 'ID of test run',
|
543 | apexReportCommandParamTestRunIdLong: 'The ID of test run.',
|
544 | apexReportCommandParamReporter: 'test result format emitted to stdout; --json flag overrides this parameter',
|
545 | apexReportCommandParamReporterLong: 'Format to use when displaying test results. If you also specify the --json flag, --json overrides this parameter.',
|
546 | invalidValueForSocketTimeoutHandler: 'provide a valid function for the socket timeout handler.',
|
547 | verboseDescription: 'display Apex test processing details',
|
548 | verboseLongDescription: 'Displays Apex test processing details. If JSON format is specified, processing details aren’t displayed.'
|
549 | }
|
550 | },
|
551 | apexPreCompile: {
|
552 | en_US: {
|
553 | missingOrg: 'Invalid or missing org.',
|
554 | precompileTimedOut: 'The precompile operation timed out.',
|
555 | precompileTimedOutAction: 'Increase the timeout attribute and try again.',
|
556 | precompileQueryError: 'An error occurred querying the state of the Apex cache - %s',
|
557 | precompileWarmerError: 'An error occurred running Apex pre-compilation - %s',
|
558 | invalidTimeout: 'Timeout value must be greater than zero.',
|
559 | invalidPollInterval: 'Poll interval must be greater than zero.'
|
560 | }
|
561 | },
|
562 | apexPreCompileCommand: {
|
563 | en_US: {
|
564 | invalidTimeout: 'Invalid timeout value. Value must be greater than %s minutes.',
|
565 | precompileDescription: 'how long to wait (in minutes) for Apex pre-compilation',
|
566 | precompileLongDescription: 'Specifies how long to wait (in minutes) for Apex pre-compilation to complete before running the tests or timing out.'
|
567 | }
|
568 | },
|
569 | demoMode: {
|
570 | en_US: {
|
571 | warnAuth: 'Logging in to a business or production org is not recommended on a demo or shared machine. ' +
|
572 | 'Please run "sfdx force:auth:logout --targetusername <your username> --noprompt"' +
|
573 | ` when finished using this org, which is similar to logging out of the org in the browser.${os.EOL}` +
|
574 | `${os.EOL}Do you want to authorize this org, %s, for use with the Salesforce CLI? `,
|
575 | warnAuthWebLogin: 'A response of "n" lets you keep using the org in the browser, but doesn\'t save authorization ' +
|
576 | 'details on this computer. ',
|
577 | warnAuthQuestion: `${os.EOL}Authorize org (y/n)?`,
|
578 | noPrompt: 'do not prompt for auth confirmation in demo mode',
|
579 | noPromptLong: 'Do not prompt for auth confirmation in demo mode.',
|
580 | demoModeCloseBrowser: "Your auth information wasn't stored by the Salesforce CLI. Please log out of your browser session" +
|
581 | " when you're finished using this org."
|
582 | }
|
583 | },
|
584 | auth: {
|
585 | en_US: {
|
586 | description: 'authorize an org for use with the Salesforce CLI',
|
587 | longDescription: 'Use the auth commands to authorize a Salesforce org for use with the Salesforce CLI.',
|
588 | clientId: 'OAuth client ID (sometimes called the consumer key)',
|
589 | clientIdLong: 'The OAuth client ID (sometimes referred to as the consumer key).',
|
590 | setDefaultDevHub: 'set the authenticated org as the default dev hub org for scratch org creation',
|
591 | setDefaultDevHubLong: 'Sets the authenticated org as the default Dev Hub org for scratch org creation.',
|
592 | setDefaultUsername: 'set the authenticated org as the default username that all commands run against',
|
593 | setDefaultUsernameLong: 'Sets the authenticated org as the default username that all commands run against.',
|
594 | setAlias: 'set an alias for the authenticated org',
|
595 | setAliasLong: 'Sets an alias for the authenticated org.',
|
596 | instanceUrl: 'the login URL of the instance the org lives on',
|
597 | instanceUrlLong: 'The login URL of the Salesforce instance that the org lives on.',
|
598 | deviceWarning: 'force:auth:web:login doesn\'t work when authorizing to a headless environment. Use force:auth:device:login instead.'
|
599 | }
|
600 | },
|
601 | auth_weblogin: {
|
602 | en_US: {
|
603 | help: 'To log in to a sandbox, set --instanceurl to https://test.salesforce.com.' +
|
604 | '\n\nExamples:' +
|
605 | '\n $ sfdx force:auth:web:login -a TestOrg1' +
|
606 | '\n $ sfdx force:auth:web:login -i <OAuth client id>' +
|
607 | '\n $ sfdx force:auth:web:login -r https://test.salesforce.com',
|
608 | description: 'authorize an org using the web login flow',
|
609 | longDescription: 'Authorizes a Salesforce org by opening a browser so you can log in through salesforce.com.',
|
610 | stdin: 'OAuth client secret of personal connected app?',
|
611 | disableMasking: 'disable masking of user input (for use with problematic terminals)',
|
612 | disableMaskingLong: 'Disables masking of user input (for use with problematic terminals).'
|
613 | }
|
614 | },
|
615 | auth_logout: {
|
616 | en_US: {
|
617 | help: 'By default, this command logs you out from your default scratch org.' +
|
618 | `${os.EOL}Examples:` +
|
619 | `${os.EOL} $ sfdx force:auth:logout -u me@my.org` +
|
620 | `${os.EOL} $ sfdx force:auth:logout -a` +
|
621 | `${os.EOL} $ sfdx force:auth:logout -p`,
|
622 | description: 'log out from authorized orgs',
|
623 | longDescription: 'Logs you out from one or all of your authorized Salesforce orgs.',
|
624 | noPrompt: 'do not prompt for confirmation',
|
625 | noPromptLong: 'Do not prompt for confirmation.',
|
626 | all: 'include all authenticated orgs',
|
627 | allLong: 'Includes all authenticated orgs: for example, Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.',
|
628 | logoutCommandYesNo: `Are you sure you want to log out from these org(s)?%s${os.EOL}${os.EOL}` +
|
629 | 'Important: You need a password to reauthorize scratch orgs. By default, scratch orgs have no password. If you still need your scratch orgs, run ' +
|
630 | '"sfdx force:user:password:generate" before logging out. If you don\'t need the scratch orgs anymore, run "sfdx force:org:delete" instead of logging out.' +
|
631 | `${os.EOL}${os.EOL}Log out (y/n)?`,
|
632 | specifiedBothUserAndAllError: 'Specify either --targetusername or --all.'
|
633 | }
|
634 | },
|
635 | auth_jwt: {
|
636 | en_US: {
|
637 | help: 'Authorizes a Salesforce org using a private key file that has been uploaded to a personal connected app.' +
|
638 | '\n\nIf you specify an --instanceurl value, this value overrides the sfdcLoginUrl value ' +
|
639 | 'in your sfdx-project.json file. To specify a My Domain URL, use the format ' +
|
640 | '<yourdomain>.my.salesforce.com (not <yourdomain>.lightning.force.com).' +
|
641 | '\n\nExamples:' +
|
642 | '\n $ sfdx force:auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id>' +
|
643 | '\n $ sfdx force:auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id> -s -a MyDefaultOrg' +
|
644 | '\n $ sfdx force:auth:jwt:grant -u me@acme.org -f <path to jwt key file> -i <OAuth client id> -r https://acme.my.salesforce.com',
|
645 | description: 'authorize an org using the JWT flow',
|
646 | longDescription: 'Authorizes a Salesforce org using the JWT flow.',
|
647 | username: 'authentication username',
|
648 | usernameLong: 'The authentication username.',
|
649 | key: 'path to a file containing the private key',
|
650 | keyLong: 'Path to a file containing the private key.'
|
651 | }
|
652 | },
|
653 | auth_sfdxurl: {
|
654 | en_US: {
|
655 | description: 'authorize an org using an SFDX auth URL',
|
656 | longDescription: 'Authorizes a Salesforce org using an SFDX auth URL.',
|
657 | help: 'Authorize a Salesforce org using an SFDX auth URL stored within a file.' +
|
658 | '\nThe file must have the format "%s" or "%s".' +
|
659 | '\nThe file must contain only the URL or be a JSON file that has a top-level property named sfdxAuthUrl.' +
|
660 | '\n\nExamples:' +
|
661 | '\n $ sfdx force:auth:sfdxurl:store -f <path to sfdxAuthUrl file>' +
|
662 | '\n $ sfdx force:auth:sfdxurl:store -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg',
|
663 | file: 'path to a file containing the sfdx url',
|
664 | fileLong: 'Path to a file containing the SFDX URL.',
|
665 | InvalidSfdxAuthUrl: 'Invalid or missing SFDX auth URL.' +
|
666 | '\nEnsure the file exists, and that it either a) contains only the URL, or ' +
|
667 | 'b) is a JSON file with a top-level property named sfdxAuthUrl.' +
|
668 | '\nEnsure the URL is in the correct format "%s" or "%s".'
|
669 | }
|
670 | },
|
671 | varargs_command: {
|
672 | en_US: {
|
673 | ArgsRequired: 'Please provide required name=value pairs for the command, quoting any values containing spaces.',
|
674 | InvalidArgsFormat: 'Setting variables must be in the format <key>=<value> or <key>="<value with spaces>" but found %s.',
|
675 | DuplicateArgs: "Cannot set variable name '%s' twice for the same command."
|
676 | }
|
677 | },
|
678 | alias: {
|
679 | en_US: {
|
680 | description: 'manage username aliases',
|
681 | longDescription: 'Use the alias commands to manage username aliases.',
|
682 | NoAliasesFound: 'Nothing to set',
|
683 | InvalidFormat: 'Setting aliases must be in the format <key>=<value> but found: [%s]'
|
684 | }
|
685 | },
|
686 | aliasSetCommand: {
|
687 | en_US: {
|
688 | help: 'You can associate an alias with only one username at a time. If you’ve set an alias multiple times, ' +
|
689 | 'the alias points to the most recent username.' +
|
690 | '\n\nTo delete an alias, run "sfdx force:alias:set" with no username.' +
|
691 | '\n\nExamples:' +
|
692 | '\n $ sfdx force:alias:set YourAlias=username@example.com' +
|
693 | '\n $ sfdx force:alias:set YourAlias=username@example.com YourOtherAlias=devhub@example.com' +
|
694 | '\n $ sfdx force:alias:set AliasToDelete=',
|
695 | description: 'set username aliases for the Salesforce CLI',
|
696 | longDescription: 'Sets an alias that the Salesforce CLI can use for various commands and tasks.'
|
697 | }
|
698 | },
|
699 | aliasListCommand: {
|
700 | en_US: {
|
701 | help: 'Example: \n $ sfdx force:alias:list',
|
702 | description: 'list username aliases for the Salesforce CLI',
|
703 | longDescription: 'Lists the aliases that the Salesforce CLI can use for various commands and tasks.'
|
704 | }
|
705 | },
|
706 | config: {
|
707 | en_US: {
|
708 | description: 'configure the Salesforce CLI',
|
709 | longDescription: 'Use the config commands to view and set your Salesforce CLI configuration values. ' +
|
710 | 'Set your default Dev Hub and scratch org, and your default instance URL, either globally or at the project level.'
|
711 | }
|
712 | },
|
713 | sfdxConfig: {
|
714 | en_US: {
|
715 | invalidConfigValue: 'Invalid config value. %s',
|
716 | invalidApiVersion: 'Specify a valid Salesforce API version, for example, 42.0.',
|
717 | invalidInstanceUrl: 'Specify a valid Salesforce instance URL.',
|
718 | UnknownConfigKey: 'Unknown config key: %s'
|
719 | }
|
720 | },
|
721 | configSetCommand: {
|
722 | en_US: {
|
723 | help: 'Sets the configuration variables that the Salesforce CLI uses for various commands and tasks. ' +
|
724 | 'Local variables apply only to your current project. Global variables apply in any directory.' +
|
725 | '\n\nExamples:' +
|
726 | '\n $ sfdx force:config:set defaultusername=me@my.org defaultdevhubusername=me@myhub.org' +
|
727 | '\n $ sfdx force:config:set defaultdevhubusername=me@myhub.org -g',
|
728 | description: 'set config vars for the Salesforce CLI',
|
729 | descriptionLong: 'Sets the local and global configuration variables for the Salesforce CLI.',
|
730 | global: 'set config var globally (to be used from any directory)',
|
731 | globalLong: 'Sets the configuration variables globally, so they can be used from any directory.',
|
732 | globalHelp: 'Add the --global flag to set config outside of a project.',
|
733 | InvalidOrgValue: 'Unknown org value. Valid values are %s',
|
734 | NoConfigKeysFound: 'Please provide config name(s) and value(s) to set.',
|
735 | InvalidConfigFormat: 'Setting config vars must be in the format <key>=<value> but found %s',
|
736 | DuplicateConfigKey: 'Trying to set config name "%s" twice in the same command'
|
737 | }
|
738 | },
|
739 | configGetCommand: {
|
740 | en_US: {
|
741 | help: 'To see your default scratch org username, include "defaultusername".' +
|
742 | '\nTo see your default Dev Hub, include "defaultdevhubusername".' +
|
743 | '\nTo see your default instance URL, include "instanceUrl".' +
|
744 | '\nTo see the locations where your values are set, include the --verbose flag.' +
|
745 | '\n\nExamples:' +
|
746 | '\n $ sfdx force:config:get defaultusername' +
|
747 | '\n $ sfdx force:config:get defaultusername defaultdevhubusername instanceUrl' +
|
748 | '\n $ sfdx force:config:get defaultusername defaultdevhubusername --verbose',
|
749 | description: 'get config var values for given names',
|
750 | descriptionLong: 'Gets the Salesforce CLI configuration values for your default scratch org, ' +
|
751 | 'your default Dev Hub org, your default instance URL, or any combination of the three.',
|
752 | sfdxProjectValidationFailure: 'sfdx-project.json file did not validate against the schema.',
|
753 | NoConfigKeysFound: 'Please provide config name(s) to get.'
|
754 | }
|
755 | },
|
756 | configListCommand: {
|
757 | en_US: {
|
758 | help: 'Lists the config variables that the Salesforce CLI uses for various commands and tasks.',
|
759 | description: 'list config vars for the Salesforce CLI',
|
760 | descriptionLong: 'Lists the configuration variables for the Salesforce CLI.',
|
761 | key: 'Name',
|
762 | value: 'Value',
|
763 | location: 'Location'
|
764 | }
|
765 | },
|
766 | data: {
|
767 | en_US: {
|
768 | description: 'manipulate records in your org',
|
769 | longDescription: 'Use the data commands to manipulate records in your org. Commands are available to help you work with ' +
|
770 | 'various APIs. Import CSV files with the Bulk API. Export and import data that includes master-detail relationships with ' +
|
771 | 'the SObject Tree Save API. Perform simple CRUD operations on individual records with the REST API.',
|
772 | dataImportCommandCliDescription: 'import data into an org using SObject Tree Save API',
|
773 | dataImportCommandCliDescriptionLong: 'Imports data into an org using the SObject Tree Save API. This data can include ' +
|
774 | 'master-detail relationships.',
|
775 | dataImportCommandCliHelp: 'To generate JSON files for use with force:data:tree:import, run "sfdx force:data:tree:export".' +
|
776 | '\n\nExamples:\nTo import records as individual files, first run the export commands:' +
|
777 | '\n $ sfdx force:data:tree:export -q "SELECT Id, Name FROM Account"' +
|
778 | '\n $ sfdx force:data:tree:export -q "SELECT Id, LastName, FirstName FROM Contact"' +
|
779 | '\nThen run the import command:' +
|
780 | '\n $ sfdx force:data:tree:import -f Contact.json,Account.json -u me@my.org' +
|
781 | '\n\nTo import multiple data files as part of a plan, first run the export command with the -p | --plan flag:' +
|
782 | '\n $ sfdx force:data:tree:export -p -q "SELECT Id, Name, (SELECT Id, LastName, FirstName FROM Contacts) FROM Account"' +
|
783 | '\nThen run the import command, supplying a filepath value for the -p | --plan parameter:' +
|
784 | '\n $ sfdx force:data:tree:import -p Account-Contact-plan.json -u me@my.org' +
|
785 | '\n\nThe SObject Tree API supports requests that contain up to 200 records. For more information, see the REST API ' +
|
786 | 'Developer Guide: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm',
|
787 | dataImportCommandCliFiles: 'comma-delimited, ordered paths of json files containing collection of record trees to insert',
|
788 | dataImportCommandCliFilesLong: 'Comma-delimited, ordered paths of JSON files containing a collection of record trees to insert. ' +
|
789 | 'Either --sobjecttreefiles or --plan is required.',
|
790 | dataImportCommandCliContentType: 'if data file extension is not .json, provide content type (applies to all files)',
|
791 | dataImportCommandCliContentTypeLong: 'If the data file extension is not .json, provide the content type (applies to all files).',
|
792 | dataImportCommandCliPlan: 'path to plan to insert multiple data files that have master-detail relationships',
|
793 | dataImportCommandCliPlanLong: 'Path to plan to insert multiple data files that have master-detail relationships. ' +
|
794 | 'Either --sobjecttreefiles or --plan is required.',
|
795 | dataImportCommandValidationFailure: 'Data plan file %s did not validate against the schema.' +
|
796 | '\nDid you run the force:data:tree:export command with the --plan flag?' +
|
797 | '\nMake sure you are importing a plan file.' +
|
798 | '\nYou can get help with the import plan schema by running $ sfdx force:data:tree:import --confighelp' +
|
799 | '\n\n%s',
|
800 | dataExportCommandCliDescription: 'export data from an org into sObject tree format for force:data:tree:import consumption',
|
801 | dataExportCommandCliDescriptionLong: 'Exports data from an org into sObject tree format for force:data:tree:import consumption.',
|
802 | dataExportCommandCliHelp: 'Generates JSON files for use with the force:data:tree:import command.' +
|
803 | '\n\nExamples:' +
|
804 | '\n $ sfdx force:data:tree:export -q "SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c"' +
|
805 | '\n $ sfdx force:data:tree:export -q <path to file containing soql query> -x export-demo -d /tmp/sfdx-out -p' +
|
806 | '\n\nFor more information and examples, run "sfdx force:data:tree:import -h".' +
|
807 | '\n\nThe query for export can return a maximum of 2,000 records. For more information, see the REST API ' +
|
808 | 'Developer Guide: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm',
|
809 | dataExportCommandCliSoql: 'soql query, or filepath of file containing a soql query, to retrieve records',
|
810 | dataExportCommandCliSoqlLong: 'A SOQL query statement or the path of a file containing a SOQL query statement ' +
|
811 | 'to retrieve the records to export.',
|
812 | dataExportCommandCliPrefix: 'prefix of generated files',
|
813 | dataExportCommandCliPrefixLong: 'Prefix of generated files.',
|
814 | dataExportCommandCliDir: 'directory to store files',
|
815 | dataExportCommandCliDirLong: 'Directory to store generated files.',
|
816 | dataExportCommandCliPlan: 'generate mulitple sobject tree files and a plan definition file for aggregated import',
|
817 | dataExportCommandCliPlanLong: 'Generates multiple sObject tree files and a plan definition file for aggregated import.'
|
818 | }
|
819 | },
|
820 | versionCommand: {
|
821 | en_US: {
|
822 | versionDescription: 'display the Salesforce API version',
|
823 | MissingVersionAttribute: 'Missing version attribute from package.json',
|
824 | UnexpectedVersionFormat: 'The version specified in package.json is unexpected: %s'
|
825 | }
|
826 | },
|
827 | mdapiConvertCommand: {
|
828 | en_US: {
|
829 | description: 'convert metadata from the Metadata API format into the source format',
|
830 | longDescription: 'Converts metadata retrieved via Metadata API into the source format used in Salesforce DX projects.',
|
831 | help: 'To use Salesforce CLI to work with components that you retrieved via Metadata API, ' +
|
832 | 'first convert your files from the metadata format to the source format using "sfdx force:mdapi:convert".' +
|
833 | '\n\nTo convert files from the source format back to the metadata format, so that you can deploy them ' +
|
834 | 'using "sfdx force:mdapi:deploy", run "sfdx force:source:convert".' +
|
835 | '\n\nExamples:' +
|
836 | '\n $ sfdx force:mdapi:convert -r path/to/metadata' +
|
837 | '\n $ sfdx force:mdapi:convert -r path/to/metadata -d path/to/outputdir',
|
838 | rootParam: 'the root directory containing the Metadata API–formatted metadata',
|
839 | rootParamLongDescription: 'The root directory that contains the metadata you retrieved using Metadata API.',
|
840 | outputDirectoryParam: 'the output directory to store the source–formatted files',
|
841 | outputDirectoryParamLongDescription: 'The directory to store your files in after they’re converted to the ' +
|
842 | 'source format. Can be an absolute or relative path.',
|
843 | tableName: 'Converted Source',
|
844 | tableNameDups: 'Duplicates',
|
845 | dupsExplanation: 'Review any duplicate files (.dup) in the destination directory. You may need to merge the files. Otherwise, delete the unneeded one. Duplicate files are ignored by the force:source commands.',
|
846 | manifestLongDescription: 'The complete path to the manifest (package.xml) file that specifies the metadata types to convert.' +
|
847 | '\nIf you specify this parameter, don’t specify --metadata or --sourcepath.',
|
848 | manifestDescription: 'file path to manifest (package.xml) of metadata types to convert.',
|
849 | sourcePathDescription: 'comma-separated list of paths to the local source files to convert',
|
850 | sourcePathLongDescription: 'A comma-separated list of paths to the local source files to convert. ' +
|
851 | 'The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder ' +
|
852 | '(in which case the operation is applied to all metadata types in the directory and its sub-directories).' +
|
853 | '\nIf you specify this parameter, don’t specify --manifest or --metadata.' +
|
854 | 'If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.',
|
855 | metadataParamDescription: 'comma-separated list of metadata component names to convert',
|
856 | metadataParamLongDescription: 'A comma-separated list of metadata component names to convert.'
|
857 | }
|
858 | },
|
859 | mdapiConvertApi: {
|
860 | en_US: {
|
861 | invalidPath: 'the path specified is not a directory or doesn’t contain a package.xml',
|
862 | errorProcessingPath: 'An error was encountered processing path: %s'
|
863 | }
|
864 | },
|
865 | scratchOrgApi: {
|
866 | en_US: {
|
867 | noOrgsFound: 'No orgs can be found.',
|
868 | noOrgsFoundAction: 'Use one of the commands in force:auth or force:org:create to add or create new scratch orgs.'
|
869 | }
|
870 | },
|
871 | org_shape_list: {
|
872 | en_US: {
|
873 | description: 'list all org shapes you’ve created',
|
874 | longDescription: 'Lists all org shapes that you’ve created using the Salesforce CLI.',
|
875 | verbose: 'list more information about each org shape',
|
876 | verboseLong: 'Lists more information about each org shape.',
|
877 | noOrgShapes: 'No org shapes found.',
|
878 | help: 'Examples:' +
|
879 | '\n $ sfdx force:org:shape:list' +
|
880 | '\n $ sfdx force:org:shape:list --json' +
|
881 | '\n $ sfdx force:org:shape:list --json > tmp/MyOrgShapeList.json'
|
882 | }
|
883 | },
|
884 | org_shape_delete: {
|
885 | en_US: {
|
886 | description: 'delete all org shapes for a target org',
|
887 | longDescription: 'Deletes all org shapes that you’ve created for an org using the Salesforce CLI.',
|
888 | verbose: 'list more information about each org shape',
|
889 | verboseLong: 'Lists more information about each org shape.',
|
890 | usernameOption: 'username for the target org',
|
891 | usernameOptionLong: 'Username for the target org.',
|
892 | targetUsernameOption: 'username for the target org',
|
893 | targetUsernameOptionLong: 'Username for the target org.',
|
894 | noPrompt: 'do not prompt for confirmation',
|
895 | noPromptLong: 'Do not prompt for confirmation.',
|
896 | noAccess: 'The org with name: %s needs to be enabled for org shape before shapes can be deleted.',
|
897 | deleteCommandYesNo: 'Delete shapes for org with name: %s? Are you sure (y/n)?',
|
898 | humanSuccess: 'Successfully deleted shape(s) from org: %s.',
|
899 | noShapesHumanSuccess: 'No org shapes found for org: %s.',
|
900 | help: 'Examples:' +
|
901 | '\n $ sfdx force:org:shape:delete -u me@my.org' +
|
902 | '\n $ sfdx force:org:shape:delete -u MyOrgAlias -p' +
|
903 | '\n $ sfdx force:org:shape:delete -u me@my.org --json' +
|
904 | '\n $ sfdx force:org:shape:delete -u me@my.org -p --json > tmp/MyOrgShapeDelete.json'
|
905 | }
|
906 | },
|
907 | org_list: {
|
908 | en_US: {
|
909 | description: 'list all orgs you’ve created or authenticated to',
|
910 | longDescription: 'Lists all orgs that the Salesforce CLI has created or authenticated to.',
|
911 | verbose: 'list more information about each org',
|
912 | verboseLong: 'Lists more information about each org.',
|
913 | all: 'include expired, deleted, and unknown-status scratch orgs',
|
914 | allLong: 'Lists all authenticated orgs, including expired, deleted, and unknown-status scratch orgs.',
|
915 | clean: 'remove all local org authorizations for non-active orgs',
|
916 | cleanLong: 'Remove all local org authorizations for deleted or expired orgs.',
|
917 | prompt: 'Found (%s) org configurations to delete. Are you sure (yes/no)?',
|
918 | noPrompt: 'do not prompt for confirmation',
|
919 | noPromptLong: 'Do not prompt for confirmation.',
|
920 | noActiveScratchOrgs: 'No active scratch orgs found. Specify --all to see all scratch orgs',
|
921 | help: 'Examples:' +
|
922 | '\n $ sfdx force:org:list' +
|
923 | '\n $ sfdx force:org:list --verbose --json' +
|
924 | '\n $ sfdx force:org:list --verbose --json > tmp/MyOrgList.json'
|
925 | }
|
926 | },
|
927 | package_install_get: {
|
928 | en_US: {
|
929 | cliDescription: 'retrieve the status of a package installation request',
|
930 | cliDescriptionLong: 'Retrieves the status of a package installation request.',
|
931 | help: 'Examples:' +
|
932 | '\n $ sfdx force:package:install:get -i 0Hf...' +
|
933 | '\n $ sfdx force:package:install:get -i 0Hf... -u me@example.com',
|
934 | requestId: 'ID of the package install request you want to check',
|
935 | requestIdLong: 'The ID of the package install request you want to check.',
|
936 | IN_PROGRESS: 'PackageInstallRequest is currently InProgress. You can continue to query the status using' +
|
937 | '\nsfdx force:package:install:get -i %s -u %s',
|
938 | UNKNOWN: this.InProgress,
|
939 | SUCCESS: 'Successfully installed package [%s]'
|
940 | }
|
941 | },
|
942 | package_uninstall_get: {
|
943 | en_US: {
|
944 | cliDescription: 'retrieve the status of a package uninstall request',
|
945 | cliDescriptionLong: 'Retrieves the status of a package uninstall request.',
|
946 | help: 'Examples:' +
|
947 | '\n $ sfdx force:package:uninstall:get -i 06y...' +
|
948 | '\n $ sfdx force:package:uninstall:get -i 06y... -u me@example.com',
|
949 | requestId: 'ID of the package uninstall request you want to check',
|
950 | requestIdLong: 'The ID of the package uninstall request you want to check.',
|
951 | InProgress: 'PackageUninstallRequest is currently InProgress. You can continue to query the status using' +
|
952 | '\nsfdx force:package:uninstall:get -i %s -u %s',
|
953 | Unknown: this.InProgress,
|
954 | Success: 'Successfully uninstalled package [%s]'
|
955 | }
|
956 | },
|
957 | package_install_report: {
|
958 | en_US: {
|
959 | cliDescription: 'retrieve the status of a package installation request',
|
960 | cliDescriptionLong: 'Retrieves the status of a package installation request.',
|
961 | help: 'Examples:' +
|
962 | '\n $ sfdx force:package:install:report -i 0Hf...' +
|
963 | '\n $ sfdx force:package:install:report -i 0Hf... -u me@example.com',
|
964 | requestId: 'ID of the package install request you want to check',
|
965 | requestIdLong: 'The ID of the package install request you want to check.',
|
966 | IN_PROGRESS: 'PackageInstallRequest is currently InProgress. You can continue to query the status using' +
|
967 | '\nsfdx force:package:install:report -i %s -u %s',
|
968 | UNKNOWN: this.InProgress,
|
969 | SUCCESS: 'Successfully installed package [%s]'
|
970 | }
|
971 | },
|
972 | package_uninstall_report: {
|
973 | en_US: {
|
974 | cliDescription: 'retrieve status of package uninstall request',
|
975 | cliDescriptionLong: 'Retrieves the status of a package uninstall request.',
|
976 | help: 'Examples:' +
|
977 | '\n $ sfdx force:package:uninstall:report -i 06y...' +
|
978 | '\n $ sfdx force:package:uninstall:report -i 06y... -u me@example.com',
|
979 | requestId: 'ID of the package uninstall request you want to check',
|
980 | requestIdLong: 'The ID of the package uninstall request you want to check.',
|
981 | InProgress: 'PackageUninstallRequest is currently InProgress. You can continue to query the status using' +
|
982 | '\nsfdx force:package:uninstall:report -i %s -u %s',
|
983 | Unknown: this.InProgress,
|
984 | Success: 'Successfully uninstalled package [%s]'
|
985 | }
|
986 | },
|
987 | package1_version_create_get: {
|
988 | en_US: {
|
989 | cliDescription: 'retrieve the status of a package version creation request',
|
990 | cliDescriptionLong: 'Retrieves the status of a package version creation request.',
|
991 | help: 'Examples:' +
|
992 | '\n $ sfdx force:package:version:create:report -i 08c...' +
|
993 | '\n $ sfdx force:package:version:create:report -i 08c... -v devhub@example.com',
|
994 | requestId: 'PackageUploadRequest ID',
|
995 | requestIdLong: 'The ID of the PackageUploadRequest.',
|
996 | IN_PROGRESS: 'PackageUploadRequest is still InProgress. You can query the status using' +
|
997 | '\nsfdx force:package1:version:create:get -i %s -u %s',
|
998 | SUCCESS: 'Successfully uploaded package [%s]',
|
999 | QUEUED: 'PackageUploadRequest has been enqueued. You can query the status using' +
|
1000 | '\nsfdx force:package1:version:create:get -i %s -u %s'
|
1001 | }
|
1002 | },
|
1003 | package_install: {
|
1004 | en_US: {
|
1005 | cliDescription: 'install a package in the target org',
|
1006 | cliDescriptionLong: 'Installs a package in the target org.',
|
1007 | help: 'Supply the ID of the package version to install. ' +
|
1008 | 'The package installs in your default target org unless ' +
|
1009 | 'you supply the username for a different target org.' +
|
1010 | '\n\nFor package upgrades, to specify options for component deprecation ' +
|
1011 | 'or deletion of removed components, include an --upgradetype value. ' +
|
1012 | 'To delete components that can be safely deleted and deprecate the ' +
|
1013 | 'others, specify --upgradetype Mixed (the default). To deprecate all ' +
|
1014 | 'removed components, specify --upgradetype DeprecateOnly. To delete all removed components, ' +
|
1015 | "except for custom objects and custom fields, that don't have dependencies, specify " +
|
1016 | '--upgradetype Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) ' +
|
1017 | 'The default is Mixed.' +
|
1018 | '\n\nExamples:' +
|
1019 | '\n $ sfdx force:package:install --package 04t... -u me@example.com' +
|
1020 | '\n $ sfdx force:package:install --package awesome_package_alias' +
|
1021 | '\n $ sfdx force:package:install --package "Awesome Package Alias"' +
|
1022 | '\n $ sfdx force:package:install --package 04t... -t DeprecateOnly',
|
1023 | id: 'ID of the package version to install (starts with 04t)',
|
1024 | idLong: 'The ID of the package version to install (starts with 04t).',
|
1025 | wait: 'number of minutes to wait for installation status',
|
1026 | waitLong: 'Maximum number of minutes to wait for installation status. The default is 0.',
|
1027 | installationKey: 'installation key for key-protected package (default: null)',
|
1028 | installationKeyLong: 'Installation key for installing a key-protected package. The default is null.',
|
1029 | noPrompt: 'do not prompt for confirmation',
|
1030 | noPromptLong: 'Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, ' +
|
1031 | 'and 2) --upgradetype Delete to proceed.',
|
1032 | promptRss: 'This package might send or receive data from these third-party websites:\n\n' +
|
1033 | '%s' +
|
1034 | '\n\nGrant access (y/n)?',
|
1035 | promptUpgradeType: 'Please confirm usage of the --upgradetype Delete operation. This can result in the loss of data associated with the deleted components. Proceed with caution.' +
|
1036 | '\n\nProceed (y/n)?',
|
1037 | promptUpgradeTypeDeny: 'The installation has been canceled because confirmation was not granted for the --upgradetype Delete operation. ' +
|
1038 | 'If you want to install the package, run "sfdx force:package:install" again.',
|
1039 | publishWait: 'number of minutes to wait for subscriber package version ID to become available in the target org ',
|
1040 | publishWaitLong: 'Maximum number of minutes to wait for the Subscriber Package Version ID to become available ' +
|
1041 | 'in the target org before canceling the install request. The default is 0.',
|
1042 | humanSuccess: 'Successfully installed package ID %s.',
|
1043 | publishWaitProgress: 'Waiting for the Subscriber Package Version ID to be published to the target org.',
|
1044 | errorApvIdNotPublished: 'The package version is not fully available. If this is a recently created package ' +
|
1045 | 'version, try again in a few minutes or contact the package publisher.',
|
1046 | package: 'ID (starts with 04t) or alias of the package version to install',
|
1047 | packageLong: 'The ID (starts with 04t) or alias of the package version to install.',
|
1048 | securityType: 'security access type for the installed package (deprecation notice: The default --securitytype value will change from AllUsers to AdminsOnly in v47.0 or later.)',
|
1049 | securityTypeLong: "Security access type for the installed package.\nDeprecation notice: The --securitytype parameter's default value will change from AllUsers to AdminsOnly in an upcoming release (v47.0 or later).",
|
1050 | upgradeType: 'the upgrade type for the package installation',
|
1051 | upgradeTypeLong: 'For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), ' +
|
1052 | 'to delete removed components that can be safely deleted and deprecate the others (Mixed), ' +
|
1053 | "or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete).",
|
1054 | apexCompile: 'compile all Apex in the org and package, or only Apex in the package',
|
1055 | apexCompileLong: 'For unlocked packages only, specifies whether to compile all Apex in the org and package, or only the Apex in the package.',
|
1056 | errorRequiredFlags: 'Include either a %s value or a %s value.',
|
1057 | invalidIdOrPackage: 'Invalid alias or ID: %s. Either your alias is invalid or undefined, or the ID provided is invalid.',
|
1058 | deprecateSecurityTypeDefault: "[Deprecation notice: The --securitytype parameter's default value will change from AllUsers to AdminsOnly in an upcoming release (v47.0 or later).]"
|
1059 | }
|
1060 | },
|
1061 | package_version_promote: {
|
1062 | en_US: {
|
1063 | cliDescription: 'promote a package version to released',
|
1064 | cliDescriptionLong: 'Promotes a package version to released status.',
|
1065 | help: 'Supply the ID or alias of the package version you want ' +
|
1066 | 'to promote. Promotes the package version to released status.' +
|
1067 | '\n\nExamples:' +
|
1068 | '\n $ sfdx force:package:version:promote -p 04t...' +
|
1069 | '\n $ sfdx force:package:version:promote -p awesome_package_alias' +
|
1070 | '\n $ sfdx force:package:version:promote -p "Awesome Package Alias"',
|
1071 | package: 'ID (starts with 04t) or alias of the package version to promote',
|
1072 | packageLong: 'The ID (starts with 04t) or alias of the package version to promote.',
|
1073 | packageVersionPromoteSetAsReleasedYesNo: "Are you sure you want to release package version %s? You can't undo this action. Release package (y/n)?",
|
1074 | setasreleasedForce: 'no prompt to confirm setting the package version as released',
|
1075 | setasreleasedForceLong: 'Do not prompt to confirm setting the package version as released.',
|
1076 | humanSuccess: 'Successfully promoted the package version, ID: %s, to released.',
|
1077 | previouslyReleasedMessage: 'You already promoted a package version with this major.minor.patch version number. For a given major.minor.patch number, you can promote only one version.',
|
1078 | previouslyReleasedAction: 'Create a new package version with a different --versionumber, then promote the package version.\n' +
|
1079 | 'sfdx force:package:version:create -p <name> -n <versionnum> -k <key>\n' +
|
1080 | 'sfdx force:package:version:promote -p 05ixxx'
|
1081 | }
|
1082 | },
|
1083 | package_uninstall: {
|
1084 | en_US: {
|
1085 | cliDescription: 'uninstall a second-generation package from the target org',
|
1086 | cliDescriptionLong: 'Uninstalls a second-generation package from ' +
|
1087 | 'the target org. To uninstall a first-generation package, ' +
|
1088 | 'use the Salesforce user interface.',
|
1089 | help: 'Specify the package ID for a second-generation package.' +
|
1090 | '\n\nExamples:' +
|
1091 | '\n $ sfdx force:package:uninstall -p 04t... -u me@example.com' +
|
1092 | '\n $ sfdx force:package:uninstall -p undesirable_package_alias' +
|
1093 | '\n $ sfdx force:package:uninstall -p "Undesirable Package Alias"' +
|
1094 | '\n\nTo list the org’s installed packages, run ' +
|
1095 | '"sfdx force:package:installed:list".' +
|
1096 | '\n\nTo uninstall a first-generation package, from Setup, ' +
|
1097 | 'enter Installed Packages in the Quick Find box, then ' +
|
1098 | 'select Installed Packages.',
|
1099 | id: 'ID of the package to uninstall (starts with 04t)',
|
1100 | idLong: 'The ID of the second-generation package to uninstall (starts with 04t).',
|
1101 | wait: 'number of minutes to wait for uninstall status',
|
1102 | waitLong: 'Maximum number of minutes to wait for uninstall status. The default is 0.',
|
1103 | defaultErrorMessage: "Can't uninstall the package %s during uninstall request %s.",
|
1104 | humanSuccess: 'Successfully uninstalled package ID %s.',
|
1105 | action: 'Verify installed package ID and resolve errors, then try again.',
|
1106 | package: 'ID (starts with 04t) or alias of the package version to uninstall',
|
1107 | packageLong: 'The ID (starts with 04t) or alias of the package version to uninstall.',
|
1108 | errorRequiredFlags: 'Include either a %s value or a %s value.',
|
1109 | invalidIdOrPackage: 'Invalid alias or ID: %s. Either your alias is invalid or undefined, or the ID provided is invalid.'
|
1110 | }
|
1111 | },
|
1112 | packaging: {
|
1113 | en_US: {
|
1114 | topicHelp: 'develop, install, and manage packages',
|
1115 | topicHelpLong: 'Use the package commands to develop, install, and manage packages.',
|
1116 | createdLastDaysDescription: 'created in the last specified number of days (starting at 00:00:00 of first day to now; 0 for today)',
|
1117 | createdLastDaysLongDescription: 'Filters the list based on the specified maximum number of days since the request was created ' +
|
1118 | '(starting at 00:00:00 of first day to now; 0 for today).',
|
1119 | modifiedLastDaysDescription: 'list items modified in the specified last number of days (starting at 00:00:00 of first day to now; 0 for today)',
|
1120 | modifiedLastDaysLongDescription: 'Lists the items modified in the specified last number of days, starting at 00:00:00 of first day to now. Use 0 for today.',
|
1121 | invalidIdOrAlias: "The %s: %s isn't defined in the sfdx-project.json. Add it to the packageDirectories section and add the alias to packageAliases with its %s ID.",
|
1122 | invalidDaysNumber: 'Provide a valid positive number for %s.',
|
1123 | invalidStatus: "Invalid status '%s'. Please provide one of these statuses: %s",
|
1124 | packageNotEnabledAction: 'Packaging is not enabled on this org. Verify that you are authenticated to the desired org and try again. Otherwise, contact Salesforce Customer Support for more information.',
|
1125 | packageInstanceNotEnabled: 'Your org does not have permission to specify a build instance for your package version. Verify that you are authenticated to the desired org and try again. Otherwise, contact Salesforce Customer Support for more information.',
|
1126 | packageSourceOrgNotEnabled: 'Your Dev Hub does not have permission to specify a source org for your build org. Verify that you are authenticated to the correct Dev Hub and try again. Otherwise, contact Salesforce Customer Support for assistance.',
|
1127 | installStatus: 'Waiting for the package install request to complete. Status = %s',
|
1128 | errorMissingVersionNumber: 'The VersionNumber property must be specified.',
|
1129 | errorInvalidVersionNumber: 'VersionNumber must be in the format major.minor.patch.build but the value found is [%s].',
|
1130 | errorInvalidBuildNumber: "The provided VersionNumber '%s' is invalid. Provide an integer value or use the keyword '%s' for the build number.",
|
1131 | errorInvalidPatchNumber: "The provided VersionNumber '%s' is not supported. Provide a patch number of 0.",
|
1132 | errorInvalidMajorMinorNumber: "The provided VersionNumber '%s' is invalid. Provide an integer value for the %s number.",
|
1133 | errorInvalidAncestorVersionFormat: 'The ancestor versionNumber must be in the format major.minor.patch but the value found is [%s].',
|
1134 | errorInvalidPackageId: "The provided package ID '%s' is invalid.",
|
1135 | errorNoMatchingAncestor: "The ancestorId for ancestorVersion [%s] can't be found. Package ID [%s].",
|
1136 | errorAncestorIdVersionMismatch: 'The ancestorVersion in sfdx-project.json is not the version expected for the ancestorId you supplied. ancestorVersion [%s]. ancestorID [%s].',
|
1137 | errorpackageAncestorIdsKeyNotSupported: 'The package2AncestorIds key is no longer supported in a scratch org definition. Ancestors defined in sfdx-project.json will be included in the scratch org.',
|
1138 | errorInvalidIdNoMatchingVersionId: 'The %s %s is invalid, as a corresponding %s was not found',
|
1139 | errorIdTypeMismatch: 'ID type mismatch: an ID of type %s is required, but an ID of type %s was specified: %s',
|
1140 | updatedSfdxProject: 'sfdx-project.json has been updated.',
|
1141 | errorSfdxProjectFileWrite: 'sfdx-project.json could not be updated with the following entry for this package: \n%s\nReason: %s\n',
|
1142 | invalidPackageTypeAction: 'Specify Unlocked or Managed for package type.',
|
1143 | invalidPackageTypeMessage: 'Invalid package type',
|
1144 | idNotFoundAction: 'It`s possible that this package was created on a different Dev Hub. Authenticate to the Dev Hub org that owns the package, and reference that Dev Hub when running the command.',
|
1145 | malformedPackageVersionIdAction: 'Use "sfdx force:package:version:list" to verify the 05i package version ID.',
|
1146 | malformedPackageVersionIdMessage: 'We can’t find this package version ID for this Dev Hub.',
|
1147 | malformedPackageIdAction: 'Use "sfdx force:package:list" to verify the 0Ho package version ID.',
|
1148 | malformedPackageIdMessage: 'We can’t find this package ID for this Dev Hub.'
|
1149 | }
|
1150 | },
|
1151 |
|
1152 | package_install_request: {
|
1153 | en_US: {
|
1154 | cliDescription: '(deprecated) retrieve the status of a package install request',
|
1155 | cliDescriptionLong: 'Retrieves the status of a package installion request.',
|
1156 | help: 'Examples:' +
|
1157 | '\n $ sfdx force:package:install:get -i 0Hf...' +
|
1158 | '\n $ sfdx force:package:install:get -i 0Hf... -u me@example.com',
|
1159 | requestId: 'Package Installation Request ID',
|
1160 | requestIdLong: 'ID of the package install request.',
|
1161 | IN_PROGRESS: 'The package installation request is still In Progress or Unknown. You can query the status using ' +
|
1162 | '\n $ sfdx force:package:install:get -i %s -u %s',
|
1163 | UNKNOWN: this.InProgress,
|
1164 | SUCCESS: 'Successfully installed package [%s].'
|
1165 | }
|
1166 | },
|
1167 | package_create: {
|
1168 | en_US: {
|
1169 | cliDescription: 'create a package',
|
1170 | cliLongDescription: 'Creates a package.',
|
1171 | help: 'First, use this command to create a package. Then create a package version.' +
|
1172 | '\n\nIf you don’t have a namespace defined in your sfdx-project.json file, use --nonamespace.' +
|
1173 | '\n\nYour --name value must be unique within your namespace.' +
|
1174 | '\n\nExamples:' +
|
1175 | '\n $ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app' +
|
1176 | '\n $ sfdx force:package:create -n YourPackageName -d "Your Package Descripton" -t Unlocked -r force-app' +
|
1177 | "\n\nRun 'sfdx force:package:list' to list all packages in the Dev Hub org.",
|
1178 | name: 'package name',
|
1179 | nameLong: 'Name of the package to create.',
|
1180 | description: 'package description',
|
1181 | descriptionLong: 'Description of the package.',
|
1182 | noNamespace: 'creates the package with no namespace; available only for unlocked packages.',
|
1183 | noNamespaceLong: 'Creates the package with no namespace. Available only for unlocked packages. ' +
|
1184 | 'Useful when you’re migrating an existing org to packages. ' +
|
1185 | 'But, use a namespaced package for new metadata.',
|
1186 | packageType: 'package type',
|
1187 | packageTypeLong: 'Package type for the package.' +
|
1188 | '\nThe options for package type are Managed and Unlocked ' +
|
1189 | '(Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable). ' +
|
1190 | '\nThese options determine upgrade and editability rules.',
|
1191 | path: 'path to directory that contains the contents of the package',
|
1192 | longPath: 'The path to the directory that contains the contents of the package.',
|
1193 | errorPathNotSpecified: 'Add a valid path to packageDirectories in the sfdx-project.json file. ' +
|
1194 | 'When the --path parameter is specified, the path is automatically added to the sfdx-project.json file.\n%s\n',
|
1195 | humanSuccess: 'Successfully created a package.'
|
1196 | }
|
1197 | },
|
1198 | package_update: {
|
1199 | en_US: {
|
1200 | cliDescription: 'update package details',
|
1201 | cliLongDescription: 'Updates details about a package. Does not create a package version.',
|
1202 | help: 'Specify a new value for each option you want to update.' +
|
1203 | '\n\nExamples:' +
|
1204 | '\n $ sfdx force:package:update -p "Your Package Alias" -n "New Package Name"' +
|
1205 | '\n $ sfdx force:package:update -p 0Ho... -d "New Package Description"' +
|
1206 | '\n\nRun "sfdx force:package:list" to list all packages in the Dev Hub org.',
|
1207 | package: 'ID (starts with 0Ho) or alias of the package to update',
|
1208 | packageLong: 'The ID (starts with 0Ho) or alias of the package to update.',
|
1209 | name: 'new package name',
|
1210 | nameLong: 'New name of the package.',
|
1211 | description: 'new package description',
|
1212 | descriptionLong: 'New description of the package.',
|
1213 | humanSuccess: 'Successfully updated the package.'
|
1214 | }
|
1215 | },
|
1216 | package_list: {
|
1217 | en_US: {
|
1218 | cliDescription: 'list all packages in the Dev Hub org',
|
1219 | cliLongDescription: 'Lists all packages in the Dev Hub org.',
|
1220 | help: 'You can view the namespace, IDs, and other details for each package.' +
|
1221 | '\n\nExamples:' +
|
1222 | '\n $ sfdx force:package:list -v devhub@example.com' +
|
1223 | '\n $ sfdx force:package:list -v devhub@example.com --verbose',
|
1224 | namespace: 'Namespace Prefix',
|
1225 | name: 'Name',
|
1226 | id: 'Id',
|
1227 | packageId: 'Subscriber Package Id',
|
1228 | alias: 'Alias',
|
1229 | description: 'Description',
|
1230 | packageType: 'Type',
|
1231 | verboseDescription: 'display extended package detail',
|
1232 | verboseLongDescription: 'Displays extended package details.'
|
1233 | }
|
1234 | },
|
1235 | package_version_create: {
|
1236 | en_US: {
|
1237 | cliDescription: 'create a package version',
|
1238 | cliLongDescription: 'Creates a package version in the Dev Hub org.',
|
1239 | help: 'The package version is based on the package contents in the specified directory.' +
|
1240 | '\n\nTo retrieve details about a package version create request, including status and package version ID (04t), ' +
|
1241 | 'run "sfdx force:package:version:create:report -i 08c...".' +
|
1242 | '\n\nWe recommend specifying the --installationkey to protect the contents of your package and to prevent unauthorized installation of your package.' +
|
1243 | '\n\nTo list package version creation requests in the org, run "sfdx force:package:version:create:list".' +
|
1244 | '\n\nManaged packages must use the --codecoverage option and meet the code coverage requirements to promote a version to released.' +
|
1245 | '\n\nExamples:' +
|
1246 | '\n $ sfdx force:package:version:create -d common -k password123' +
|
1247 | '\n $ sfdx force:package:version:create -p "Your Package Alias" -k password123' +
|
1248 | '\n $ sfdx force:package:version:create -p 0Ho... -k password123',
|
1249 | package: 'ID (starts with 0Ho) or alias of the package to create a version of',
|
1250 | longPackage: 'The ID (starts with 0Ho) or alias of the package to create a version of.',
|
1251 | path: 'path to directory that contains the contents of the package',
|
1252 | longPath: 'The path to the directory that contains the contents of the package.',
|
1253 | definitionfile: 'path to a definition file similar to scratch org definition file that contains the list of features ' +
|
1254 | 'and org preferences that the metadata of the package version depends on',
|
1255 | longDefinitionfile: 'The path to a definition file similar to scratch org definition file that contains the list of features ' +
|
1256 | 'and org preferences that the metadata of the package version depends on.',
|
1257 | dir: 'path to directory that contains the contents of the package version',
|
1258 | longDir: 'The path to the directory that contains the contents of the package version.',
|
1259 | branch: 'the package version’s branch',
|
1260 | longBranch: 'The package version’s branch.',
|
1261 | tag: 'the package version’s tag',
|
1262 | longTag: 'The package version’s tag.',
|
1263 | key: 'installation key for key-protected package (either ' +
|
1264 | '--installationkey or --installationkeybypass is required)',
|
1265 | longKey: 'Installation key for creating the key-protected ' +
|
1266 | 'package. Either an --installationkey value or the ' +
|
1267 | '--installationkeybypass flag is required.',
|
1268 | keyBypass: 'bypass the installation key requirement (either ' +
|
1269 | '--installationkey or --installationkeybypass is required)',
|
1270 | longKeyBypass: 'Bypasses the installation key requirement. ' +
|
1271 | 'If you bypass this requirement, anyone can install your package. ' +
|
1272 | 'Either an --installationkey value or the ' +
|
1273 | '--installationkeybypass flag is required.',
|
1274 | preserve: 'temp files are preserved that would otherwise be deleted',
|
1275 | longPreserve: 'Specifies that the temp files are preserved that would otherwise be deleted',
|
1276 | validateschema: 'sfdx-project.json is validated against JSON schema',
|
1277 | longValidateschema: 'Specifies that the sfdx-project.json file should be validated against JSON schema.',
|
1278 | tempFileLocation: 'The temp files are located at: %s.',
|
1279 | wait: 'minutes to wait for the package version to be created',
|
1280 | longWait: 'The number of minutes to wait for the package version to be created.',
|
1281 | instance: 'the instance where the package version will be created——for example, NA50',
|
1282 | longInstance: 'The instance where the package version will be created——for example, NA50.',
|
1283 | sourceorg: 'the source org ID used to copy the org shape for the build org',
|
1284 | longSourceorg: 'The source org ID used to copy the org shape for the build org.',
|
1285 | versionname: 'the name of the package version to be created',
|
1286 | longVersionname: 'The name of the package version to be created. Overrides the sfdx-project.json value.',
|
1287 | versionnumber: 'the version number of the package version to be created',
|
1288 | longVersionnumber: 'The version number of the package version to be created. Overrides the sfdx-project.json value.',
|
1289 | versiondescription: 'the description of the package version to be created',
|
1290 | longVersiondescription: 'The description of the package version to be created. Overrides the sfdx-project.json value.',
|
1291 | codeCoverage: 'calculate the code coverage by running the packaged Apex tests. ' +
|
1292 | 'Note: Managed packages must use this option and meet the code coverage requirements to promote the version.',
|
1293 | longCodeCoverage: 'Calculate and store the code coverage percentage by running the Apex tests included in this package version. ' +
|
1294 | 'Managed packages must use this option and meet the code coverage requirements to promote the version.',
|
1295 | releaseNotesUrl: 'release notes URL',
|
1296 | releaseNotesUrlLong: 'The release notes URL. This link is displayed in the package installation UI to provide release notes ' +
|
1297 | 'for this package version to subscribers.',
|
1298 | postInstallUrl: 'post-install URL',
|
1299 | postInstallUrlLong: 'The post-install instructions URL. The contents of the post-installation instructions URL are displayed ' +
|
1300 | 'in the UI after installation of the package version.',
|
1301 | postInstallScript: 'post-install script name',
|
1302 | postInstallScriptLong: 'The post-install script name. The post-install script is an Apex class within this package that is run ' +
|
1303 | 'in the installing org after installations or upgrades of this package version.',
|
1304 | uninstallScript: 'uninstall script name',
|
1305 | uninstallScriptLong: 'The uninstall script name. The uninstall script is an Apex class within this package that is run in the ' +
|
1306 | 'installing org after uninstallations of this package.',
|
1307 | defaultVersionName: 'versionName is blank in sfdx-project.json, so it will be set to this default value based on the versionNumber: %s',
|
1308 | InProgress: 'Package version creation request status is \'%s\'. Run "sfdx force:package:version:create:report -i %s" to query for status.',
|
1309 | Success: 'Successfully created the package version [%s]. Subscriber Package Version Id: %s' +
|
1310 | '\nPackage Installation URL: %s%s' +
|
1311 | '\nAs an alternative, you can use the "sfdx force:package:install" command.',
|
1312 | errorMissingFlags: 'Include either a %s value or a %s value. The value must match one of the packageDirectories specified in sfdx-project.json.',
|
1313 | errorMissingFlagsInstallationKey: 'A required parameter is missing. Include either an %s value or %s.',
|
1314 | errorNoMatchingPackageDirectory: 'The %s value [%s], doesn’t match the %s value in any packageDirectories specified in sfdx-project.json.',
|
1315 | errorDirectoryIdMismatch: 'The %s value, [%s], and %s value, [%s], ' +
|
1316 | 'were both found in sfdx-project.json but don’t match. ' +
|
1317 | 'If you supply both values, they must match the path and ' +
|
1318 | 'package values in one of the packageDirectories.',
|
1319 | errorDependencyPair: 'Dependency must specify either a subscriberPackageVersionId or both packageId and versionNumber: %s.',
|
1320 | errorNoIdInHub: 'No package ID was found in Dev Hub for package ID: %s.',
|
1321 | errorPackageAndPackageIdCollision: 'You can’t have both "package" ' + 'and "packageId" (deprecated) defined as dependencies in sfdx-project.json.',
|
1322 | errorPackageAndIdCollision: 'You can’t have both "package" and ' + '"id" (deprecated) defined in your sfdx-project.json file.',
|
1323 | errorMissingPackage: 'The package %s isn’t defined in the sfdx-project.json file. ' +
|
1324 | 'Add it to the packageDirectories section and add the alias to packageAliases with its 0Ho ID.',
|
1325 | errorEmptyPackageDirs: 'sfdx-project.json must contain a packageDirectories entry for a package. You can run the force:package:create command to auto-populate such an entry.',
|
1326 | unknownError: 'Package version creation failed with unknown error.',
|
1327 | malformedUrl: 'The %s value "%s" from the command line or sfdx-project.json is not in the correct format for a URL. It must be a valid URL in the ' +
|
1328 | 'format "http://salesforce.com". More information: https://nodejs.org/api/url.html#url_url_strings_and_url_objects'
|
1329 | }
|
1330 | },
|
1331 | package_version_create_list: {
|
1332 | en_US: {
|
1333 | cliDescription: 'list package version creation requests',
|
1334 | cliLongDescription: 'Lists all requests to create second-generation package versions in the Dev Hub org.',
|
1335 | statusDescription: 'filter the list by version creation request status',
|
1336 | statusLongDescription: 'Filters the list based on the status of version creation requests.',
|
1337 | help: 'Shows the details of each request to create a package version in the Dev Hub org.' +
|
1338 | '\n\nAll filter parameters are applied using the AND logical operator (not OR).' +
|
1339 | '\n\nTo get information about a specific request, run "sfdx force:package:version:create:report" and supply the request ID.' +
|
1340 | '\n\nExamples:' +
|
1341 | '\n $ sfdx force:package:version:create:list' +
|
1342 | '\n $ sfdx force:package:version:create:list --createdlastdays 3' +
|
1343 | '\n $ sfdx force:package:version:create:list --status Error' +
|
1344 | '\n $ sfdx force:package:version:create:list -s InProgress' +
|
1345 | '\n $ sfdx force:package:version:create:list -c 3 -s Success',
|
1346 | id: 'ID',
|
1347 | status: 'Status',
|
1348 | packageId: 'Package Id',
|
1349 | packageVersionId: 'Package Version Id',
|
1350 | subscriberPackageVersionId: 'Subscriber Package Version Id',
|
1351 | branch: 'Branch',
|
1352 | tag: 'Tag',
|
1353 | installUrl: 'Installation URL'
|
1354 | }
|
1355 | },
|
1356 | package_version_create_report: {
|
1357 | en_US: {
|
1358 | cliDescription: 'retrieve details about a package version creation request',
|
1359 | cliLongDescription: 'Retrieves details about a package version creation request in the Dev Hub org.',
|
1360 | help: 'Specify the request ID for which you want to view details. ' +
|
1361 | 'If applicable, the command displays errors related to the request.' +
|
1362 | '\n\nExamples:' +
|
1363 | '\n $ sfdx force:package:version:create:report -i 08c...' +
|
1364 | '\n $ sfdx force:package:version:create:report -i 08c... -v devhub@example.com' +
|
1365 | '\n\nTo show all requests in the org, run "sfdx force:package:version:create:list".',
|
1366 | requestId: 'package version creation request ID (starts with 08c)',
|
1367 | requestIdLong: 'The ID (starts with 08c) of the package version creation request you want to display.',
|
1368 | error: 'Error',
|
1369 | truncatedErrors: '...\n\nTo see all errors, run: sfdx force:data:soql:query -t -q "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id =\'%s\'"\n'
|
1370 | }
|
1371 | },
|
1372 | package_version_update: {
|
1373 | en_US: {
|
1374 | cliDescription: 'update a package version',
|
1375 | cliLongDescription: 'Updates a second-generation package version in the Dev Hub org.',
|
1376 | help: 'Specify a new value for each option you want to update.' +
|
1377 | '\n\nExamples:' +
|
1378 | '\n $ sfdx force:package:version:update -p "Your Package Alias" -k password123' +
|
1379 | "\n $ sfdx force:package:version:update -p 04t... -b master -t 'Release 1.0.7'" +
|
1380 | '\n $ sfdx force:package:version:update -p 04t... -e "New Package Version Description"' +
|
1381 | '\n\nTo display details about a package version, run "sfdx force:package:version:report".',
|
1382 | package: 'ID (starts with 04t) or alias of the package to update a version of',
|
1383 | packageLong: 'The ID (starts with 04t) or alias of the package to update a version of.',
|
1384 | name: 'new package version name',
|
1385 | nameLong: 'The new package version name.',
|
1386 | description: 'new package version description',
|
1387 | descriptionLong: 'The new package version description.',
|
1388 | branch: 'new package version branch',
|
1389 | branchLong: 'The new package version branch.',
|
1390 | tag: 'new package version tag',
|
1391 | tagLong: 'The new package version tag.',
|
1392 | key: 'new installation key for key-protected package (default: null)',
|
1393 | longKey: 'The new installation key for the key-protected package. The default is null.',
|
1394 | humanSuccess: 'Successfully updated the package version.',
|
1395 | previousReleased: 'To release the new package version, run "sfdx force:package:version:update -s <new package version ID>".'
|
1396 | }
|
1397 | },
|
1398 | package_version_report: {
|
1399 | en_US: {
|
1400 | cliDescription: 'retrieve details about a package version in the Dev Hub org',
|
1401 | cliLongDescription: 'Retrieves details about a package version in the Dev Hub org.',
|
1402 | help: 'Examples:' +
|
1403 | '\n $ sfdx force:package:version:report -p 04t...' +
|
1404 | '\n $ sfdx force:package:version:report -p "Your Package Alias"' +
|
1405 | '\n\nTo update package version values, run "sfdx force:package:version:update".',
|
1406 | package: 'ID (starts with 04t) or alias of the package to retrieve details for',
|
1407 | packageLong: 'The ID (starts with 04t) or alias of the package to retrieve details for.',
|
1408 | verboseDescription: 'displays extended package version details',
|
1409 | verboseLongDescription: 'Displays extended package version details.'
|
1410 | }
|
1411 | },
|
1412 | package_version_list: {
|
1413 | en_US: {
|
1414 | cliDescription: 'list all package versions in the Dev Hub org',
|
1415 | cliLongDescription: 'Lists all package versions in the Dev Hub org.',
|
1416 | conciseDescription: 'display limited package version details',
|
1417 | conciseLongDescription: 'Displays limited package version details.',
|
1418 | packagesDescription: 'filter results on specified comma-delimited packages (aliases or 0Ho IDs)',
|
1419 | packagesLongDescription: 'Filters results on the specified comma-delimited packages (aliases or 0Ho IDs).',
|
1420 | releasedDescription: 'display released versions only',
|
1421 | releasedLongDescription: 'Displays released versions only (IsReleased=true).',
|
1422 | orderByDescription: 'order by the specified package version fields',
|
1423 | orderByLongDescription: 'Orders the list by the specified package version fields.',
|
1424 | verboseDescription: 'display extended package version details',
|
1425 | verboseLongDescription: 'Displays extended package version details.',
|
1426 | help: 'Displays details of each package version in the org.' +
|
1427 | '\n\nUse --concise or --verbose to display limited or additional details, respectively.' +
|
1428 | '\n\nAll filter parameters are applied using the AND logical operator (not OR).' +
|
1429 | '\n\nExamples:' +
|
1430 | '\n $ sfdx force:package:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion' +
|
1431 | '\n $ sfdx force:package:version:list --packages 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0' +
|
1432 | '\n $ sfdx force:package:version:list --released' +
|
1433 | '\n $ sfdx force:package:version:list --concise --modifiedlastdays 0' +
|
1434 | '\n $ sfdx force:package:version:list --concise -c 3 -r' +
|
1435 | '\n $ sfdx force:package:version:list --packages exp-mgr,exp-mgr-util --released --modifiedlastdays 0',
|
1436 | name: 'Name',
|
1437 | description: 'Description',
|
1438 | version: 'Version',
|
1439 | id: 'Package Version Id',
|
1440 | alias: 'Alias',
|
1441 | subscriberPackageVersionId: 'Subscriber Package Version Id',
|
1442 | packageId: 'Package Id',
|
1443 | packageBranch: 'Branch',
|
1444 | packageTag: 'Tag',
|
1445 | installUrl: 'Installation URL',
|
1446 | installKey: 'Installation Key',
|
1447 | codeCoverage: 'Code Coverage',
|
1448 | hasPassedCodeCoverageCheck: 'Code Coverage Met'
|
1449 | }
|
1450 | },
|
1451 | package_installed_list: {
|
1452 | en_US: {
|
1453 | cliDescription: 'list the org’s installed packages',
|
1454 | cliLongDescription: 'Lists all packages installed in the target org.',
|
1455 | help: 'Examples:' +
|
1456 | '\n $ sfdx force:package:installed:list' +
|
1457 | '\n $ sfdx force:package:installed:list -u me@example.com',
|
1458 | username: 'a username or alias for the target org',
|
1459 | id: 'ID',
|
1460 | subscriberPackageId: 'Package ID',
|
1461 | subscriberPackageName: 'Package Name',
|
1462 | subscriberPackageNamespace: 'Namespace',
|
1463 | subscriberPackageVersionId: 'Package Version ID',
|
1464 | subscriberPackageVersionName: 'Version Name',
|
1465 | subscriberPackageVersionNumber: 'Version'
|
1466 | }
|
1467 | },
|
1468 |
|
1469 | package2: {
|
1470 | en_US: {
|
1471 | topicHelp: 'develop second-generation packages',
|
1472 | topicHelpLong: 'Use the package2 commands to create, install, and manage second-generation packages.',
|
1473 | createdLastDaysDescription: 'created in the last specified number of days (starting at 00:00:00 of first day to now; 0 for today)',
|
1474 | createdLastDaysLongDescription: 'Filters the list based on the specified maximum number of days since the request was created ' +
|
1475 | '(starting at 00:00:00 of first day to now; 0 for today).',
|
1476 | modifiedLastDaysDescription: 'list items modified in the specified last number of days (starting at 00:00:00 of first day to now; 0 for today)',
|
1477 | modifiedLastDaysLongDescription: 'Lists the items modified in the specified last number of days, starting at 00:00:00 of first day to now. Use 0 for today.',
|
1478 | invalidId: 'Invalid %s: %s. Provide a valid ID that starts with %s.',
|
1479 | invalidDaysNumber: 'Provide a valid positive number for %s.',
|
1480 | invalidStatus: "Invalid status '%s'. Please provide one of these statuses: %s",
|
1481 | package2NotEnabledAction: 'Second-generation packaging is not enabled on this org. Verify that you are authenticated to the desired org and try again. Otherwise, contact Salesforce Customer Support for more information.',
|
1482 | package2InstanceNotEnabled: 'Your org does not have permission to specify a build instance for your package version. Verify that you are authenticated to the desired org and try again. Otherwise, contact Salesforce Customer Support for more information.',
|
1483 | package2SourceOrgNotEnabled: 'Your Dev Hub does not have permission to specify a source org for your build org. Verify that you are authenticated to the correct Dev Hub and try again. Otherwise, contact Salesforce Customer Support for assistance.',
|
1484 | installStatus: 'Waiting for the package install request to complete. Status = %s',
|
1485 | errorMissingVersionNumber: 'The VersionNumber property must be specified.',
|
1486 | errorInvalidVersionNumber: 'VersionNumber must be in the format major.minor.patch.build but the value found is [%s].',
|
1487 | errorInvalidBuildNumber: "The provided VersionNumber '%s' is invalid. Provide an integer value or use the keyword '%s' for the build number.",
|
1488 | errorInvalidPatchNumber: "The provided VersionNumber '%s' is not supported. Provide a patch number of 0.",
|
1489 | errorInvalidMajorMinorNumber: "The provided VersionNumber '%s' is invalid. Provide an integer value for the %s number.",
|
1490 | errorInvalidAncestorVersionFormat: 'The ancestor versionNumber must be in the format major.minor but the value found is [%s].',
|
1491 | errorNoMatchingAncestor: "The ancestorId for ancestorVersion [%s] can't be found. Package 2 ID [%s].",
|
1492 | errorAncestorIdVersionMismatch: 'The ancestorVersion in sfdx-project.json is not the version expected for the ancestorId you supplied. ancestorVersion [%s]. ancestorID [%s].',
|
1493 | errorpackage2AncestorIdsKeyNotSupported: 'The package2AncestorIds key is no longer supported in a scratch org definition. Ancestors defined in sfdx-project.json will be included in the scratch org.'
|
1494 | }
|
1495 | },
|
1496 | package2_create: {
|
1497 | en_US: {
|
1498 | cliDescription: 'create a second-generation package',
|
1499 | cliLongDescription: 'Creates a second-generation package.',
|
1500 | help: 'First, use this command to create a second-generation package. Then create a package version.' +
|
1501 | '\n\nYour --name value must be unique within your namespace.' +
|
1502 | '\n\nExamples:' +
|
1503 | "\n $ sfdx force:package2:create -n PackageName -d 'My New Package' -o Unlocked" +
|
1504 | "\n\nRun 'sfdx force:package2:list' to list all second-generation packages in the Dev Hub org.",
|
1505 | name: 'package name',
|
1506 | nameLong: 'Name of the second-generation package to create.',
|
1507 | description: 'package description',
|
1508 | descriptionLong: 'Description of the second-generation package.',
|
1509 | noNamespace: 'creates the package with no namespace; available only for developer-controlled packages.',
|
1510 | noNamespaceLong: 'Creates the package with no namespace. Available only for developer-controlled packages. ' +
|
1511 | 'Useful when migrating an existing org to packages, but new metadata should use a namespaced package.',
|
1512 | containerOptions: '[*Managed | Unlocked] container options for the package2 ' +
|
1513 | '(Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable)',
|
1514 | containerOptionsLong: 'Container options for the package2. ' +
|
1515 | '\nManaged is default. Other options include Unlocked. (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable). ' +
|
1516 | '\nThese options determine the upgrade and editability rules.',
|
1517 | humanSuccess: 'Successfully created a second-generation package (package2).'
|
1518 | }
|
1519 | },
|
1520 | package2_update: {
|
1521 | en_US: {
|
1522 | cliDescription: 'update a second-generation package',
|
1523 | cliLongDescription: 'Updates a second-generation package.',
|
1524 | help: 'Specify a new value for each option you want to update.' +
|
1525 | '\n\nExamples:' +
|
1526 | "\n $ sfdx force:package2:update --package2id 0Ho... --name 'AAnalytics'" +
|
1527 | "\n $ sfdx force:package2:update -i 0Ho... -d 'Advanced Analytics'" +
|
1528 | "\n\nRun 'sfdx force:package2:list' to list all second-generation packages in the Dev Hub org.",
|
1529 | id: 'id of the package (starts with 0Ho)',
|
1530 | idLong: 'ID of package (starts with 0Ho).',
|
1531 | name: 'package name',
|
1532 | nameLong: 'Name of the package to update.',
|
1533 | description: 'package description',
|
1534 | descriptionLong: 'Description of the package.',
|
1535 | humanSuccess: 'Successfully updated the package. ID: %s.'
|
1536 | }
|
1537 | },
|
1538 | package2_list: {
|
1539 | en_US: {
|
1540 | cliDescription: 'list all second-generation packages in the Dev Hub org',
|
1541 | cliLongDescription: 'Lists all second-generation packages in the Dev Hub org.',
|
1542 | help: 'You can view the namespace, IDs, and other details for each package.',
|
1543 | namespace: 'Namespace Prefix',
|
1544 | name: 'Name',
|
1545 | id: 'Id',
|
1546 | package2Id: 'Subscriber Package2 Id',
|
1547 | description: 'Description',
|
1548 | containerOptions: 'Options'
|
1549 | }
|
1550 | },
|
1551 | package2_version_create: {
|
1552 | en_US: {
|
1553 | cliDescription: 'create a second-generation package version',
|
1554 | cliLongDescription: 'Creates a second-generation package (package2) version in the Dev Hub org.',
|
1555 | help: 'The package version is based on the package contents in the specified directory.' +
|
1556 | '\n\nTo retrieve details about a package version create request, including status and package2 version ID (05i), ' +
|
1557 | 'run "sfdx force:package2:version:create:get -i 08c...".' +
|
1558 | '\n\nTo list package version creation requests in the org, run "sfdx force:package2:version:create:list".' +
|
1559 | '\n\nExamples:' +
|
1560 | '\n $ sfdx force:package2:version:create -d common' +
|
1561 | '\n $ sfdx force:package2:version:create -i 0Ho... -d common',
|
1562 | package2Id: 'ID of the parent package (starts with 0Ho)',
|
1563 | longPackage2Id: 'ID of parent package (starts with 0Ho).',
|
1564 | dir: 'path to directory that contains the contents of the package version',
|
1565 | longDir: 'The path to the directory that contains the contents of the package version.',
|
1566 | branch: 'the package version’s branch',
|
1567 | longBranch: 'The package version’s branch.',
|
1568 | tag: 'the package version’s tag',
|
1569 | longTag: 'The package version’s tag.',
|
1570 | key: 'installation key for key-protected package (default: null)',
|
1571 | longKey: 'Installation key for creating the key-protected package. The default is null.',
|
1572 | preserve: 'temp files are preserved that would otherwise be deleted',
|
1573 | longPreserve: 'Specifies that the temp files are preserved that would otherwise be deleted',
|
1574 | validateschema: 'sfdx-project.json is validated against JSON schema',
|
1575 | longValidateschema: 'Specifies that the sfdx-project.json file should be validated against JSON schema',
|
1576 | tempFileLocation: 'The temp files are located at: %s.',
|
1577 | wait: 'minutes to wait for the package version to be created',
|
1578 | longWait: 'The number of minutes to wait for the package version to be created.',
|
1579 | instance: 'the instance where the package version will be created——for example, NA50',
|
1580 | longInstance: 'The instance where the package version will be created——for example, NA50.',
|
1581 | sourceorg: 'the source org ID used to copy the org shape for the build org',
|
1582 | longSourceorg: 'The source org ID used to copy the org shape for the build org.',
|
1583 | InProgress: 'Package2 version creation request is InProgress. Run "sfdx force:package2:version:create:get -i %s" to query for status.',
|
1584 | Queued: 'Package2 version creation request is Queued. Run "sfdx force:package2:version:create:get -i %s" to query for status.',
|
1585 | Success: 'Successfully created the package2 version [%s]. Package2 Version Id: %s. Subscriber Package2 Version Id: %s.' +
|
1586 | '\nPackage Installation URL: %s%s' +
|
1587 | '\nAs an alternative, you can use the "sfdx force:package:install" command.',
|
1588 | errorMissingFlags: 'Include either a %s value or a %s value. The value must match one of the packageDirectories specified in sfdx-project.json.',
|
1589 | errorNoMatchingPackageDirectory: 'The %s value [%s], doesn’t match the %s value in any packageDirectories specified in sfdx-project.json.',
|
1590 | errorDirectoryIdMismatch: 'The %s value, [%s], and %s value, [%s], were both found in sfdx-project.json but don’t match. If you supply both values, they must match the path and id values in one of the packageDirectories.',
|
1591 | errorDependencyPair: 'Dependency must specify either a subscriberPackageVersionId or both packageId and versionNumber: %s.',
|
1592 | errorNoIdInHub: 'No package2 ID was found in Dev Hub for package2 ID: %s.',
|
1593 | errorEmptyPackageDirs: 'sfdx-project.json must contain a packageDirectories entry for a package. It has no entries, currently.',
|
1594 | unknownError: 'Package2 version creation failed with unknown error.',
|
1595 | undefinedStatus: 'Package2 version creation returned with status: %s.'
|
1596 | }
|
1597 | },
|
1598 | package2_version_create_list: {
|
1599 | en_US: {
|
1600 | cliDescription: 'list package version creation requests',
|
1601 | cliLongDescription: 'Lists all requests to create second-generation package (package2) versions in the Dev Hub org.',
|
1602 | statusDescription: 'filter the list by version creation request status',
|
1603 | statusLongDescription: 'Filters the list based on the status of version creation requests.',
|
1604 | help: "Shows the details of each request to create a package2 version that's run in the Dev Hub org." +
|
1605 | '\n\nAll filter parameters are applied using the AND logical operator (not OR).' +
|
1606 | '\n\nTo get information about a specific request, run "sfdx force:package2:version:create:get" and supply the request ID.' +
|
1607 | '\n\nExamples:' +
|
1608 | '\n $ sfdx force:package2:version:create:list' +
|
1609 | '\n $ sfdx force:package2:version:create:list --createdlastdays 3' +
|
1610 | '\n $ sfdx force:package2:version:create:list --status Error' +
|
1611 | '\n $ sfdx force:package2:version:create:list -s InProgress' +
|
1612 | '\n $ sfdx force:package2:version:create:list -c 3 -s Success',
|
1613 | id: 'ID',
|
1614 | status: 'Status',
|
1615 | package2Id: 'Package2 Id',
|
1616 | package2VersionId: 'Package2 Version Id',
|
1617 | subscriberPackageVersionId: 'Subscriber Package2 Version Id',
|
1618 | branch: 'Branch',
|
1619 | tag: 'Tag',
|
1620 | installUrl: 'Installation URL'
|
1621 | }
|
1622 | },
|
1623 | package2_version_create_get: {
|
1624 | en_US: {
|
1625 | cliDescription: 'retrieve a package version creation request',
|
1626 | cliLongDescription: 'Retrieves a second-generation package version creation request in the Dev Hub org.',
|
1627 | help: 'Specify the request ID for which you want to view details. ' +
|
1628 | 'If applicable, the command displays errors related to the request.' +
|
1629 | '\n\nExamples:' +
|
1630 | '\n $ sfdx force:package2:version:create:get --package2createrequestid 08c...' +
|
1631 | '\n\nTo show all requests in the org, run "sfdx force:package2:version:create:list".',
|
1632 | requestId: 'package2 version creation request ID (starts with 08c)',
|
1633 | requestIdLong: 'The ID of the package2 version creation request you want to display.',
|
1634 | error: 'Error',
|
1635 | truncatedErrors: '...\n\nTo see all errors, run: sfdx force:data:soql:query -t -q "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id =\'%s\'"\n'
|
1636 | }
|
1637 | },
|
1638 | package2_version_update: {
|
1639 | en_US: {
|
1640 | cliDescription: 'update a second-generation package version',
|
1641 | cliLongDescription: 'Updates a second-generation package version in the Dev Hub org.',
|
1642 | help: 'Specify a new value for each option you want to update.' +
|
1643 | '\n\nExamples:' +
|
1644 | '\n $ sfdx force:package2:version:update --package2versionid 05i... --setasreleased' +
|
1645 | "\n $ sfdx force:package2:version:update -i 05i... -b master -t 'Release 1.0.7'" +
|
1646 | '\n\nTo display details about a package2 version, run "sfdx force:package2:version:get".',
|
1647 | id: 'the package version ID (starts wtih 05i)',
|
1648 | idLong: 'The package version ID (starts with 05i).',
|
1649 | name: 'the package version name',
|
1650 | nameLong: 'The package version name.',
|
1651 | description: 'the package version description',
|
1652 | descriptionLong: 'The second-generation package version description.',
|
1653 | branch: 'the package version branch',
|
1654 | branchLong: 'The second-generation package version branch.',
|
1655 | tag: 'the package version tag',
|
1656 | tagLong: 'The second-generation package version tag.',
|
1657 | key: 'installation key for key-protected package (default: null)',
|
1658 | longKey: 'Installation key for creating the key-protected package. The default is null.',
|
1659 | setasreleased: 'set the package version as released (can’t be undone)',
|
1660 | setasreleasedLong: 'Sets the second-generation package version as released. Second-generation packages can’t be changed to ' +
|
1661 | 'beta after they’ve been released.',
|
1662 | setasreleasedForce: 'no prompt to confirm setting the package version as released',
|
1663 | setasreleasedForceLong: 'No prompt to confirm setting the package version as released.',
|
1664 | humanSuccess: 'Successfully updated the package version. ID: %s.',
|
1665 | previousReleased: 'To release the new package2 version, run "sfdx force:package2:version:update -s <new package2 version ID>".'
|
1666 | }
|
1667 | },
|
1668 | package2_version_get: {
|
1669 | en_US: {
|
1670 | cliDescription: 'retrieve a package version in the Dev Hub org',
|
1671 | cliLongDescription: 'Retrieves a package version in the Dev Hub org.',
|
1672 | help: 'Examples:' +
|
1673 | '\n $ sfdx force:package2:version:get --package2versionid 05i...' +
|
1674 | '\n\nTo update package version values, run "sfdx force:package2:version:update".'
|
1675 | }
|
1676 | },
|
1677 | package2_version_list: {
|
1678 | en_US: {
|
1679 | cliDescription: 'list all package versions in the Dev Hub org',
|
1680 | cliLongDescription: 'Lists all package2 versions in the Dev Hub org.',
|
1681 | conciseDescription: 'display limited package2 version details',
|
1682 | conciseLongDescription: 'Displays limited package2 version details.',
|
1683 | package2IdsDescription: 'filter results on specified comma-delimited package2 ids (start with 0Ho)',
|
1684 | package2IdsLongDescription: 'Filters results on the specified comma-delimited package2 IDs (start with 0Ho).',
|
1685 | releasedDescription: 'display released versions only',
|
1686 | releasedLongDescription: 'Displays released versions only (IsReleased=true).',
|
1687 | orderByDescription: 'order by the specified package2 version fields',
|
1688 | orderByLongDescription: 'Orders the list by the specified package2 version fields.',
|
1689 | verboseDescription: 'display extended package2 versions detail',
|
1690 | verboseLongDescription: 'Display extended package2 versions detail.',
|
1691 | help: 'Displays details of each package2 version in the org.' +
|
1692 | '\n\nUse --concise or --verbose to display limited or additional details, respectively.' +
|
1693 | '\n\nAll filter parameters are applied using the AND logical operator (not OR).' +
|
1694 | '\n\nExamples:' +
|
1695 | '\n $ sfdx force:package2:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion' +
|
1696 | '\n $ sfdx force:package2:version:list --package2ids 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0' +
|
1697 | '\n $ sfdx force:package2:version:list --released' +
|
1698 | '\n $ sfdx force:package2:version:list --concise --modifiedlastdays 0' +
|
1699 | '\n $ sfdx force:package2:version:list --concise -c 3 -r',
|
1700 | name: 'Name',
|
1701 | description: 'Description',
|
1702 | version: 'Version',
|
1703 | id: 'Package2 Version Id',
|
1704 | subscriberPackageVersionId: 'Subscriber Package2 Version Id',
|
1705 | package2Id: 'Package2 Id',
|
1706 | package2Branch: 'Branch',
|
1707 | package2Tag: 'Tag',
|
1708 | installUrl: 'Installation URL'
|
1709 | }
|
1710 | },
|
1711 |
|
1712 | signup: {
|
1713 | en_US: {
|
1714 | quantifiedFeatureWithoutQuantityWarning: "The feature %s will be deprecated in a future release. It's been replaced by %s:<value>, which requires you to specify a quantity.",
|
1715 | deprecatedFeatureWarning: 'The feature %s has been deprecated. It has been removed from the list of requested features.',
|
1716 | mappedFeatureWarning: 'The feature %s has been deprecated. It has been replaced with %s in this scratch org create request.',
|
1717 | INVALID_ID_FIELD: 'Provide a valid template ID, in the format 0TTxxxxxxxxxxxx.',
|
1718 | 'T-0002': 'We couldn’t find a template or snapshot with the ID or name specified in the scratch org definition. If you’re sure the ID is correct, contact Salesforce Support.',
|
1719 | 'T-0003': 'The template specified in the scratch org definition is unapproved. Contact Salesforce Support to request template approval.',
|
1720 | 'S-1006': 'Provide a valid email address in your scratch org definition or your %s file.',
|
1721 | 'S-2006': 'Provide a valid country code in your scratch org definition or your %s file.',
|
1722 | 'S-1017': 'Specify a namespace that’s used by a release org associated with your Dev Hub org.',
|
1723 | 'S-1018': 'Provide a valid My Domain value. This value can’t include double hyphens, end in a hyphen, include restricted words, or be more than 40 characters long.',
|
1724 | 'S-1019': 'The My Domain value you chose is already in use.',
|
1725 | 'S-1026': 'Provide a valid namespace value. This value must begin with a letter. It can’t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed.',
|
1726 | 'S-9999': 'A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance.',
|
1727 | 'C-1007': "The username provided to the org:create command is already in use. Run 'force:org:list --clean' to remove stale org authentications or create the org with a different username.",
|
1728 | 'C-1015': 'We encountered a problem while registering your My Domain value with the DNS provider. Please try again.',
|
1729 | 'C-1016': 'We encountered a problem while attempting to configure and approve the Connected App for your org. Verify the Connected App configuration with your Salesforce admin.',
|
1730 | 'C-1017': 'Provide a valid namespace prefix. This value must begin with a letter. It can’t include consecutive underscores, end in an underscore, be more than 15 characters long, or be a restricted or reserved namespace. Only alphanumeric characters and underscores are allowed.',
|
1731 | 'C-1020': "We couldn't find a template with the ID specified in the scratch org definition. If you’re sure the ID is correct, contact Salesforce Support.",
|
1732 | 'C-1027': 'The template specified in the Scratch Definition isn’t supported. Specify a generic edition (such as Developer or Enterprise), or specify a template ID.',
|
1733 | 'C-9999': 'A fatal signup error occurred. Please try again. If you still see this error, contact Salesforce Support for assistance.',
|
1734 | MyDomainResolverTimeoutError: 'Successfully created org with ID: %s and name: %s. However, the My Domain URL %s has not finished propagating. Some commands may not work as expected until the My Domain DNS propagation is complete.',
|
1735 | SourceStatusResetFailure: 'Successfully created org with ID: %s and name: %s. Unfortunately, source tracking isn’t working as expected. If you run force:source:status, the results may be incorrect. Try again by creating another scratch org.'
|
1736 | }
|
1737 | },
|
1738 | generatePassword: {
|
1739 | en_US: {
|
1740 | description: 'generate a password for scratch org users',
|
1741 | longDescription: 'Generates a password for scratch org users. Targets the usernames listed with the --onbehalfof parameter ' +
|
1742 | 'or the --targetusername parameter. Defaults to the defaultusername.',
|
1743 | help: 'Generates and sets a random password for one or more scratch org users.' +
|
1744 | `${os.EOL}${os.EOL}If you haven’t set a default Dev Hub, or if your scratch org isn’t associated with your default Dev Hub, ` +
|
1745 | '--targetdevhubusername is required.' +
|
1746 | `${os.EOL}${os.EOL}To see a password that was previously generated, run "sfdx force:user:display".` +
|
1747 | `${os.EOL}${os.EOL}Examples:` +
|
1748 | `${os.EOL} $ sfdx force:user:password:generate` +
|
1749 | `${os.EOL} $ sfdx force:user:password:generate -u me@my.org --json` +
|
1750 | `${os.EOL} $ sfdx force:user:password:generate -o user1@my.org,user2@my.org,user3@my.org`,
|
1751 | onbehalfofParam: 'comma-separated list of usernames for which to generate passwords',
|
1752 | onbehalfofParamLong: 'A comma-separated list of usernames for which to generate passwords.',
|
1753 | noOrgProvided: 'Please specify the org for the user(s)',
|
1754 | notFoundOnDevHub: 'The scratch org does not belong to the dev hub username %s.',
|
1755 | userNotFound: 'The username "%s" was not found for scratch org %s',
|
1756 | usersNotFound: 'The usernames "%s" were not found for scratch org %s',
|
1757 | notADevHub: 'The provided dev hub username %s is not a valid dev hub.',
|
1758 | action: 'Specify the dev hub username that the scratch org belongs to with --targetdevhubusername or set a default run "sfdx force:config:set defaultdevhubusername=<username>".',
|
1759 | success: 'Successfully set the password "%s" for user %s.',
|
1760 | successMultiple: `Successfully set passwords:${os.EOL}`,
|
1761 | viewWithCommand: 'You can see the password again by running "sfdx force:user:display -u %s".',
|
1762 | noSelfSetAction: 'Create a scratch org with the SelfSetPasswordInApi org preference enabled and try again.'
|
1763 | }
|
1764 | },
|
1765 | user_create: {
|
1766 | en_US: {
|
1767 | description: 'create a user for a scratch org',
|
1768 | longDescription: 'Creates a user for a scratch org.',
|
1769 | help: 'Create a user for a scratch org, optionally setting an alias for use by the CLI, ' +
|
1770 | 'assigning permission sets (e.g., permsets=ps1,ps2), generating a password (e.g., generatepassword=true), ' +
|
1771 | 'and setting User sObject fields.' +
|
1772 | `${os.EOL}${os.EOL}Examples:` +
|
1773 | `${os.EOL} $ sfdx force:user:create` +
|
1774 | `${os.EOL} $ sfdx force:user:create -a testuser1 -f config/project-user-def.json` +
|
1775 | `${os.EOL} $ sfdx force:user:create username=testuser1@my.org email=me@my.org permsets=DreamHouse` +
|
1776 | `${os.EOL} $ sfdx force:user:create -f config/project-user-def.json email=me@my.org generatepassword=true`,
|
1777 | definitionfileParam: 'file path to a user definition',
|
1778 | definitionfileParamLong: 'File path to a user definition.',
|
1779 | setaliasParam: 'set an alias for the created username to reference within the CLI',
|
1780 | setaliasParamLong: 'Sets an alias for the created username to reference within the CLI.',
|
1781 | noOrgProvided: 'Please specify the org where the user should be created.',
|
1782 | userNotCreated: 'User must be created before %s',
|
1783 | licenseLimitExceeded: 'There are no available user licenses for the user profile "%s".',
|
1784 | duplicateUsername: 'The username "%s" already exists in this or another Salesforce org. Usernames must be unique across all Salesforce orgs.',
|
1785 | profileNameNotFound: 'Profile name "%s" not found in target org. Do you need to push source?',
|
1786 | success: `Successfully created user "%s" with ID [%s] for org %s.${os.EOL}You can see more details about this user by running "sfdx force:user:display -u %s".`
|
1787 | }
|
1788 | },
|
1789 | user_list: {
|
1790 | en_US: {
|
1791 | description: 'lists all users of a scratch org',
|
1792 | longDescription: 'Lists all users of a scratch org that the Salesforce CLI has created or authenticated.',
|
1793 | help: 'The original scratch org admin is marked with "(A)"' +
|
1794 | `${os.EOL}Examples:` +
|
1795 | `${os.EOL} $ sfdx force:user:list` +
|
1796 | `${os.EOL} $ sfdx force:user:list -u me@my.org --json` +
|
1797 | `${os.EOL} $ sfdx force:user:list --json > tmp/MyUserList.json`,
|
1798 | noOrgProvided: 'Please specify the target org of the users to list via the --targetusername flag or setting a default username.',
|
1799 | usersInOrg: 'Users in org %s'
|
1800 | }
|
1801 | },
|
1802 | user_display: {
|
1803 | en_US: {
|
1804 | description: 'displays information about a user of a scratch org',
|
1805 | longDescription: 'Displays information about a user of a scratch org that the Salesforce CLI has created or authenticated.',
|
1806 | help: 'Output includes the profile name, org ID, access token, instance URL, login URL, and alias if applicable.' +
|
1807 | `${os.EOL}Examples:` +
|
1808 | `${os.EOL} $ sfdx force:user:display` +
|
1809 | `${os.EOL} $ sfdx force:user:display -u me@my.org --json`,
|
1810 | noOrgProvided: 'Please specify the user to display via the --targetusername flag or setting a default username.'
|
1811 | }
|
1812 | },
|
1813 | source: {
|
1814 | en_US: {
|
1815 | description: 'sync your project with your orgs',
|
1816 | longDescription: 'Use the source commands to push and pull source to and from your scratch orgs, ' +
|
1817 | 'to deploy and retrieve source to and from non-source-tracked orgs, ' +
|
1818 | 'to see synchronization changes between your project and scratch orgs, and to convert your source ' +
|
1819 | 'to the metadata format for Metadata API deployments.'
|
1820 | }
|
1821 | },
|
1822 | source_convert: {
|
1823 | en_US: {
|
1824 | description: 'convert source into Metadata API format',
|
1825 | longDescription: 'Converts source-formatted files into metadata that you can deploy using Metadata API.',
|
1826 | help: 'To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, ' +
|
1827 | 'run "sfdx force:source:convert". Then deploy the metadata using "sfdx force:mdapi:deploy".' +
|
1828 | '\n\nTo convert Metadata API–formatted files into the source format, run "sfdx force:mdapi:convert".' +
|
1829 | '\n\nTo specify a package name that includes spaces, enclose the name in single quotes.' +
|
1830 | '\n\nExamples:' +
|
1831 | '\n $ sfdx force:source:convert -r path/to/source' +
|
1832 | "\n $ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package'",
|
1833 | rootParam: 'a source directory other than the default package to convert',
|
1834 | rootParamLongDescription: 'A directory other than the default package directory that contains the source-formatted files to convert.',
|
1835 | outputDirectoryParam: 'output directory to store the Metadata API–formatted files in',
|
1836 | outputDirectoryParamLongDescription: 'The output directory to store the Metadata API–formatted metadata files in.',
|
1837 | packageNameParam: 'name of the package to associate with the metadata-formatted files',
|
1838 | packageNameParamLongDescription: 'The name of the package to associate with the metadata-formatted files.',
|
1839 | manifestLongDescription: 'The complete path to the manifest (package.xml) file that specifies the metadata types to convert.' +
|
1840 | '\nIf you specify this parameter, don’t specify --metadata or --sourcepath.',
|
1841 | manifestDescription: 'file path to manifest (package.xml) of metadata types to convert.',
|
1842 | sourcePathDescription: 'comma-separated list of paths to the local source files to convert',
|
1843 | sourcePathLongDescription: 'A comma-separated list of paths to the local source files to convert. ' +
|
1844 | 'The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder ' +
|
1845 | '(in which case the operation is applied to all metadata types in the directory and its sub-directories).' +
|
1846 | '\nIf you specify this parameter, don’t specify --manifest or --metadata.',
|
1847 | metadataParamDescription: 'comma-separated list of metadata component names to convert',
|
1848 | metadataParamLongDescription: 'A comma-separated list of metadata component names to convert.'
|
1849 | }
|
1850 | },
|
1851 | sourceConvertCommand: {
|
1852 | en_US: {
|
1853 | success: 'Source was successfully converted to Metadata API format and written to the location: %s',
|
1854 | invalidRootDirectory: 'The package root directory does not exist: %s',
|
1855 | noSourceInRootDirectory: 'The package root directory is empty.',
|
1856 | rootDirectoryNotASourceDirectory: 'The package root directory is not a source directory'
|
1857 | }
|
1858 | },
|
1859 | lightning: {
|
1860 | en_US: {
|
1861 | mainTopicDescriptionHelp: 'create Aura components and Lightning web components, and test Aura components',
|
1862 | mainTopicLongDescriptionHelp: 'Use the lightning commands to create Aura components and Lightning web components ' +
|
1863 | 'and to test Aura components. As of API version 45.0, you can build Lightning components using two programming models: ' +
|
1864 | 'Lightning Web Components, and the original model, Aura Components. Lightning web components and Aura components can ' +
|
1865 | 'coexist and interoperate on a page.'
|
1866 | }
|
1867 | },
|
1868 | lightning_test: {
|
1869 | en_US: {
|
1870 | lightningTestCommandDescription: 'invoke Aura component tests',
|
1871 | lightningTestCommandDescriptionLong: 'Runs Aura component tests. The Lightning Testing Service (LTS) ' +
|
1872 | 'unmanaged package must be installed in your org. For details, see the LTS documentation.',
|
1873 | lightningTestCommandParamAppName: 'name of your Lightning test application',
|
1874 | lightningTestCommandParamAppNameLong: 'Name of your Lightning test application. The name is case insensitive, ' +
|
1875 | 'and ".app" is optional, so "Test" and "test.app" are equivalent.' +
|
1876 | '\nDefault value: Test.app',
|
1877 | lightningCommandParamTestArtifactDir: 'directory path to store test run artifacts: for example, log files and test results',
|
1878 | lightningCommandParamTestArtifactDirLong: 'Directory path to store test run artifacts: log files, test results, and so on.',
|
1879 | lightningTestCommandParamReporter: 'test result format emitted to stdout; --json flag overrides this parameter',
|
1880 | lightningTestCommandParamReporterLong: 'Format to use when displaying test results. If you also specify the --json ' +
|
1881 | 'flag, --json overrides this parameter.',
|
1882 | lightningTestCommandParamConfig: 'path to config file for the test',
|
1883 | lightningTestCommandParamConfigLong: 'Path to a test configuration file to configure WebDriver and other settings. ' +
|
1884 | 'For details, see the LTS documentation.',
|
1885 | lightningTestCommandParamLeaveBrowserOpen: 'leave browser open',
|
1886 | lightningTestCommandParamLeaveBrowserOpenLong: 'Leaves browser open after the test finishes so that you can view ' + 'the test suite results.',
|
1887 | lightningTestCommandParamTimeout: 'time (ms) to wait for results element in dom',
|
1888 | lightningTestCommandParamTimeoutLong: 'Time, in milliseconds, to wait for the results element to be present in the DOM, ' +
|
1889 | 'before failing and moving on to the next test.',
|
1890 | lightningTestCommandHelp: 'Examples:' +
|
1891 | '\n $ sfdx force:lightning:test:run' +
|
1892 | '\n $ sfdx force:lightning:test:run -a tests -r human' +
|
1893 | '\n $ sfdx force:lightning:test:run -f config/myConfigFile.json -d testResultFolder',
|
1894 | lightningTestInvalidReporter: 'Unknown result format type. Must be one of the following values: %s',
|
1895 | lightningTestResultRetrievalFailed: 'Unable to get test results: %s',
|
1896 | lightningTestBrowserError: 'Something went wrong with the test app: %s',
|
1897 | lightningTestInstallCommandDescription: 'install Lightning Testing Service unmanaged package in your org',
|
1898 | lightningTestInstallCommandDescriptionLong: 'Installs a Lightning Testing Service (LTS) unmanaged package into your org.',
|
1899 | lightningTestInstallCommandParamWait: 'number of minutes to wait for installation status',
|
1900 | lightningTestInstallCommandParamWaitLong: 'Maximum number of minutes to wait for installation status.',
|
1901 | lightningTestInstallCommandParamVersion: 'release version of Lightning Testing Service',
|
1902 | lightningTestInstallCommandParamVersionLong: 'The release version of LTS unmanaged package you want to install.',
|
1903 | lightningTestInstallCommandParamType: "type of unmanaged package. 'full' option contains both jasmine and mocha, plus examples",
|
1904 | lightningTestInstallCommandParamTypeLong: "Type of LTS unmanaged package to install. 'jasmine' and 'mocha' contains the essentials for development, 'full' contains both, and adds sample components and tests in the package. 'full' is best for 'kicking the tires' of LTS.",
|
1905 | lightningTestInstallCommandHelp: 'Examples:' +
|
1906 | '\n $ sfdx force:lightning:test:install' +
|
1907 | '\n $ sfdx force:lightning:test:install -w 0 -r v1.0' +
|
1908 | '\n $ sfdx force:lightning:test:install -t jasmine',
|
1909 | scratchOrgOnly: 'Lightning Testing Service can only run in scratch orgs, because tests can permanently change org data.',
|
1910 | waitNotNumber: 'The value specified for wait argument, %s, is not a number.',
|
1911 | invalidType: 'The value specified for type argument, %s, is invalid.',
|
1912 | invalidVersion: "Release tag %s doesn't exist. For the list of available releases, go to https://github.com/forcedotcom/LightningTestingService/releases.",
|
1913 | packageIdRetrievalIssue: 'An error occurred trying to reach %s to retrieve the LTS package ID. See the debug log for details.',
|
1914 | packageIdExtractionIssue: 'Unable to extract a package ID from the response from %s. See the debug log for details.',
|
1915 | testRunError: 'Something went wrong with the test run. It might be an environmental or configuration issue.' +
|
1916 | '\nError Message: %s'
|
1917 | }
|
1918 | },
|
1919 | limits: {
|
1920 | en_US: {
|
1921 | mainTopicDescriptionHelp: 'view your org’s limits',
|
1922 | mainTopicLongDescriptionHelp: 'Use the limits commands to view your org’s limits ' + 'and how close you are to reaching them.'
|
1923 | }
|
1924 | },
|
1925 | schema: {
|
1926 | en_US: {
|
1927 | mainTopicDescriptionHelp: 'view standard and custom objects',
|
1928 | mainTopicLongDescriptionHelp: 'Use the schema commands to view information about the ' + 'standard and custom objects in your org.'
|
1929 | }
|
1930 | },
|
1931 | visualforce: {
|
1932 | en_US: {
|
1933 | mainTopicDescriptionHelp: 'create and edit Visualforce files',
|
1934 | mainTopicLongDescriptionHelp: 'Use the visualforce commands to create Visualforce pages and components.'
|
1935 | }
|
1936 | },
|
1937 | project: {
|
1938 | en_US: {
|
1939 | mainTopicDescriptionHelp: 'set up a Salesforce DX project',
|
1940 | mainTopicLongDescriptionHelp: 'Use the project commands to set up a Salesforce DX project.'
|
1941 | }
|
1942 | },
|
1943 | projectUpgrade: {
|
1944 | en_US: {
|
1945 | commandDescription: 'update project config files to the latest format',
|
1946 | commandDescriptionLong: 'Updates project configuration and definition files to the latest format.',
|
1947 | commandHelp: 'Examples:' + '\n $ sfdx force:project:upgrade' + '\n $ sfdx force:project:upgrade -f',
|
1948 | forceOption: 'run all upgrades even if project has already been upgraded',
|
1949 | forceOptionLong: 'Run all upgrades, even if the project definition files have already been upgraded.',
|
1950 | error_validProject: 'Need a valid project to upgrade',
|
1951 | error_upgradeFailed: 'Failed to upgrade: %s',
|
1952 | prompt_renameProjectFile: 'Found old project file in %s. To continue upgrade, you must rename it to %s. Would you like to continue (yes/no)?',
|
1953 | prompt_queuedActions: 'Found %s project update(s) to perform. Do you want to continue (list/yes/no)?',
|
1954 | prompt_continue: 'Do you want to continue (yes/no)?',
|
1955 | prompt_orgDefPattern: 'Check for old org definition files in the "config" directory using the pattern "config/*def.json" by entering "D" or "DEFAULT". Otherwise, enter the pattern to find your org definition files, such as "orgs/my-org-*def.json". To skip conversion of org definition files, enter "SKIP".',
|
1956 | skipping: 'Skipping %s upgrades.',
|
1957 | uptodate: 'Your project is up to date.',
|
1958 | action_orgDefConversion: 'Upgrade %s org definition files to new format.',
|
1959 | action_headsDownProject: 'Upgrade %s to headsDownCamelCase',
|
1960 | action_removeUseDecomposition: 'Remove useDecomposition from %s'
|
1961 | }
|
1962 | },
|
1963 | org_shape: {
|
1964 | en_US: {
|
1965 | create_shape_command_description: 'create a snapshot of org edition, features, and licenses',
|
1966 | create_shape_command_description_long: 'Creates a snapshot of org edition, features, and licenses to use for scratch org creation, ' +
|
1967 | 'allowing your scratch org to look like another org for testing.',
|
1968 | create_shape_command_help: 'Examples:' +
|
1969 | '\n $ sfdx force:org:shape:create -u me@my.org' +
|
1970 | '\n $ sfdx force:org:shape:create -u me@my.org --json --loglevel debug',
|
1971 | create_shape_command_username: 'a username or alias for the target org',
|
1972 | create_shape_command_username_long: 'Username or alias of the previously authorized org from which you want to create an org shape.',
|
1973 | create_shape_command_no_access: 'The org needs to be enabled for org shape before one can be created.',
|
1974 | create_shape_command_success: 'Successfully enqueued ShapeRepresentation creation for ID %s.'
|
1975 | }
|
1976 | },
|
1977 | orgSnapshot: {
|
1978 | en_US: {
|
1979 | createSnapshotCmdDescription: 'snapshot a scratch org',
|
1980 | createSnapshotCmdDescriptionLong: 'Creates a snapshot of a scratch org.',
|
1981 | createSnapshotCmdHelp: 'A snapshot is a point-in-time export of a scratch org. The export is stored in Salesforce ' +
|
1982 | 'and referenced by its unique name in a scratch definition file.' +
|
1983 | '\n\nUse "sfdx force:org:snapshot:get" to get details, including status, about a snapshot creation request.' +
|
1984 | '\n\nWith "snapshot" in your scratch org definition file, use "sfdx force:org:create" to create a scratch org from a snapshot.' +
|
1985 | '\n\nExamples:' +
|
1986 | '\n\n $ sfdx force:org:snapshot:create --sourceorg 00Dxx0000000000 --snapshotname Dependencies --description "Contains PackageA v1.1.0"' +
|
1987 | '\n\n $ sfdx force:org:snapshot:create -o myuser@myorg -n NightlyBranch -d "Contains PkgA v2.1.0 and PkgB 3.3.0"',
|
1988 | createSnapshotCmdSourceOrgDescription: 'ID or locally authenticated username or alias of scratch org to snapshot',
|
1989 | createSnapshotCmdSourceOrgDescriptionLong: 'The org ID, or a locally authenticated username or alias, of the scratch org to snapshot.',
|
1990 | createSnapshotCmdNameDescription: 'unique name of snapshot',
|
1991 | createSnapshotCmdNameDescriptionLong: 'The unique name of the snapshot. Use this name to create scratch orgs from the snapshot.',
|
1992 | createSnapshotCmdDescriptionDescription: 'description of snapshot',
|
1993 | createSnapshotCmdDescriptionDescriptionLong: 'A description of the snapshot. Use this description to document the contents ' +
|
1994 | 'of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.',
|
1995 | getSnapshotCmdDescription: 'get details about a scratch org snapshot',
|
1996 | getSnapshotCmdDescriptionLong: 'Retrieves details about a scratch org snapshot.',
|
1997 | getSnapshotCmdHelp: 'Use "sfdx force:org:snapshot:create" to create a snapshot.' +
|
1998 | '\n\nUse "sfdx force:org:snapshot:list" to retrieve all snapshots.' +
|
1999 | '\n\nExamples:' +
|
2000 | '\n\n $ sfdx force:org:snapshot:get --snapshot 0Oo...' +
|
2001 | '\n\n $ sfdx force:org:snapshot:get -s Dependencies',
|
2002 | getSnapshotCmdSnapshotDescription: 'name or ID of snapshot to retrieve',
|
2003 | getSnapshotCmdSnapshotDescriptionLong: 'The name or ID (starts with 0Oo) of the snapshot to retrieve.',
|
2004 | listSnapshotCmdDescription: 'list scratch org snapshots',
|
2005 | listSnapshotCmdDescriptionLong: 'Lists scratch org snapshots for your Dev Hub.',
|
2006 | listSnapshotCmdHelp: 'Use "sfdx force:org:snapshot:get" to get details about a snapshot request.' +
|
2007 | '\n\nUse "sfdx force:org:snapshot:create" to create a snapshot.' +
|
2008 | '\n\nExamples:' +
|
2009 | '\n\n $ sfdx force:org:snapshot:list' +
|
2010 | '\n\n $ sfdx force:org:snapshot:list -v OtherDevHub@example.com',
|
2011 | deleteSnapshotCmdDescription: 'delete a scratch org snapshot',
|
2012 | deleteSnapshotCmdDescriptionLong: 'Deletes a scratch org snapshot.',
|
2013 | deleteSnapshotCmdHelp: 'Examples:' +
|
2014 | '\n\n $ sfdx force:org:snapshot:delete --snapshot 0Oo...' +
|
2015 | '\n\n $ sfdx force:org:snapshot:delete -s BaseSnapshot',
|
2016 | deleteSnapshotCmdSnapshotDescription: 'name or ID of snapshot to delete',
|
2017 | deleteSnapshotCmdSnapshotDescriptionLong: 'The name or ID (starts with 0Oo) of the snapshot to delete.',
|
2018 | snapshotNotEnabled: 'Org snapshots aren’t enabled for your Dev Hub.',
|
2019 | sourceOrgInvalid: 'Provide a valid name or ID for your source org.',
|
2020 | nameInvalid: 'Provide a valid name for your snapshot.',
|
2021 | snapshotInvalid: 'Provide a valid name or ID for your snapshot.',
|
2022 | unsupportedSnapshotOrgCreateOptions: 'Org snapshots don’t support one or more options you specified: %s'
|
2023 | }
|
2024 | }
|
2025 | };
|
2026 | const _getLocale = function () {
|
2027 | return 'en_US';
|
2028 | };
|
2029 | module.exports = function (locale = _getLocale()) {
|
2030 | return {
|
2031 | getMessage(label, args, bundle = 'default') {
|
2032 | const bundleLocale = messages[bundle][locale];
|
2033 | if (util.isNullOrUndefined(bundleLocale)) {
|
2034 | return null;
|
2035 | }
|
2036 | if (util.isNullOrUndefined(bundleLocale[label])) {
|
2037 | throw new Error(util.format(bundleLocale.UndefinedLocalizationLabel, bundle, label, locale));
|
2038 | }
|
2039 | if (util.isNullOrUndefined(args)) {
|
2040 | return bundleLocale[label];
|
2041 | }
|
2042 | else {
|
2043 | if (!ts_types_1.isArray(args))
|
2044 | args = [args];
|
2045 | const everyone = [].concat(bundleLocale[label], args);
|
2046 |
|
2047 | return util.format(...everyone);
|
2048 | }
|
2049 | },
|
2050 | getLocale() {
|
2051 | return _getLocale();
|
2052 | },
|
2053 | get targetusername() {
|
2054 | return TARGET_USERNAME_PARAM;
|
2055 | },
|
2056 | get perflog() {
|
2057 | return PERF_LOG_LEVEL_PARAM;
|
2058 | }
|
2059 | };
|
2060 | };
|
2061 |
|
2062 |
|