Skip Navigation

doc Commands

Use the doc commands to display descriptions and help for commands in the force namespace.

doc:commands:display

Displays help for commands in the force namespace.

Command Syntax

sfdx force:doc:commands:display: [--json]; [--loglevel LOGLEVEL]

Parameters

--json: Optional; Format output as JSON.; Type: boolean
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL; Default value: warn

Help for doc:commands:display

Displays --help output for commands in the force namespace.

To display more details about the commands’ parameters, include the --json flag.

doc:commands:list

Lists the commands in the force namespace.

Command Syntax

sfdx force:doc:commands:list: [--json]; [--loglevel LOGLEVEL]; [-u]

Parameters

--json: Optional; Format output as JSON.; Type: boolean
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL; Default value: warn
-u | --usage: Optional; Lists docopt usage strings instead of command names and descriptions.; Type: boolean

Help for doc:commands:list

Displays a list of commands in the force namespace and their descriptions.