| 1 | # :stop_sign: deprecation notice
|
| 2 |
|
| 3 | This library is deprecated. You should migrate to https://github.com/salesforcecli/sf-plugins-core.
|
| 4 |
|
| 5 | A migration guide is provided in the `sf` wiki https://github.com/salesforcecli/cli/wiki/Migrate-Plugins-Built-For-Sfdx
|
| 6 |
|
| 7 | > [](https://www.npmjs.com/package/@salesforce/command)
|
| 8 |
|
| 9 | # Description
|
| 10 |
|
| 11 | This 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.
|
| 12 |
|
| 13 | ## Usage
|
| 14 |
|
| 15 | ### Check Your Salesforce CLI Version
|
| 16 |
|
| 17 | Commands that extend `SfdxCommand` can only be used with Salesforce CLI version 6.8.2 or later. To check your Salesforce CLI version:
|
| 18 |
|
| 19 | ```bash
|
| 20 | $ sfdx version
|
| 21 | sfdx-cli/6.42.0-ae478b3cb8 (darwin-x64) node-v8.9.4
|
| 22 | ```
|
| 23 |
|
| 24 | ### Features
|
| 25 |
|
| 26 | To 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)_.
|
| 27 |
|
| 28 | ## Contributing
|
| 29 |
|
| 30 | If you are interested in contributing, please take a look at the [CONTRIBUTING](https://github.com/salesforcecli/command/blob/main/CONTRIBUTING.md) guide.
|
| 31 |
|
| 32 | ## Development
|
| 33 |
|
| 34 | If 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.
|
| 35 |
|
| 36 | ## Related Docs and Repositories
|
| 37 |
|
| 38 | - [@salesforce/command](https://github.com/salesforcecli/command) - Contains the base Salesforce CLI command, `SfdxCommand`.
|
| 39 | - [@oclif/command](https://github.com/oclif/command) - Contains the base oclif `Command`, which `SfdxCommand` extends.
|
| 40 | - [@salesforce/plugin-generator](https://github.com/forcedotcom/sfdx-plugin-generate) - The generator plug-in for building plug-ins for Salesforce CLI.
|
| 41 |
|
| 42 | ## Issues
|
| 43 |
|
| 44 | Please report any issues here: https://github.com/forcedotcom/cli/issues
|