Introduction

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: https://toolbelt.heroku.com/
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 [email protected]:DevTools/force-cli.git
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>

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= FORCE_CLI_TEST_USERNAME= FORCE_CLI_TEST_PASSWORD= mocha --debug-brk dist/test/integration/integrationTest.js