@salesforce/plugin-limits 3.1.13 → 3.1.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -70,91 +70,8 @@ sfdx plugins
70
70
 
71
71
  <!-- commands -->
72
72
 
73
- - [`sf org list limits`](#sf-org-list-limits)
74
- - [`sf org list sobject record-counts`](#sf-org-list-sobject-record-counts)
73
+ # Command Topics
75
74
 
76
- ## `sf org list limits`
77
-
78
- Display information about limits in your org.
79
-
80
- ```
81
- USAGE
82
- $ sf org list limits -o <value> [--json] [--api-version <value>]
83
-
84
- FLAGS
85
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
86
- configuration variable is already set.
87
- --api-version=<value> Override the api version used for api requests made by this command
88
-
89
- GLOBAL FLAGS
90
- --json Format output as json.
91
-
92
- DESCRIPTION
93
- Display information about limits in your org.
94
-
95
- For each limit, this command returns the maximum allocation and the remaining allocation based on usage. See this
96
- topic for a description of each limit:
97
- https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm.
98
-
99
- ALIASES
100
- $ sf force limits api display
101
- $ sf limits api display
102
-
103
- EXAMPLES
104
- Display limits in your default org:
105
-
106
- $ sf org list limits
107
-
108
- Display limits in the org with alias "my-scratch-org":
109
-
110
- $ sf org list limits --target-org my-scratch-org
111
- ```
112
-
113
- _See code: [src/commands/org/list/limits.ts](https://github.com/salesforcecli/plugin-limits/blob/3.1.13/src/commands/org/list/limits.ts)_
114
-
115
- ## `sf org list sobject record-counts`
116
-
117
- Display record counts for the specified standard or custom objects.
118
-
119
- ```
120
- USAGE
121
- $ sf org list sobject record-counts -o <value> [--json] [-s <value>] [--api-version <value>]
122
-
123
- FLAGS
124
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
125
- configuration variable is already set.
126
- -s, --sobject=<value>... [default: ] API name of the standard or custom object for which to display record counts.
127
- --api-version=<value> Override the api version used for api requests made by this command
128
-
129
- GLOBAL FLAGS
130
- --json Format output as json.
131
-
132
- DESCRIPTION
133
- Display record counts for the specified standard or custom objects.
134
-
135
- Use this command to get an approximate count of the records in standard or custom objects in your org. These record
136
- counts are the same as the counts listed in the Storage Usage page in the Setup UI. The record counts are approximate
137
- because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all
138
- available record counts, run the command without the --sobject flag.
139
-
140
- ALIASES
141
- $ sf force limits recordcounts display
142
- $ sf limits recordcounts display
143
-
144
- EXAMPLES
145
- Display all available record counts in your default org:
146
-
147
- $ sf org list sobject record-counts
148
-
149
- Display record counts for the Account, Contact, Lead, and Opportunity objects in your default org:
150
-
151
- $ sf org list sobject record-counts --sobject Account --sobject Contact --sobject Lead --sobject Opportunity
152
-
153
- Display record counts for the Account and Lead objects for the org with alias "my-scratch-org":
154
-
155
- $ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
156
- ```
157
-
158
- _See code: [src/commands/org/list/sobject/record-counts.ts](https://github.com/salesforcecli/plugin-limits/blob/3.1.13/src/commands/org/list/sobject/record-counts.ts)_
75
+ - [`sf org`](docs/org.md)
159
76
 
160
77
  <!-- commandsstop -->