limits Commands (Deprecated)

Display current org’s limits.

force:limits:api:display (Deprecated)

Display current org’s limits.

This command is deprecated. As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

Don't worry, this command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style org list limits command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
Changed flag name: Old name --apiversion. New name: --api-version.
Changed flag name: Old name --targetusername. New name: --target-org, with new short name -o.

For background information about this change, read this blog post, which describes how we've updated many of the existing sfdx commands to use the improvements we made in sf. We improved this particular command on January 12, 2023.

Warning

Help for force:limits:api:display

When you execute this command in a project, it provides limit information for your default scratch org.

Examples for force:limits:api:display

1sfdx force:limits:api:display

1sfdx force:limits:api:display -u me@my.org

Command Syntax

sfdx force:limits:api:display: [--json]; [--loglevel LOGLEVEL]; [-u TARGETUSERNAME]; [--apiversion APIVERSION]

Parameters

--json: Optional; Format output as JSON.; Type: boolean
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.; Type: enum; Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL; Default value: warn
-u | --targetusername TARGETUSERNAME: Optional; A username or alias for the target org. Overrides the default target org.; Type: string
--apiversion APIVERSION: Optional; Override the API version used for API requests made by this command.; Type: string

force:limits:recordcounts:display (Deprecated)

Display record counts for the specified standard and custom objects.

Don't worry, this command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style org list sobject record-counts command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
Changed flag name: Old name --apiversion. New name: --api-version.
Changed flag name: Old name --targetusername. New name: --target-org, with new short name -o.
Changed flag name: Old name --sobjecttype. New name: --sobject.

Warning

Help for force:limits:recordcounts:display

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 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.

Examples for force:limits:recordcounts:display

1sfdx force:limits:recordcounts:display

1sfdx force:limits:recordcounts:display -s Account,Contact,Lead,Opportunity

1sfdx force:limits:recordcounts:display -s Account,Contact -u me@my.org

Command Syntax

sfdx force:limits:recordcounts:display: [--json]; [--loglevel LOGLEVEL]; [-u TARGETUSERNAME]; [--apiversion APIVERSION]; [-s SOBJECTTYPE]

Parameters

--json: Optional; Format output as JSON.; Type: boolean
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.; Type: enum; Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL; Default value: warn
-u | --targetusername TARGETUSERNAME: Optional; A username or alias for the target org. Overrides the default target org.; Type: string
--apiversion APIVERSION: Optional; Override the API version used for API requests made by this command.; Type: string
-s | --sobjecttype SOBJECTTYPE: Optional; Comma-separated list of API names of standard or custom objects for which to display record counts.; Type: array

Salesforce CLI Command Reference

limits Commands (Deprecated)

force:limits:api:display (Deprecated)

Help for force:limits:api:display

Examples for force:limits:api:display

Command Syntax

Parameters

force:limits:recordcounts:display (Deprecated)

Help for force:limits:recordcounts:display

Examples for force:limits:recordcounts:display

Command Syntax

Parameters