@salesforce/plugin-limits

    1.2.1 • Public • Published

    plugin-limits

    NPM CircleCI Downloads/week License

    A command to display the api limits of your org

    This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.

    We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.

    Install

    sfdx plugins:install limits@x.y.z

    Issues

    Please report any issues at https://github.com/forcedotcom/cli/issues

    Contributing

    1. Please read our Code of Conduct
    2. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
    3. Fork this repository.
    4. Build the plugin locally
    5. Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
    6. Edit the code in your fork.
    7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
    8. Sign CLA (see CLA below).
    9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

    CLA

    External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

    Build

    To build the plugin locally, make sure to have yarn installed and run the following commands:

    # Clone the repository
    git clone git@github.com:salesforcecli/plugin-limits
    
    # Install the dependencies and compile
    yarn install
    yarn build

    To use your plugin, run using the local ./bin/run or ./bin/run.cmd file.

    # Run using local run file.
    ./bin/run force:limits

    There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

    # Link your plugin to the sfdx cli
    sfdx plugins:link .
    # To verify
    sfdx plugins

    Commands

    sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

    display current org’s limits

    USAGE
      $ sfdx force:limits:api:display [-u <string>] [--apiversion <string>] [--json] [--loglevel 
      trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
    
    OPTIONS
      -u, --targetusername=targetusername                                               username or alias for the target
                                                                                        org; overrides default target org
    
      --apiversion=apiversion                                                           override the api version used for
                                                                                        api requests made by this command
    
      --json                                                                            format output as json
    
      --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                        this command invocation
    
    DESCRIPTION
      When you execute this command in a project, it provides limit information for your default scratch org.
    
    EXAMPLES
      sfdx force:limits:api:display
      sfdx force:limits:api:display -u me@my.org
    

    See code: src/commands/force/limits/api/display.ts

    sfdx force:limits:recordcounts:display -s <array> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

    display record counts for the specified standard and custom objects

    USAGE
      $ sfdx force:limits:recordcounts:display -s <array> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
      trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
    
    OPTIONS
      -s, --sobjecttype=sobjecttype                                                     (required) comma-separated list of
                                                                                        API names of standard or custom
                                                                                        objects for which to display record
                                                                                        counts
    
      -u, --targetusername=targetusername                                               username or alias for the target
                                                                                        org; overrides default target org
    
      --apiversion=apiversion                                                           override the api version used for
                                                                                        api requests made by this command
    
      --json                                                                            format output as json
    
      --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                        this command invocation
    
    DESCRIPTION
      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.
    
    EXAMPLES
      sfdx force:limits:recordcounts:display -s Account,Contact,Lead,Opportunity
      sfdx force:limits:recordcounts:display -s Account,Contact -u me@my.org
    

    See code: src/commands/force/limits/recordcounts/display.ts

    Install

    npm i @salesforce/plugin-limits

    DownloadsWeekly Downloads

    26,593

    Version

    1.2.1

    License

    BSD-3-Clause

    Unpacked Size

    29.2 kB

    Total Files

    16

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar