Introduction
This package is a Node.js implementation of the force-cli. It integrates with the Heroku Toolbelt.
Installing the Latest Stable Version
- Install the heroku toolbelt:
https://toolbelt.heroku.com/
- Run
heroku plugins:install force-cli-dev
(confirm success with heroku plugins
)
Getting Started as a Dev
- 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. - Install typescript and gulp by doing
npm install -g gulp-cli
- Check out this repository using
git clone git@git.soma.salesforce.com:DevTools/force-cli.git
- Change to the directory where you checked out the code
- If you want to resolve the salesforce-alm-dev module from a local path execute
npm link ../<path-to-force-com-toolbelt>
- Execute
npm install
- To build, execute
gulp test
- To install the plugin to Toolbelt, execute
heroku plugins:link .
Running Tests
- Unit tests:
gulp test
- Integration tests:
gulp test -i --instance=<instance> --username=<username> --password=<password>
- Specific tests:
gulp test --grep=<test name pattern> [-i] [--instance=<instance> --username=<username> --password=<password>]
- All tests:
gulp test --instance=<instance> --username=<username> --password=<password>
Notes
- 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