sf

Log in to a Salesforce org via web browser

$ sf org login web

$ sf org create scratch --definition-file [config/project-scratch-def.json] --alias [my-scratch]

$ sf project deploy start --target-org [my-org]

$ sf project retrieve start --target-org [my-org]

$ sf apex run test --target-org [my-org] --code-coverage

$ sf data query --query "[SELECT Id, Name FROM Account LIMIT 10]" --target-org [my-org]

$ sf package install --package [04t...] --target-org [my-org]

$ sf commands

sf command [subcommand] [flags]

sf (Salesforce CLI) is the official command-line interface for Salesforce development. It manages Salesforce DX projects, creates and manages scratch orgs and sandboxes, deploys and retrieves source code, runs tests, and handles package development.
The CLI uses a hierarchical command structure where commands are grouped by topic (org, project, data, apex, package). Most commands accept a --target-org flag to specify which org to operate on, and --json for machine-readable output.
Configuration is stored in ~/.sf/ and project-specific settings in sfdx-project.json. Orgs can be aliased for convenience using sf alias set.

--target-org, -o alias

Specify the target org by username or alias

Output results in JSON format

Display help for a command

Display CLI version

~/.sf/

User-level configuration directory storing authentication tokens, org connections, and CLI settings.

Project-level configuration file defining source paths, namespace, API version, and package dependencies.

Environment variable for providing an org access token directly.

org login web

Authenticate to an org using OAuth via web browser

Authenticate using JWT-based flow

Create a scratch org for development

Create a sandbox org

List all authenticated orgs

Display details about an org

Deploy source to an org

Retrieve metadata from an org

Convert metadata API format to source format

Execute anonymous Apex code

Run Apex tests

Execute a SOQL query

Create a record in an org

Create a package

Install a package in an org

Set CLI configuration values

Create aliases for orgs

The older sfdx command is deprecated; migrate to sf commands. Some operations require specific org permissions or Salesforce editions. Scratch orgs have time limits (default 7 days) and namespace considerations for packaging.

Salesforce CLI was introduced as sfdx (Salesforce DX CLI) in 2017 alongside the Salesforce DX development model. The sf command was introduced in 2022 as a unified, redesigned CLI with improved command structure. The sfdx-style commands were deprecated in 2024 with full transition to sf.

npm(1), git(1), jq(1)