diff --git a/messages/display.md b/messages/display.md index 0b8283f8..7daf2aa2 100644 --- a/messages/display.md +++ b/messages/display.md @@ -1,12 +1,20 @@ +# summary + +Display information about limits in your org. + # description -display current org’s limits -When you execute this command in a project, it provides limit information for your default scratch org.", +For each limit, this command returns the maximum allocation and the remaining allocation based on usage. See this topic for a description of each limit: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm. # examples -- <%= config.bin %> <%= command.id %> -- <%= config.bin %> <%= command.id %> --target-org me@my.org +- Display limits in your default org: + + <%= config.bin %> <%= command.id %> + +- Display limits in the org with alias "my-scratch-org": + + <%= config.bin %> <%= command.id %> --target-org my-scratch-org # targetOrg diff --git a/messages/recordcounts.md b/messages/recordcounts.md index 62f81ba9..33beb41c 100644 --- a/messages/recordcounts.md +++ b/messages/recordcounts.md @@ -1,16 +1,28 @@ +# summary + +Display record counts for the specified standard or custom objects. + # description -display record counts for the specified standard and custom objects\nUse this command to get an approximate count of the records in standard or custom objects in your org. These record counts are the same as the counts listed in the Storage Usage page in Setup. The record counts are approximate because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available record counts, run the command without the '--sobjecttype' parameter.", +Use this command to get an approximate count of the records in standard or custom objects in your org. These record counts are the same as the counts listed in the Storage Usage page in the Setup UI. The record counts are approximate because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available record counts, run the command without the --sobject flag. # examples -- <%= config.bin %> <%= command.id %> -- <%= config.bin %> <%= command.id %> --sobject Account --sobject Contact,Lead,Opportunity -- <%= config.bin %> <%= command.id %> --sobject Account,Contact --target-org me@my.org +- Display all available record counts in your default org: + + <%= config.bin %> <%= command.id %> + +- Display record counts for the Account, Contact, Lead, and Opportunity objects in your default org: + + <%= config.bin %> <%= command.id %> --sobject Account --sobject Contact --sobject Lead --sobject Opportunity + +- Display record counts for the Account and Lead objects for the org with alias "my-scratch-org": + + <%= config.bin %> <%= command.id %> --sobject Account --sobject Lead --target-org my-scratch-org # sobjectFlagDescription -comma-separated list of API names of standard or custom objects for which to display record counts +API name of the standard or custom object for which to display record counts. # targetOrg diff --git a/src/commands/limits/api/display.ts b/src/commands/limits/api/display.ts index 6de5d23b..3be88f6d 100644 --- a/src/commands/limits/api/display.ts +++ b/src/commands/limits/api/display.ts @@ -32,7 +32,7 @@ export type ApiLimits = ApiLimit[]; export class LimitsApiDisplayCommand extends SfCommand { public static aliases = ['force:limits:api:display', 'org:list:limits']; - public static readonly summary = messages.getMessage('description'); + public static readonly summary = messages.getMessage('summary'); public static readonly description = messages.getMessage('description'); public static readonly examples = messages.getMessages('examples'); public static flags = { diff --git a/src/commands/limits/recordcounts/display.ts b/src/commands/limits/recordcounts/display.ts index 709c8ed3..a4a22088 100644 --- a/src/commands/limits/recordcounts/display.ts +++ b/src/commands/limits/recordcounts/display.ts @@ -29,7 +29,7 @@ interface Result { export class LimitsRecordCountsDisplayCommand extends SfCommand { public static readonly aliases = ['force:limits:recordcounts:display', 'org:list:sobject:record-counts']; - public static readonly summary = messages.getMessage('description'); + public static readonly summary = messages.getMessage('summary'); public static readonly description = messages.getMessage('description'); public static readonly examples = messages.getMessages('examples');