@salesforce/plugin-limits 3.1.15 → 3.2.1

package/README.md

@@ -70,8 +70,93 @@ sfdx plugins
 
 <!-- commands -->
 
-# Command Topics
+- [`sf org list limits`](#sf-org-list-limits)
+- [`sf org list sobject record-counts`](#sf-org-list-sobject-record-counts)
 
-- [`sf org`](docs/org.md)
+## `sf org list limits`
+
+Display information about limits in your org.
+
+```
+USAGE
+  $ sf org list limits -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
+
+FLAGS
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Display information about limits in your 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.
+
+ALIASES
+  $ sf force limits api display
+  $ sf limits api display
+
+EXAMPLES
+  Display limits in your default org:
+
+    $ sf org list limits
+
+  Display limits in the org with alias "my-scratch-org":
+
+    $ sf org list limits --target-org my-scratch-org
+```
+
+_See code: [src/commands/org/list/limits.ts](https://github.com/salesforcecli/plugin-limits/blob/3.2.1/src/commands/org/list/limits.ts)_
+
+## `sf org list sobject record-counts`
+
+Display record counts for the specified standard or custom objects.
+
+```
+USAGE
+  $ sf org list sobject record-counts -o <value> [--json] [--flags-dir <value>] [-s <value>] [--api-version <value>]
+
+FLAGS
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+  -s, --sobject=<value>...   [default: ] API name of the standard or custom object for which to display record counts.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Display record counts for the specified standard or custom objects.
+
+  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.
+
+ALIASES
+  $ sf force limits recordcounts display
+  $ sf limits recordcounts display
+
+EXAMPLES
+  Display all available record counts in your default org:
+
+    $ sf org list sobject record-counts
+
+  Display record counts for the Account, Contact, Lead, and Opportunity objects in your default org:
+
+    $ sf org list sobject record-counts --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":
+
+    $ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
+```
+
+_See code: [src/commands/org/list/sobject/record-counts.ts](https://github.com/salesforcecli/plugin-limits/blob/3.2.1/src/commands/org/list/sobject/record-counts.ts)_
 
 <!-- commandsstop -->