Package Health Score

45 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version			Vulnerabilities	License Risk
1.5.1	\|	02/2023	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.23	\|	01/2023	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.21	\|	09/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.13	\|	08/2020	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-3-Clause

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (8,842)

GitHub Stars: 6
Forks: 1
Contributors: 20

Direct Usage Popularity

The npm package @salesforce/plugin-config receives a total of 8,842 downloads a week. As such, we scored @salesforce/plugin-config popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @salesforce/plugin-config, we found that it has been starred 6 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the @salesforce/plugin-config repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

deprecated

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 6
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of @salesforce/plugin-config based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @salesforce/plugin-config is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14.0.0

Age: 4 years
Dependencies: 4 Direct
Versions: 158
Install Size: 56 kB
Dist-tags: 2
# of Files: 30
Maintainers: 47
TS Typings: No

@salesforce/plugin-config has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

plugin-config

> Warning
> The 2.X.X tags of plugin-config have been deprecated. That code has been moved to plugin-settings to be used by the sf CLI.
> If a major bump is needed for plugin-config in the future, jump to 3.0.0.

Config commands for Salesforce CLI

This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.

We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.

Install

sfdx plugins:install config@x.y.z

Issues

Please report any issues at https://github.com/forcedotcom/cli/issues

Contributing

Please read our Code of Conduct
Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
Fork this repository.
Build the plugin locally
Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
Edit the code in your fork.
Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
Sign CLA (see CLA below).
Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

CLA

External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

Build

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 build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file.
./bin/dev config

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sfdx cli
sfdx plugins:link .
# To verify
sfdx plugins

Commands

`sfdx config:get [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

get config var values for given names

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

FLAGS
  --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
  --verbose                                                                         emit additional command output to
                                                                                    stdout

DESCRIPTION
  get config var values for given names

  Gets the Salesforce CLI configuration values for your default scratch org, your default Dev Hub org, your default
  instance URL, or any combination of the three. To see your default scratch org username, include 'defaultusername'.

  To see your default Dev Hub, include 'defaultdevhubusername'.

  To see your default instance URL, include 'instanceUrl'.

  To see the locations where your values are set, include the --verbose flag.

ALIASES
  $ sfdx force:config:get

EXAMPLES
  $ sfdx config:get defaultusername

  $ sfdx config:get defaultusername defaultdevhubusername instanceUrl

  $ sfdx config:get defaultusername defaultdevhubusername --verbose

See code: src/commands/config/get.ts

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

lists the config variables that the Salesforce CLI uses for various commands and tasks.

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

FLAGS
  --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

DESCRIPTION
  lists the config variables that the Salesforce CLI uses for various commands and tasks.

ALIASES
  $ sfdx force:config:list

See code: src/commands/config/list.ts

`sfdx config:set name=value... [-g] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

sets the configuration variables that the Salesforce CLI uses for various commands and tasks.

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

FLAGS
  -g, --global                                                                      set config var globally (to be used
                                                                                    from any directory)
  --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

DESCRIPTION
  sets the configuration variables that the Salesforce CLI uses for various commands and tasks.

  Local variables apply only to your current project. Global variables apply in any directory.

ALIASES
  $ sfdx force:config:set

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

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

See code: src/commands/config/set.ts

`sfdx config:unset [-g] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

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

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

FLAGS
  -g, --global                                                                      unset config var globally (to be
                                                                                    used from any directory)
  --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

DESCRIPTION
  unsets the local and global configuration variables for the Salesforce CLI.

  Local variables apply only to your current project. Global variables apply in any directory.

EXAMPLES
  $ sfdx config:unset defaultusername defaultdevhubusername

  $ sfdx config:unset defaultdevhubusername -g

See code: src/commands/config/unset.ts

`sfdx force:config:get [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

get config var values for given names

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

FLAGS
  --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
  --verbose                                                                         emit additional command output to
                                                                                    stdout

DESCRIPTION
  get config var values for given names

  Gets the Salesforce CLI configuration values for your default scratch org, your default Dev Hub org, your default
  instance URL, or any combination of the three. To see your default scratch org username, include 'defaultusername'.

  To see your default Dev Hub, include 'defaultdevhubusername'.

  To see your default instance URL, include 'instanceUrl'.

  To see the locations where your values are set, include the --verbose flag.

ALIASES
  $ sfdx force:config:get

EXAMPLES
  $ sfdx config:get defaultusername

  $ sfdx config:get defaultusername defaultdevhubusername instanceUrl

  $ sfdx config:get defaultusername defaultdevhubusername --verbose

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

lists the config variables that the Salesforce CLI uses for various commands and tasks.

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

FLAGS
  --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

DESCRIPTION
  lists the config variables that the Salesforce CLI uses for various commands and tasks.

ALIASES
  $ sfdx force:config:list

`sfdx force:config:set name=value... [-g] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

sets the configuration variables that the Salesforce CLI uses for various commands and tasks.

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

FLAGS
  -g, --global                                                                      set config var globally (to be used
                                                                                    from any directory)
  --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

DESCRIPTION
  sets the configuration variables that the Salesforce CLI uses for various commands and tasks.

  Local variables apply only to your current project. Global variables apply in any directory.

ALIASES
  $ sfdx force:config:set

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

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

@salesforce/plugin-config dependencies

tslib @oclif/core @salesforce/core @salesforce/command

FAQs

What is @salesforce/plugin-config?

configure the Salesforce CLI. Visit Snyk Advisor to see a full health score report for @salesforce/plugin-config, including popularity, security, maintenance & community analysis.

Is @salesforce/plugin-config popular?

The npm package @salesforce/plugin-config receives a total of 8,842 weekly downloads. As such, @salesforce/plugin-config popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @salesforce/plugin-config well maintained?

We found indications that @salesforce/plugin-config is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @salesforce/plugin-config safe to use?

While scanning the latest version of @salesforce/plugin-config, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 14 November-2024, at 20:34 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP