@salesforce/plugin-config
configure the Salesforce CLI
Last updated 5 days ago by jgrantham .
BSD-3-Clause · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @salesforce/plugin-config 
SYNC missed versions from official npm registry.

plugin-config

Plugin for sfdx config commands

Getting Started

To use, install the Salesforce CLI and run the following commands.

Verify the CLI is installed
  $ sfdx (-v | --version)
Install the config plugin
  $ sfdx plugins:install config
To run a command
  $ sfdx [command]

To build the plugin locally, make sure to have yarn installed and run the following commands:

Clone the repository
  $ git clone git@github.com:salesforcecli/plugin-config
Install the dependencies and compile
  $ yarn install
  $ yarn prepack
Link your plugin to the sfdx cli
  $ sfdx plugins:link .
To verify
  $ sfdx plugins

Commands

A list of the available commands

sfdx config:list

Lists the configuration variables for the Salesforce CLI

USAGE
$ sfdx config:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx config:list

  $ sfdx config:list --json

sfdx config:get

Gets the Salesforce CLI configuration values for your default scratch org, your default Dev Hub org, and more.

USAGE
$ sfdx config:get [<string> ...] [--json] [--verbose] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  --verbose                                                                         also output locations to stdout
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx force:config:get defaultusername

  $ sfdx force:config:get defaultdevhubusername instanceUrl --json

  $ sfdx force:config:get apiVersion defaultdevhubusername --verbose

sfdx config:set

Sets the local and global configuration variables for the Salesforce CLI.

USAGE
$ sfdx config:set [<string>=<string> ...] [--json] [-g] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -g                                                                                sets the variables globally
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx force:config:set defaultusername=me@my.org defaultdevhubusername=me@myhub.org

  $ sfdx force:config:set defaultdevhubusername=me@myhub.org -g

sfdx config:unset

Unsets the configuration variables for the Salesforce CLI.

USAGE
$ sfdx config:unset [<string> ...] [--json] [-g] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -g                                                                                unsets the variables globally
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx force:config:unset defaultusername defaultdevhubusername

  $ sfdx force:config:set apiVersion -g

Current Tags

  • 1.1.10                                ...           latest (5 days ago)

18 Versions

  • 1.1.10                                ...           5 days ago
  • 1.1.9                                ...           12 days ago
  • 1.1.8                                ...           2 months ago
  • 1.1.7                                ...           2 months ago
  • 1.1.6                                ...           2 months ago
  • 1.1.2                                ...           2 months ago
  • 1.1.1                                ...           2 months ago
  • 1.0.2                                ...           3 months ago
  • 0.0.13                                ...           3 months ago
  • 1.0.1                                ...           3 months ago
  • 0.0.8                                ...           3 months ago
  • 0.0.7                                ...           3 months ago
  • 0.0.6                                ...           3 months ago
  • 0.0.5                                ...           3 months ago
  • 0.0.4                                ...           3 months ago
  • 0.0.1-orb                                ...           3 months ago
  • 0.0.3                                ...           3 months ago
  • 0.0.2                                ...           3 months ago

Copyright 2014 - 2016 © taobao.org |