@salesforce/cli

What is @salesforce/cli?

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

What are @salesforce/cli's main functionalities?

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

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

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

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

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

Other packages similar to @salesforce/cli

jsforce

Jsforce 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

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.

README

cli

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

• cli
• Usage
• Commands

Usage

$ npm install -g @salesforce/cli
$ sf COMMAND
running command...
$ sf (-v|--version|version)
@salesforce/cli/0.0.2 linux-x64 node-v14.17.0
$ sf --help [COMMAND]
USAGE
  $ sf COMMAND
...

Commands

• sf env:connect
• sf env:list
• sf help [COMMAND]
• sf login

sf env:connect

connect to a Salesforce account or environment

USAGE
  $ sf env:connect

OPTIONS
  -f, --jwt-key-file=jwt-key-file  path to a file containing the private key
  -i, --client-id=client-id        OAuth client ID (sometimes called the consumer key)
  -r, --instance-url=instance-url  [default: https://login.salesforce.com] the login URL
  -u, --username=username          authentication username

EXAMPLE

See code: @salesforce/plugin-env

sf env:list

list environments

USAGE
  $ sf env:list

OPTIONS
  -a, --all               show all environments regardless of whether they're connected or not
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

EXAMPLES
  sf env list
  sf env list --all

See code: @salesforce/plugin-env

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 login

can I see my stuff please

USAGE
  $ sf login

OPTIONS
  -r, --login-url=login-url  [default: https://login.salesforce.com] the login url

EXAMPLE

See code: @salesforce/plugin-login