Salesforce CLI Setup Guide

Before You Begin
Release Notes
Move from sfdx (v7) to sf (v2)
Install Salesforce CLI
Update Salesforce CLI
Salesforce CLI Configuration and Tips
Autocomplete CLI Commands and Flags
Use Salesforce CLI from Behind a Company Firewall or Web Proxy
Windows Performance Suggestions
Configuration Variables
Environment Variables
How API Version and Source API Version Work in Salesforce CLI
CLI Parameter Resolution Order
Support for JSON Responses
Specify Topics and Commands in Any Order
Log Messages and Log Levels
Disable Salesforce CLI Data Collection and Metrics
Uninstall Salesforce CLI or Plugins
Run Salesforce CLI Using a Docker Image
Salesforce CLI Plugins
Troubleshoot Salesforce CLI
CLI Deprecation Policy
Next Steps
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Log Messages and Log Levels

Salesforce CLI writes all log messages to the USER_HOME_DIR/.sf/sf.log file. CLI invocations append log messages to this running log file. Only errors are output to the terminal or command window from which you run the CLI.

The files in the USER_HOME_DIR/.sf directory are used internally by Salesforce CLI. Don’t remove or edit them.

Important

The default level of log messages is warn. You can set the log level to one of the following, listed in order of least to most information. The level is cumulative: for the debug level, the log file also includes messages at the info, warn, and error levels.

  • error
  • warn
  • info
  • debug
  • trace
  • fatal

Globally set the log level for all CLI commands with the SF_LOG_LEVEL environment variable. For example, on UNIX:

1export SF_LOG_LEVEL=debug

Salesforce CLI gathers diagnostic information about its use and reports it to Salesforce so that the development team can investigate issues. The type of information includes command duration and command invocation counts.

Note

Rotating Log Files

Salesforce CLI uses rotating log files. By default, every day at midnight Salesforce CLI makes a backup copy of the log file and then clears out its entries to start afresh. Backups are kept for the past two days along with the current day’s logs. This behavior ensures that the current log file doesn't get too large.

You can change the default behavior with these environment variables:

  • SF_LOG_ROTATION_PERIOD: How often a new log file is created, such as the default value of one day (1d) or two weeks 2w.
  • SF_LOG_ROTATION_COUNT: Number of backup files to keep. Default value is 2.

For example, let's say you choose a rotation period of 2 weeks and a count of 2. These values ensure that you have backup logs for the four weeks before the first entry in the current log.