sf-cli v3.2.1

sf

SFDX wrapper

• Installation
• Commands

Installation

Make sure Salesforce DX CLI is installed in your system.

brew tap matiasdelgado/sf-cli
brew install sf-cli

Commands

• sf autocomplete [SHELL]
• sf code
• sf delete
• sf deploy
• sf help [COMMAND]
• sf info
• sf list
• sf log
• sf login
• sf logout
• sf open
• sf pull
• sf switch [ALIAS]
• sf test [SUBJECT]
• sf version

sf autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ sf autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ sf autocomplete

  $ sf autocomplete bash

  $ sf autocomplete zsh

  $ sf autocomplete powershell

  $ sf autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

sf code

Push/pull source code

USAGE
  $ sf code [-l] [-p]

FLAGS
  -l, --pull  Pull from scratch org
  -p, --push  Push to scratch org

DESCRIPTION
  Push/pull source code

See code: src/commands/code.js

sf delete

Delete scratch org

USAGE
  $ sf delete [-s]

FLAGS
  -s, --select  Select scratch org to delete

DESCRIPTION
  Delete scratch org

See code: src/commands/delete.js

sf deploy

Push source code

USAGE
  $ sf deploy

DESCRIPTION
  Push source code

See code: src/commands/deploy.js

sf help [COMMAND]

Display help for sf.

USAGE
  $ sf help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for sf.

See code: @oclif/plugin-help

sf info

Display current scratch org information

USAGE
  $ sf info [-a <value>] [-m]

FLAGS
  -a, --alias=<value>  Alias or username
  -m, --markdown       Generates MD code

DESCRIPTION
  Display current scratch org information

See code: src/commands/info.js

sf list

List all available scratch orgs.

USAGE
  $ sf list

DESCRIPTION
  List all available scratch orgs.

See code: src/commands/list.js

sf log

Show remote logs

USAGE
  $ sf log [-d]

FLAGS
  -d, --debug  Show debug messages only

DESCRIPTION
  Show remote logs

See code: src/commands/log.js

sf login

Log in to scratch org

USAGE
  $ sf login -a <value> -u <value>

FLAGS
  -a, --alias=<value>  (required) Alias or username
  -u, --url=<value>    (required) Instance URL

DESCRIPTION
  Log in to scratch org

See code: src/commands/login.js

sf logout

Log out from scratch org

USAGE
  $ sf logout -a <value>

FLAGS
  -a, --alias=<value>  (required) Alias or username

DESCRIPTION
  Log out from scratch org

See code: src/commands/logout.js

sf open

Open the default scratch org in the browser or by picking from the list of available orgs.

USAGE
  $ sf open [-a <value>] [-s]

FLAGS
  -a, --alias=<value>  Alias or username of the org to open
  -s, --select         Select scratch org to open

DESCRIPTION
  Open the default scratch org in the browser or by picking from the list of available orgs.

See code: src/commands/open.js

sf pull

Pull source code

USAGE
  $ sf pull

DESCRIPTION
  Pull source code

See code: src/commands/pull.js

sf switch [ALIAS]

Change the default scratch org

USAGE
  $ sf switch [ALIAS] [-o]

FLAGS
  -o, --open  Open the scratch org in the browser

DESCRIPTION
  Change the default scratch org

See code: src/commands/switch.js

sf test [SUBJECT]

Run tests by class or method name

USAGE
  $ sf test [SUBJECT]

DESCRIPTION
  Run tests by class or method name

See code: src/commands/test.js

sf version

USAGE
  $ sf version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version