UNPKG

1.86 kBMarkdownView Raw
1[![NPM](https://img.shields.io/npm/v/@salesforce/command.svg)](https://www.npmjs.com/package/@salesforce/command)
2
3# Description
4
5This package contains the base command class for Salesforce CLI, `SfdxCommand`. Extend this class for convenient access to common Salesforce CLI parameters, a logger, CLI output formatting, scratch orgs, and Dev Hubs. This class extends [@oclif/command](https://github.com/oclif/command) and is available within a plug-in generated by Salesforce Plug-In Generator.
6
7## Usage
8
9### Check Your Salesforce CLI Version
10
11Commands that extend `SfdxCommand` can only be used with Salesforce CLI version 6.8.2 or later. To check your Salesforce CLI version:
12
13```bash
14$ sfdx version
15sfdx-cli/6.42.0-ae478b3cb8 (darwin-x64) node-v8.9.4
16```
17
18### Features
19
20To learn more about the features of the Command Library see the _[Salesforce CLI Plug-In Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins.htm)_.
21
22## Contributing
23
24If you are interested in contributing, please take a look at the [CONTRIBUTING](https://github.com/salesforcecli/command/blob/main/CONTRIBUTING.md) guide.
25
26## Development
27
28If you are interested in building this package locally, please take a look at the [DEVELOPING](https://github.com/salesforcecli/command/blob/main/DEVELOPING.md) doc.
29
30## Related Docs and Repositories
31
32- [@salesforce/command](https://github.com/salesforcecli/command) - Contains the base Salesforce CLI command, `SfdxCommand`.
33- [@oclif/command](https://github.com/oclif/command) - Contains the base oclif `Command`, which `SfdxCommand` extends.
34- [@salesforce/plugin-generator](https://github.com/forcedotcom/sfdx-plugin-generate) - The generator plug-in for building plug-ins for Salesforce CLI.
35
36## Issues
37
38Please report any issues here: https://github.com/forcedotcom/cli/issues