Salesforce CLI Setup Guide

Quick Start
System Requirements
Move from sfdx (v7) to sf (v2)
Install Salesforce CLI
Update Salesforce CLI
Salesforce CLI Configuration and Tips
Autocomplete Salesforce CLI Commands and Flags
Use Salesforce CLI from Behind a Company Firewall or Web Proxy
Windows Performance Suggestions
Configuration Variables
Salesforce CLI 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
Customize the Colors in Help Output
Specify Flag Values in Files
Log Messages and Log Levels
Enable 256-Bit Encryption of Local Authorization Files
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
Release Notes
PDF

Log Messages and Log Levels

Salesforce CLI writes all log messages to a rotating file in the user’s home directory whose name is based on the day. For example, the logs for August 8, 2024 are written to the file USER_HOME_DIR/.sf/sf-2024-08-07.log. Salesforce CLI command 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. This behavior ensures that the current log file doesn't get too large.

Salesforce CLI checks for, and then deletes, any log files that are older than seven days. If you want to keep these old log files, copy them to a different location.

You can change how often a new log file is created by setting the SF_LOG_ROTATION_PERIOD environment variable to either 1h (one hour) or 1m (one minute). Both of these values result in more, but smaller, log files. Any other value is treated as 1d, which is the default value.