doctor

Help for doctor

When you run the doctor command without parameters, it first displays a diagnostic overview of your environment. It then writes a detailed diagnosis to a JSON file in the current directory. Use the --outputdir to specify a different directory. To run diagnostic tests on a specific plugin, use the --plugin parameter. If the plugin isn't listening to the doctor, then you get a warning.

Use the --command parameter to run a specific command in debug mode; the doctor writes both stdout and stderr to *.log files that you can provide to Salesforce Customer Support or attach to a GitHub issue.

Plugin providers can also implement their own doctor diagnostic tests by listening to the "sf-doctor" event and running plugin specific tests that are then included in the doctor diagnostics log.

Examples for doctor

Run CLI doctor diagnostics:

1sfdx doctor

Run CLI doctor diagnostics and the specified command, and write the debug output to a file:

1sfdx doctor --command "force:org:list --all"

Run CLI doctor diagnostics for a specific plugin:

1sfdx doctor --plugin @salesforce/plugin-source

Command Syntax

sfdx doctor

[--json]

[--loglevel LOGLEVEL]

[-c COMMAND]

[-p PLUGIN]

[-o OUTPUTDIR]

[-i]

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

-c | --command COMMAND

Optional

Command to run in debug mode ; results are written to a log file.

Type: string

-p | --plugin PLUGIN

Optional

Specific plugin on which to run diagnostics .

Type: string

-o | --outputdir OUTPUTDIR

Optional

Directory to save all created files rather than the current working directory.

Type: directory

-i | --createissue

Optional

Create a new issue on our GitHub repo and attach all diagnostic results.

Type: boolean