Salesforce CLI Command Reference

Salesforce CLI Command Reference
Release Notes
sf
sfdx
Migrate sfdx-Style Commands to the New sf-Style
alias Namespace
auth Namespace
config Namespace
doctor
force Namespace
analytics Commands
apex Commands
cmdt Commands
community Commands
data Commands
lightning Commands
limits Commands
mdapi Commands
org Commands
package Commands
package1 Commands
project Commands
schema Commands
force:schema:sobject:describe
force:schema:sobject:list
source Commands
staticresource Commands
user Commands
visualforce Commands
info Namespace
Help for sfdx Commands
CLI Deprecation Policy
Discover Salesforce Plugins
PDF

schema Commands

Use the schema commands to view information about the standard and custom objects in your org.

force:schema:sobject:describe

Displays the metadata for a standard or custom object.

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 sobject describe 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.
  • Changed flag name: Old name --usetoolingapi. New name: --use-tooling-api.

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

Examples for force:schema:sobject:describe 

1sfdx force:schema:sobject:describe -s Account
1sfdx force:schema:sobject:describe -s MyObject__c
1sfdx force:schema:sobject:describe -s ApexClass -t

Command Syntax

sfdx force:schema:sobject:describe
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE
[-t]

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
Required

The API name of the object to describe.

Type: string
-t | --usetoolingapi
Optional

Execute with Tooling API.

Type: boolean

force:schema:sobject:list

List all objects of a specified category.

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

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

Examples for force:schema:sobject:list 

1sfdx force:schema:sobject:list -c all
1sfdx force:schema:sobject:list -c custom
1sfdx force:schema:sobject:list -c standard

Command Syntax

sfdx force:schema:sobject:list
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-c SOBJECTTYPECATEGORY]

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
-c | --sobjecttypecategory SOBJECTTYPECATEGORY
Optional

The type of objects to list (all|custom|standard).

Type: string
Default value: ALL