The CLI allows you to work with data directly from the command line. You can browse and create objects, view, edit, create, and delete records, execute APEX code and SOQL queries, and more.
Last updated 3 years ago by jgrantham .
Apache-2.0 · Original npm · Tarball · package.json
$ cnpm install force-cli 
SYNC missed versions from official npm registry.


This package is a Node.js implementation of the force-cli. It integrates with the Heroku Toolbelt.

Installing the Latest Stable Version

  1. Install the heroku toolbelt:
  2. 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 and execute brew install node. Ensure that you have version > 6.2.0.
  2. Install typescript and gulp by doing npm install -g gulp-cli
  3. Check out this repository using git clone
  4. Change to the directory where you checked out the code
  5. If you want to resolve the salesforce-alm-dev module from a local path execute npm link ../<path-to-force-com-toolbelt>
  6. Execute npm install
  7. To build, execute gulp test
  8. To install the plugin to Toolbelt, execute heroku plugins:link .

Running Tests

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


  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

Current Tags

  • 39.14.0                                ...           latest (3 years ago)

2 Versions

  • 39.14.0                                ...           3 years ago
  • 39.13.1                                ...           3 years ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 2
Dependencies (11)
Dev Dependencies (21)
Dependents (2)

Copyright 2014 - 2017 © |