# force-cli

> The Force.com CLI allows you to work with Force.com data directly from the command line. You can browse and create Force.com objects, view, edit, create, and delete records, execute APEX code and SOQL queries, and more.

Latest version **39.14.0** (published 2017-05-18) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install force-cli
pnpm add force-cli
yarn add force-cli
bun add force-cli
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 39.14.0 |
| Published | 2017-05-18 |
| First published | 2017-05-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.2.0 |
| Dependencies | 11 |
| Known vulnerabilities | 0 (+4 in 3 direct dependencies) |
| Install scripts | no |
| Author | Platform Developer Tools @ Salesforce |
| Maintainers | jgrantham |
| Keywords | salesforce, salesforce.com, sfdc, force.com |

## Links

- npm: https://www.npmjs.com/package/force-cli
- npm.io page: https://npm.io/package/force-cli

## Dependencies (11)

- [xml2js](https://npm.io/package/xml2js.md) 0.4.17
- [jsforce](https://npm.io/package/jsforce.md) 1.6.3
- [request](https://npm.io/package/request.md) 2.79.0
- [csv-parse](https://npm.io/package/csv-parse.md) 1.1.2
- [pluralize](https://npm.io/package/pluralize.md) 3.0.0
- [@types/xml2js](https://npm.io/package/@types/xml2js.md) 0.0.28
- [readline-sync](https://npm.io/package/readline-sync.md) 1.4.4
- [salesforce-alm](https://npm.io/package/salesforce-alm.md) 39.14.0
- [heroku-cli-util](https://npm.io/package/heroku-cli-util.md) 6.0.11
- [@types/csv-parse](https://npm.io/package/@types/csv-parse.md) 1.1.5
- [@types/pluralize](https://npm.io/package/@types/pluralize.md) 0.0.27

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

- 39.14.0 (latest) — 2017-05-18
- 39.13.1 — 2017-05-16

## README

Introduction
===

This package is a Node.js implementation of the [force-cli](https://force-cli.heroku.com/). It integrates with the [Heroku Toolbelt](https://toolbelt.heroku.com/).

Installing the Latest Stable Version
===

1. Install the heroku toolbelt: `https://toolbelt.heroku.com/`
1. Run `heroku plugins:install force-cli-dev` (confirm success with `heroku plugins`)

Getting Started as a Dev
===

1. Install Node.js. If you are on the mac, please use [Homebrew](http://brew.sh/) and execute `brew install node`. Ensure that you have version > 6.2.0.
1. Install typescript and gulp by doing `npm install -g gulp-cli`
1. Check out this repository using `git clone git@git.soma.salesforce.com:DevTools/force-cli.git`
1. Change to the directory where you checked out the code
1. If you want to resolve the salesforce-alm-dev module from a local path execute `npm link ../<path-to-force-com-toolbelt>`
1. Execute `npm install`
1. To build, execute `gulp test`
1. To install the plugin to Toolbelt, execute `heroku plugins:link .`

Running Tests
==

1. Unit tests: `gulp test`
1. Integration tests: `gulp test -i --instance=<instance> --username=<username> --password=<password>`
1. Specific tests: `gulp test --grep=<test name pattern> [-i] [--instance=<instance> --username=<username> --password=<password>]`
1. All tests: `gulp test --instance=<instance> --username=<username> --password=<password>`

Notes
==
1. To debug integration tests, you have to pass in the login credentials as environment variables like so: FORCE_CLI_TEST_INTEGRATION=true FORCE_CLI_TEST_INSTANCE=<instance> FORCE_CLI_TEST_USERNAME=<username> FORCE_CLI_TEST_PASSWORD=<password> mocha --debug-brk dist/test/integration/integrationTest.js

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