Package Exports

@salesforce/command
@salesforce/command/lib/exported.js
@salesforce/command/lib/sfdxFlags
@salesforce/command/lib/sfdxFlags.js
@salesforce/command/lib/test
@salesforce/command/lib/test/index.js
@salesforce/command/lib/ux
@salesforce/command/lib/ux.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@salesforce/command) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🛑 deprecation notice

This library is deprecated. You should migrate to https://github.com/salesforcecli/sf-plugins-core.

A migration guide is provided in the sf wiki https://github.com/salesforcecli/cli/wiki/Migrate-Plugins-Built-For-Sfdx

Description

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 and is available within a plug-in generated by Salesforce Plug-In Generator.

Usage

Check Your Salesforce CLI Version

Commands that extend SfdxCommand can only be used with Salesforce CLI version 6.8.2 or later. To check your Salesforce CLI version:

$ sfdx version
sfdx-cli/6.42.0-ae478b3cb8 (darwin-x64) node-v8.9.4

Features

To learn more about the features of the Command Library see the Salesforce CLI Plug-In Developer Guide.

Contributing

If you are interested in contributing, please take a look at the CONTRIBUTING guide.

Development

If you are interested in building this package locally, please take a look at the DEVELOPING doc.

@salesforce/command - Contains the base Salesforce CLI command, SfdxCommand.
@oclif/command - Contains the base oclif Command, which SfdxCommand extends.
@salesforce/plugin-generator - The generator plug-in for building plug-ins for Salesforce CLI.

Issues

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

@salesforce/command