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

Quick Start

Salesforce CLI is a command-line interface that simplifies development and build automation when working with your Salesforce org. Use it to create and manage orgs, synchronize source to and from orgs, create and install packages, and more.
Salesforce CLI is based on oclif, an open-source framework for building command-line interfaces in Node.js. You run it on your local machine or continuous integration (CI) system. It supports the installation of custom plugins.

Are you still using sfdx (v7)? See Move from sfdx (v7) to sf (v2) if so.

Important

Run through these steps to install Salesforce CLI on your computer and optionally configure it for your specific environment.

  1. Read the system requirements to ensure Salesforce CLI works correctly on your computer.
  2. Install Salesforce CLI on your computer.
    Follow the documentation for your computer's operating system, such as Windows or macOS. You can also install using npm or from a TAR file.
  3. Verify that you've installed Salesforce CLI correctly by opening a terminal (macOS, Linux) or command prompt (Windows) and running this command to see the list of all available CLI commands. 
    1sf commands
    Run this command to see the version of Salesforce CLI you just installed.
    1sf --version
  4. Optionally configure Salesforce CLI so it works exactly how you want.
    Here are a few examples of what you can do:
    • Enable autocomplete.
    • Set CLI configuration and environment variables.
    • Customize the colors in the --help output.
    • Use Salesforce CLI from behind a company firewall.
  5. Read the weekly release notes to learn about new features, changes, and bug fixes.
Congratulations! You can now start using Salesforce CLI for all kinds of fun tasks. For example, read this documentation to learn how to use a sample GitHub repo to get started with Salesforce DX.