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 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 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
PDF

Newer Version Available

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

Use Salesforce CLI from Behind a Company Firewall or Web Proxy

If you install or update Salesforce CLI on a computer that’s behind a company firewall or web proxy, you sometimes receive error messages. In this case, you must further configure your system.

You get this type of error when you run a command after installing Salesforce CLI behind a firewall or web proxy. This error is from a Linux computer, but Windows and macOS users sometimes see a similar error.

To address this issue, run these commands from your terminal or Windows command prompt, replacing username:pwd with your web proxy username and password. If your proxy doesn’t require these values, omit them. Also replace proxy.company.com:8080 with the URL and port of your company proxy.

Then set the HTTP_PROXY or HTTPS_PROXY environment variable to the full URL of the proxy. For example, on UNIX:

On a Windows machine:

If You Still See an Error

Your Proxy Requires an Extra Certificate Authority

If you set the proxy environment variable, and you still see error messages, it’s possible that your proxy requires an extra certificate authority (CA). Ask your IT department where to find or download the certificates.

Set this environment variable to point to the CA file: NODE_EXTRA_CA_CERTS.

Your Corporate Network Is Blocking Salesforce Hosts

It’s possible that your corporate network is blocking the Salesforce hosts for updating or installing Salesforce CLI. Contact your IT department add these URLs to your allowlist:

  • https://developer.salesforce.com/media/salesforce-cli
  • https://registry.npmjs.org