@salesforce/cli
Advanced tools
@salesforce/cli is a command-line interface tool that allows developers to interact with Salesforce environments. It provides a wide range of functionalities for managing Salesforce orgs, deploying and retrieving metadata, running tests, and automating various tasks.
Authenticate to a Salesforce Org
This command opens a web browser to authenticate to a Salesforce org and sets an alias for easy reference in future commands.
sfdx auth:web:login --setalias myOrgAlias --instanceurl https://login.salesforce.comCreate a Salesforce DX Project
This command creates a new Salesforce DX project with the specified name. It sets up the necessary directory structure and configuration files.
sfdx force:project:create --projectname myProjectDeploy Metadata to an Org
This command deploys metadata from the local project to the specified Salesforce org using the alias set during authentication.
sfdx force:source:deploy --sourcepath force-app/main/default --targetusername myOrgAliasRetrieve Metadata from an Org
This command retrieves metadata from the specified Salesforce org based on the provided manifest file.
sfdx force:source:retrieve --manifest package.xml --targetusername myOrgAliasRun Apex Tests
This command runs Apex tests in the specified Salesforce org and displays the results in a human-readable format.
sfdx force:apex:test:run --targetusername myOrgAlias --resultformat humanJsforce is a JavaScript library that provides a comprehensive API for interacting with Salesforce. Unlike @salesforce/cli, which is a command-line tool, Jsforce is used within Node.js applications to perform similar tasks programmatically.
SFDX-CLI is another command-line tool for Salesforce DX, similar to @salesforce/cli. It offers many of the same functionalities but may have different command syntax and additional features.
[EXPERIMENT]: This Salesforce CLI the focuses on a cleaner user experience for ALL Salesforce functionality. It is in heavy development will be changing rapidly. More information will be added to this repository in the near-future.
$ npm install -g @salesforce/cli
$ sf COMMAND
running command...
$ sf (-v|--version|version)
@salesforce/cli/0.0.6 linux-x64 node-v14.17.2
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
...
sf env:create:computesf env:deletesf env:displaysf env:listsf env:log:tailsf env:logdrain:addsf env:logdrain:listsf env:logdrain:removesf env:opensf env:var:get KEYsf env:var:listsf env:var:setsf env:var:unsetsf generate:functionsf generate:projectsf help [COMMAND]sf loginsf login:functionssf login:orgsf login:org:jwtsf logoutsf project:deploysf project:deploy:functionssf project:deploy:orgsf run:functionsf run:function:startsf env:create:computecreate a compute environment for use with Salesforce Functions
USAGE
$ sf env:create:compute
OPTIONS
-a, --setalias=setalias alias for the created environment
-o, --connected-org=connected-org username or alias for the org that the compute environment should be connected to
EXAMPLES
$ sfdx env:create:compute
$ sfdx env:create:compute --setalias my-compute-environment
$ sfdx env:create:compute --connected-org my-scratch-org
See code: @salesforce/plugin-functions
sf env:deletedelete an environment
USAGE
$ sf env:delete
OPTIONS
-c, --confirm=name confirmation name
-e, --environment=environment (required) environment name
EXAMPLES
$ sfdx env:delete --environment=billingApp-Scratch1
$ sfdx env:delete --environment=billingApp-Scratch1 --confirm=billingApp-Scratch1
See code: @salesforce/plugin-functions
sf env:displaydisplay details for an environment
USAGE
$ sf env:display
OPTIONS
-e, --environment=environment (required) environment name
--verbose verbose display output
EXAMPLE
$ sfdx env:display --environment=billingApp-Scratch1
See code: @salesforce/plugin-functions
sf env:listList all environments by type
USAGE
$ sf env:list
OPTIONS
-j, --json output list in JSON format
-t, --environment-type=org|scratchorg|compute filter by one or more environment types (org, scratchorg, compute)
--all show all available envs instead of scoping to active orgs and their
connected compute envs
EXAMPLES
$ sfdx env:list
$ sfdx env:list --all
$ sfdx env:list --environment-type org --environment-type compute
See code: @salesforce/plugin-functions
sf env:log:tailstream log output for an environment
USAGE
$ sf env:log:tail
OPTIONS
-e, --environment=environment (required) environment name to retrieve logs
EXAMPLE
sfdx env:log:tail --environment=billingApp-Scratch1
See code: @salesforce/plugin-functions
sf env:logdrain:addAdd log drain to a specified environment
USAGE
$ sf env:logdrain:add
OPTIONS
-e, --environment=environment (required) environment name
-u, --url=url (required) endpoint that will receive sent logs
EXAMPLE
$ sfdx env:logdrain:add --environment=billingApp-Sandbox --url=https://example.com/drain
See code: @salesforce/plugin-functions
sf env:logdrain:listList log drains connected to a specified environment
USAGE
$ sf env:logdrain:list
OPTIONS
-e, --environment=environment (required) environment name
--json output result in json
EXAMPLE
$ sfdx env:logdrain:list --environment=billingApp-Sandbox
See code: @salesforce/plugin-functions
sf env:logdrain:removeRemove log drain from a specified environment.
USAGE
$ sf env:logdrain:remove
OPTIONS
-e, --environment=environment (required) environment name
-u, --url=url (required) logdrain url to remove
EXAMPLE
$ sfdx env:logdrain:remove --environment=billingApp-Sandbox --url=syslog://syslog-a.logdna.com:11137
See code: @salesforce/plugin-functions
sf env:openYou can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production orgs.
USAGE
$ sf env:open
OPTIONS
-e, --target-env=target-env
Specify the login user or alias that’s associated with the environment. For scratch orgs, the login user is
generated by the command that created the scratch org. You can also set an alias for the scratch org when you create
it.
For Dev Hubs, sandboxes, and production orgs, specify the alias you set when you logged into the org with "sf
login".
-p, --path=path
Each of your environments is associated with an instance URL, such as https://<mydomian>.my.salesforce.com. To open
a specific web page at that URL, specify the portion of the URL after "<URL>/" with the --path flag, such as
/apex/YourPage to open a Visualforce page.
-r, --url-only
--browser=browser
Specify a browser by its app name according to your operating system. For example, Chrome’s app name is "google
chrome" on macOS, "google-chrome" on Linux and "chrome" on Windows. So to open an environment in Chrome on macOS,
specify --browser "google chrome". If you don’t specify --browser, the environment opens in your default browser.
For convenience, "chrome", "firefox", and "edge" are mapped to the OS specific app name.
--json
format output as json
DESCRIPTION
If you run the command without flags, it attempts to open your default environment in your default web browser.
EXAMPLES
To open your default environment, run the command without flags:
sf env open
This example opens the Visualforce page /apex/StartHere in a scratch org with alias "test-org":
sf env open --target-env test-org --path /apex/StartHere
If you want to view the URL for the preceding command, but not launch it in a browser:
sf env open --target-env test-org --path /apex/StartHere --url-only
The preceding examples open the environment in your default web browser. To use a different browser, set the --browser
flag to its OS-specific name. For example, to use Chrome on macOS:
sf env open --target-env test-org --path /apex/StartHere --browser "google chrome"
See code: @salesforce/plugin-env
sf env:var:get KEYdisplay a single config value for an environment
USAGE
$ sf env:var:get KEY
OPTIONS
-e, --environment=environment (required) environment name
EXAMPLE
$ sfdx env:var:get foo --environment=my-environment
See code: @salesforce/plugin-functions
sf env:var:listlist your config vars in a table
USAGE
$ sf env:var:list
OPTIONS
-e, --environment=environment (required) environment name
EXAMPLE
$ sfdx env:var:list --environment=my-environment
See code: @salesforce/plugin-functions
sf env:var:setsets a single config value for an environment
USAGE
$ sf env:var:set
OPTIONS
-e, --environment=environment (required) environment name
EXAMPLE
$ sfdx env:var:set foo=bar --environment=my-environment
See code: @salesforce/plugin-functions
sf env:var:unsetunset a single config value for an environment
USAGE
$ sf env:var:unset
OPTIONS
-e, --environment=environment (required) environment name
EXAMPLE
$ sfdx env:var:unset foo --environment=my-environment
See code: @salesforce/plugin-functions
sf generate:functioncreate a function with basic scaffolding specific to a given language
USAGE
$ sf generate:function
OPTIONS
-l, --language=(javascript|typescript|java) (required) language
-n, --name=name (required) function name
ALIASES
$ sf evergreen:function:init
EXAMPLE
$ sfdx evergreen:function:create MyFunction --language=javascript
See code: @salesforce/plugin-functions
sf generate:projectUSAGE
$ sf generate:project
OPTIONS
-n, --name=name (required) name of the generated project
See code: @salesforce/plugin-functions
sf help [COMMAND]display help for sf
USAGE
$ sf help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
sf loginLog in interactively to Salesforce orgs and other services.
USAGE
$ sf login
EXAMPLE
sf login
See code: @salesforce/plugin-login
sf login:functionslog into your account
USAGE
$ sf login:functions
EXAMPLE
$ sfdx login:functions
See code: @salesforce/plugin-functions
sf login:orgAllows you to login to a Salesforce org using either the default https://login.salesforce.com portal or a specific instance URL as defined with a flag.
USAGE
$ sf login:org
OPTIONS
-a, --alias=alias Set an alias for the account or environment
-b, --browser=browser Override system default browser with the specified browser.
-d, --set-default Set the org as the default org after login
-i, --clientid=clientid OAuth client ID (sometimes called the consumer key)
-l, --instance-url=instance-url [default: https://login.salesforce.com] The login url
EXAMPLES
Login to an org.
sf login org
Login to an org and set an alias.
sf login org --alias MyHub
See code: @salesforce/plugin-login
sf login:org:jwtLog in to your Salesforce orgs using a JSON web token
USAGE
$ sf login:org:jwt
OPTIONS
-a, --alias=<value> Set an alias for the account or environment
-d, --set-default Set the org as the default org after login
-f, --jwt-key-file=<value> Path to a file containing the private key
-i, --clientid=<value> OAuth client ID (sometimes called the consumer key)
-l, --instance-url=<value> [default: https://login.salesforce.com] The login url
-u, --username=<value> Authentication username
EXAMPLE
sf login org jwt --jwt-key-file myorg.key --username me@salesforce.com --clientid XXXX
See code: @salesforce/plugin-login
sf logoutLog out of all Salesforce orgs and environments.
USAGE
$ sf logout
EXAMPLE
sf logout
See code: @salesforce/plugin-login
sf project:deployThe command first analyzes your project, active or logged-into environments, and local defaults to determine what to deploy and where. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.
USAGE
$ sf project:deploy
OPTIONS
--interactive
DESCRIPTION
For example, if your local project contains a package directory with metadata source files, the command asks if you
want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to
deploy to. If the command finds Apex tests, it asks if you want to run them and at which level.
Similarly, if the command finds a local functions directory, the command prompts if you want to deploy it and to which
compute environment. The command prompts and connects you to a compute environment of your choice if you’re not
currently connected to any.
This command must be run from within a project.
The command stores your responses in a local file and uses them as defaults when you rerun the command. Specify
--interactive to force the command to reprompt.
Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific
commands, such as "sf project deploy org", that provide additional flags.
EXAMPLE
sf project:deploy
See code: @salesforce/plugin-project
sf project:deploy:functionsUSAGE
$ sf project:deploy:functions
OPTIONS
-b, --branch=branch deploy the latest commit from a branch different from the currently active branch
-o, --connected-org=connected-org (required) username or alias for the org that the compute environment should be
connected to
-q, --quiet limit the amount of output displayed from the deploy process
--force ignore warnings and overwrite remote repository (not allowed in production)
See code: @salesforce/plugin-functions
sf project:deploy:orgYou must run this command from wihin a project.
USAGE
$ sf project:deploy:org
OPTIONS
-d, --deploy-dir=deploy-dir Root of local directory tree of files to deploy.
-m, --metadata=metadata Space-separated list of metadata component names to deploy.
-t, --target-org=target-org Username or alias of the org you want to deploy to
-x, --manifest=manifest Full file path for manifest (package.xml) of components to deploy.
--json format output as json
DESCRIPTION
The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your
source with the versions in your org.
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of
double quotes. On Windows, if the list contains commas, also enclose the entire list in one set of double quotes.
EXAMPLES
Deploy the source files in a directory:
sf project:deploy:org --deploy-dir path/to/source
Deploy a specific Apex class and the objects whose source is in a directory:
sf project:deploy:org --deploy-dir "path/to/apex/classes/MyClass.cls,path/to/source/objects"
Deploy source files in a comma-separated list that contains spaces:
sf project:deploy:org --deploy-dir "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml,
path/to/apex/classes"
Deploy all Apex classes:
sf project:deploy:org --metadata ApexClass
Deploy a specific Apex class:
sf project:deploy:org --metadata ApexClass:MyApexClass
Deploy all custom objects and Apex classes:
sf project:deploy:org --metadata "CustomObject,ApexClass"
Deploy all Apex classes and two specific profiles (one of which has a space in its name):
sf project:deploy:org --metadata "ApexClass, Profile:My Profile, Profile: AnotherProfile"
Deploy all components listed in a manifest:
sf project:deploy:org --manifest path/to/package.xml
See code: @salesforce/plugin-project-org
sf run:functionsend a cloudevent to a function
USAGE
$ sf run:function
OPTIONS
-H, --headers=headers set headers
-l, --url=url (required) url of the function to run
-o, --connected-org=connected-org username or alias for the target org; overrides default target org
-p, --payload=payload set the payload of the cloudevent. also accepts @file.txt format
-s, --structured set the cloudevent to be emitted as a structured cloudevent (json)
EXAMPLE
$ sfdx run:function -l http://localhost:8080 -p '{"id": 12345}'
$ sfdx run:function -l http://localhost:8080 -p '@file.json'
$ echo '{"id": 12345}' | sfdx run:function -l http://localhost:8080
$ sfdx run:function -l http://localhost:8080 -p '{"id": 12345}' --structured
See code: @salesforce/plugin-functions
sf run:function:startbuild and run function image locally
USAGE
$ sf run:function:start
OPTIONS
-d, --debug-port=debug-port [default: 9229] port for remote debugging
-e, --env=env set environment variables (provided during build and run)
-p, --port=port [default: 8080] port for running the function
-v, --verbose output additional logs
--clear-cache clear associated cache before executing.
--network=network Connect and build containers to a network. This can be useful to build containers which
require a local resource.
--no-pull skip pulling builder image before use
EXAMPLE
$ sfdx run:function:start
$ sfdx run:function:start -e VAR=VALUE
$ sfdx run:function:start --network host --no-pull --clear-cache --debug-port 9000 --port 5000
See code: @salesforce/plugin-functions
FAQs
The Salesforce CLI
The npm package @salesforce/cli receives a total of 95,687 weekly downloads. As such, @salesforce/cli popularity was classified as popular.
We found that @salesforce/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.