@salesforce/plugin-limits/oclif.manifest.json

commands to display api limits to your org

{
  "commands": {
    "org:list:limits": {
      "aliases": [
        "force:limits:api:display",
        "limits:api:display"
      ],
      "args": {},
      "deprecateAliases": true,
      "description": "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": [
        "Display limits in your default org:\n<%= config.bin %> <%= command.id %>",
        "Display limits in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org"
      ],
      "flags": {
        "json": {
          "description": "Format output as json.",
          "helpGroup": "GLOBAL",
          "name": "json",
          "allowNo": false,
          "type": "boolean"
        },
        "flags-dir": {
          "helpGroup": "GLOBAL",
          "name": "flags-dir",
          "summary": "Import flag values from a directory.",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "target-org": {
          "aliases": [
            "targetusername",
            "u"
          ],
          "char": "o",
          "deprecateAliases": true,
          "name": "target-org",
          "noCacheDefault": true,
          "required": true,
          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
          "hasDynamicHelp": true,
          "multiple": false,
          "type": "option"
        },
        "api-version": {
          "aliases": [
            "apiversion"
          ],
          "deprecateAliases": true,
          "description": "Override the api version used for api requests made by this command",
          "name": "api-version",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "loglevel": {
          "deprecated": {
            "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
          },
          "hidden": true,
          "name": "loglevel",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": true,
      "hiddenAliases": [],
      "id": "org:list:limits",
      "pluginAlias": "@salesforce/plugin-limits",
      "pluginName": "@salesforce/plugin-limits",
      "pluginType": "core",
      "strict": true,
      "summary": "Display information about limits in your org.",
      "enableJsonFlag": true,
      "isESM": true,
      "relativePath": [
        "lib",
        "commands",
        "org",
        "list",
        "limits.js"
      ],
      "aliasPermutations": [
        "force:limits:api:display",
        "limits:force:api:display",
        "limits:api:force:display",
        "limits:api:display:force",
        "force:api:limits:display",
        "api:force:limits:display",
        "api:limits:force:display",
        "api:limits:display:force",
        "force:api:display:limits",
        "api:force:display:limits",
        "api:display:force:limits",
        "api:display:limits:force",
        "force:limits:display:api",
        "limits:force:display:api",
        "limits:display:force:api",
        "limits:display:api:force",
        "force:display:limits:api",
        "display:force:limits:api",
        "display:limits:force:api",
        "display:limits:api:force",
        "force:display:api:limits",
        "display:force:api:limits",
        "display:api:force:limits",
        "display:api:limits:force",
        "limits:api:display",
        "api:limits:display",
        "api:display:limits",
        "limits:display:api",
        "display:limits:api",
        "display:api:limits"
      ],
      "permutations": [
        "org:list:limits",
        "list:org:limits",
        "list:limits:org",
        "org:limits:list",
        "limits:org:list",
        "limits:list:org"
      ]
    },
    "org:list:sobject:record-counts": {
      "aliases": [
        "force:limits:recordcounts:display",
        "limits:recordcounts:display"
      ],
      "args": {},
      "deprecateAliases": true,
      "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 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": [
        "Display all available record counts in your default org:\n<%= config.bin %> <%= command.id %>",
        "Display record counts for the Account, Contact, Lead, and Opportunity objects in your default org:\n<%= 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\":\n<%= config.bin %> <%= command.id %> --sobject Account --sobject Lead --target-org my-scratch-org"
      ],
      "flags": {
        "json": {
          "description": "Format output as json.",
          "helpGroup": "GLOBAL",
          "name": "json",
          "allowNo": false,
          "type": "boolean"
        },
        "flags-dir": {
          "helpGroup": "GLOBAL",
          "name": "flags-dir",
          "summary": "Import flag values from a directory.",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "sobject": {
          "aliases": [
            "sobjecttype"
          ],
          "char": "s",
          "name": "sobject",
          "summary": "API name of the standard or custom object for which to display record counts.",
          "default": [],
          "delimiter": ",",
          "hasDynamicHelp": false,
          "multiple": true,
          "type": "option"
        },
        "target-org": {
          "aliases": [
            "targetusername",
            "u"
          ],
          "char": "o",
          "deprecateAliases": true,
          "name": "target-org",
          "noCacheDefault": true,
          "required": true,
          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
          "hasDynamicHelp": true,
          "multiple": false,
          "type": "option"
        },
        "api-version": {
          "aliases": [
            "apiversion"
          ],
          "deprecateAliases": true,
          "description": "Override the api version used for api requests made by this command",
          "name": "api-version",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "loglevel": {
          "deprecated": {
            "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
          },
          "hidden": true,
          "name": "loglevel",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": true,
      "hiddenAliases": [],
      "id": "org:list:sobject:record-counts",
      "pluginAlias": "@salesforce/plugin-limits",
      "pluginName": "@salesforce/plugin-limits",
      "pluginType": "core",
      "strict": true,
      "summary": "Display record counts for the specified standard or custom objects.",
      "enableJsonFlag": true,
      "isESM": true,
      "relativePath": [
        "lib",
        "commands",
        "org",
        "list",
        "sobject",
        "record-counts.js"
      ],
      "aliasPermutations": [
        "force:limits:recordcounts:display",
        "limits:force:recordcounts:display",
        "limits:recordcounts:force:display",
        "limits:recordcounts:display:force",
        "force:recordcounts:limits:display",
        "recordcounts:force:limits:display",
        "recordcounts:limits:force:display",
        "recordcounts:limits:display:force",
        "force:recordcounts:display:limits",
        "recordcounts:force:display:limits",
        "recordcounts:display:force:limits",
        "recordcounts:display:limits:force",
        "force:limits:display:recordcounts",
        "limits:force:display:recordcounts",
        "limits:display:force:recordcounts",
        "limits:display:recordcounts:force",
        "force:display:limits:recordcounts",
        "display:force:limits:recordcounts",
        "display:limits:force:recordcounts",
        "display:limits:recordcounts:force",
        "force:display:recordcounts:limits",
        "display:force:recordcounts:limits",
        "display:recordcounts:force:limits",
        "display:recordcounts:limits:force",
        "limits:recordcounts:display",
        "recordcounts:limits:display",
        "recordcounts:display:limits",
        "limits:display:recordcounts",
        "display:limits:recordcounts",
        "display:recordcounts:limits"
      ],
      "permutations": [
        "org:list:sobject:record-counts",
        "list:org:sobject:record-counts",
        "list:sobject:org:record-counts",
        "list:sobject:record-counts:org",
        "org:sobject:list:record-counts",
        "sobject:org:list:record-counts",
        "sobject:list:org:record-counts",
        "sobject:list:record-counts:org",
        "org:sobject:record-counts:list",
        "sobject:org:record-counts:list",
        "sobject:record-counts:org:list",
        "sobject:record-counts:list:org",
        "org:list:record-counts:sobject",
        "list:org:record-counts:sobject",
        "list:record-counts:org:sobject",
        "list:record-counts:sobject:org",
        "org:record-counts:list:sobject",
        "record-counts:org:list:sobject",
        "record-counts:list:org:sobject",
        "record-counts:list:sobject:org",
        "org:record-counts:sobject:list",
        "record-counts:org:sobject:list",
        "record-counts:sobject:org:list",
        "record-counts:sobject:list:org"
      ]
    }
  },
  "version": "3.3.64"
}