# @salesforce/command

> Salesforce CLI base command class

Latest version **5.3.9** (published 2023-05-27) · BSD-3-Clause license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @salesforce/command
pnpm add @salesforce/command
yarn add @salesforce/command
bun add @salesforce/command
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.3.9 |
| Published | 2023-05-27 |
| First published | 2018-03-22 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 6 |
| Unpacked size | 165.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | jburnie, abirchfieldsfdc, dlouvton, mobify, dme722, jmsjtu, maliroteh-sf, jasonschroeder-sfdc, packagellama, vttikoo, maward, danielshox, duane.chew, dferro, jcourtner, jye-sf, adirasanam, hkii, iamaziz, jc-sf, dbreese-salesforce, ashokrudraraju, dhersam, demianbrecht, mbettio, damilareolowoniyi, mmadialagan, spoorti.nidagundi, mjrust, salesforce-releases, joshwlewis, mpsenn, sfdc_iamigo, kevinv11n, byao, pmdartus, ekashida, gr8gatsby, ravi.jayaramappa, apapko, jleen-sfdc, jqian, cwallsf, dhagberg-sf, khawkins, amphro, tconn, dehru, jodarove, sfdctaka, fernomac, jimjag, ivarley, jbartolotta-sfdc |
| Keywords | force, salesforce, sfdx, salesforcedx, sfdx-command |

## Links

- npm: https://www.npmjs.com/package/@salesforce/command
- Repository: https://github.com/salesforcecli/command
- Homepage: https://github.com/salesforcecli/command#readme
- Issues: https://github.com/salesforcecli/command/issues
- npm.io page: https://npm.io/package/@salesforce/command

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1.25.0
- [@oclif/test](https://npm.io/package/@oclif/test.md) ^2.2.21
- [@salesforce/kit](https://npm.io/package/@salesforce/kit.md) ^1.8.5
- [@salesforce/core](https://npm.io/package/@salesforce/core.md) ^3.36.2
- [@salesforce/ts-types](https://npm.io/package/@salesforce/ts-types.md) ^1.7.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 5.3.9 (latest) — 2023-05-27
- 3.2.0-beta-2 (ts4) — 2021-06-03
- 5.3.8 — 2023-05-13
- 5.3.7 — 2023-04-29
- 5.3.6 — 2023-04-22
- 5.3.5 — 2023-04-01
- 5.3.4 — 2023-03-18
- 5.3.3 — 2023-03-05
- 5.3.2 — 2023-02-25
- 5.3.1 — 2023-02-18
- 5.3.0 — 2023-02-07
- 5.2.43 — 2023-01-28
- 5.2.42 — 2023-01-22
- 5.2.41 — 2023-01-18
- 5.2.40 — 2023-01-08
- … 109 more at https://npm.io/package/@salesforce/command/versions

## README

# :stop_sign: 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

> [![NPM](https://img.shields.io/npm/v/@salesforce/command.svg)](https://www.npmjs.com/package/@salesforce/command)

# 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](https://github.com/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:

```bash
$ 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](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins.htm)_.

## Contributing

If you are interested in contributing, please take a look at the [CONTRIBUTING](https://github.com/salesforcecli/command/blob/main/CONTRIBUTING.md) guide.

## Development

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.

## Related Docs and Repositories

- [@salesforce/command](https://github.com/salesforcecli/command) - Contains the base Salesforce CLI command, `SfdxCommand`.
- [@oclif/command](https://github.com/oclif/command) - Contains the base oclif `Command`, which `SfdxCommand` extends.
- [@salesforce/plugin-generator](https://github.com/forcedotcom/sfdx-plugin-generate) - The generator plug-in for building plug-ins for Salesforce CLI.

## Issues

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

---
_Source: https://npm.io/package/@salesforce/command · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._