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

Commands to interact with salesforce sobject schemas

{
  "commands": {
    "sobject:describe": {
      "aliases": [
        "force:schema:sobject:describe"
      ],
      "args": {},
      "deprecateAliases": true,
      "description": "The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.\n\nThis command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.",
      "examples": [
        "Display the metadata of the \"Account\" standard object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Account",
        "Display the metadata of the \"MyObject__c\" custom object in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --target-org my-scratch-org",
        "Display the metadata of the ApexCodeCoverage Tooling API object in your default org:\n<%= config.bin %> <%= command.id %> --sobject ApexCodeCoverage --use-tooling-api"
      ],
      "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"
        },
        "sobject": {
          "aliases": [
            "sobjecttype"
          ],
          "char": "s",
          "name": "sobject",
          "required": true,
          "summary": "API name of the object to describe.",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "use-tooling-api": {
          "aliases": [
            "usetoolingapi"
          ],
          "char": "t",
          "name": "use-tooling-api",
          "summary": "Use Tooling API to display metadata for Tooling API objects.",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": true,
      "hiddenAliases": [],
      "id": "sobject:describe",
      "pluginAlias": "@salesforce/plugin-schema",
      "pluginName": "@salesforce/plugin-schema",
      "pluginType": "core",
      "strict": true,
      "summary": "Display the metadata for a standard or custom object or a Tooling API object.",
      "enableJsonFlag": true,
      "isESM": true,
      "relativePath": [
        "lib",
        "commands",
        "sobject",
        "describe.js"
      ],
      "aliasPermutations": [
        "force:schema:sobject:describe",
        "schema:force:sobject:describe",
        "schema:sobject:force:describe",
        "schema:sobject:describe:force",
        "force:sobject:schema:describe",
        "sobject:force:schema:describe",
        "sobject:schema:force:describe",
        "sobject:schema:describe:force",
        "force:sobject:describe:schema",
        "sobject:force:describe:schema",
        "sobject:describe:force:schema",
        "sobject:describe:schema:force",
        "force:schema:describe:sobject",
        "schema:force:describe:sobject",
        "schema:describe:force:sobject",
        "schema:describe:sobject:force",
        "force:describe:schema:sobject",
        "describe:force:schema:sobject",
        "describe:schema:force:sobject",
        "describe:schema:sobject:force",
        "force:describe:sobject:schema",
        "describe:force:sobject:schema",
        "describe:sobject:force:schema",
        "describe:sobject:schema:force"
      ],
      "permutations": [
        "sobject:describe",
        "describe:sobject"
      ]
    },
    "sobject:list": {
      "aliases": [
        "force:schema:sobject:list"
      ],
      "args": {},
      "deprecateAliases": true,
      "description": "You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API objects.",
      "examples": [
        "List all objects in your default org:\n<%= config.bin %> <%= command.id %> --sobject all",
        "List only custom objects in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject custom --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"
        },
        "sobject": {
          "aliases": [
            "sobjecttypecategory",
            "c"
          ],
          "char": "s",
          "name": "sobject",
          "summary": "Category of objects to list.",
          "default": "ALL",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": true,
      "hiddenAliases": [],
      "id": "sobject:list",
      "pluginAlias": "@salesforce/plugin-schema",
      "pluginName": "@salesforce/plugin-schema",
      "pluginType": "core",
      "strict": true,
      "summary": "List all Salesforce objects of a specified category.",
      "enableJsonFlag": true,
      "isESM": true,
      "relativePath": [
        "lib",
        "commands",
        "sobject",
        "list.js"
      ],
      "aliasPermutations": [
        "force:schema:sobject:list",
        "schema:force:sobject:list",
        "schema:sobject:force:list",
        "schema:sobject:list:force",
        "force:sobject:schema:list",
        "sobject:force:schema:list",
        "sobject:schema:force:list",
        "sobject:schema:list:force",
        "force:sobject:list:schema",
        "sobject:force:list:schema",
        "sobject:list:force:schema",
        "sobject:list:schema:force",
        "force:schema:list:sobject",
        "schema:force:list:sobject",
        "schema:list:force:sobject",
        "schema:list:sobject:force",
        "force:list:schema:sobject",
        "list:force:schema:sobject",
        "list:schema:force:sobject",
        "list:schema:sobject:force",
        "force:list:sobject:schema",
        "list:force:sobject:schema",
        "list:sobject:force:schema",
        "list:sobject:schema:force"
      ],
      "permutations": [
        "sobject:list",
        "list:sobject"
      ]
    }
  },
  "version": "3.3.90"
}