{"__v":16,"_id":"566f59c4fc3abb0d0020fcd5","category":{"__v":12,"_id":"559b65be8b04e90d00702d58","pages":["559b65bf8b04e90d00702d5a","55a46241ffd44e0d00fca056","55a46f45e75ca60d00a39323","55a470b768c7e20d0036d4d6","55a4a758dad9d00d0071fcba","55b6b6276127b12500364560","55baf505d0736b3100bf1033","55c25ef1f2cff20d006d0b8a","56269a8b44c87f0d00fe6378","56498f62f176080d000c78ac","566f59c4fc3abb0d0020fcd5","567cd2228eb5b20d0021059d"],"project":"559b65bd8b04e90d00702d54","version":"559b65bd8b04e90d00702d57","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-07T05:38:06.409Z","from_sync":false,"order":0,"slug":"chimpjs","title":"Chimp.js"},"parentDoc":null,"project":"559b65bd8b04e90d00702d54","user":"559b658d8b04e90d00702d52","version":{"__v":6,"_id":"559b65bd8b04e90d00702d57","project":"559b65bd8b04e90d00702d54","createdAt":"2015-07-07T05:38:05.890Z","releaseDate":"2015-07-07T05:38:05.890Z","categories":["559b65be8b04e90d00702d58","55a46e7468c7e20d0036d4d1","55a4971be6c2470d002a6483","55a4a690e10ba50d00b40bba","55a4bcf31a5f991700a94066","56cf5c8d336aa60b0086a40d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["57b8a283c88a1e0e00f27985"],"next":{"pages":[],"description":""},"createdAt":"2015-12-15T00:07:32.264Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"## Prerequisite\n\n**Oracle JDK v1.8+** ([Download Here](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html))\nYou can check your Java version in the terminal with `java -version` (single dash) \n\nBe sure to install the **JDK** not the JRE.\n\n## Global Installation\n\n```bash\nnpm install -g chimp\n```\nTry not to use `sudo`. If you have any trouble, use the alternative method below.\n\n## Local Installation\n\nIf you have trouble installing globally, you can also install locally using this command:\n\n```bash\nnpm install chimp\n```\n\nand then you can run using `./node_modules/.bin/chimp`\n\n## Gulp Installation\n\n[gulp-chimp](https://www.npmjs.com/package/gulp-chimp) is a wrapper to interact with Chimp.js in a gulp task.\n\n## Quick Install\n\nIn the terminal run the following command\n```\nnpm install gulp-chimp --save-dev\n```\n\n## Usage with chimp.conf.js file  [chimp.conf.js](https://github.com/eduardogch/gulp-chimp/blob/master/chimp.conf.js)\n\n```\nvar chimp = require('gulp-chimp');\n\n/* Chimp.js - Automated/e2e Testing with a config file */\ngulp.task('chimp', function () {\n    return chimp('./chimp.conf.js');\n});\n```\n\n## Cucumber HTML Report\n\n![alt tag](https://github.com/eduardogch/gulp-chimp/raw/master/cucumber-html-report.png)\n\n## Usage with chimp.js options\n\n```\n/* Chimp.js - Automated/e2e Testing with options */\ngulp.task('chimp-options', function () {\n    return chimp({\n        path: './source/e2e/features', // Cucumber features files\n        browser: 'phantomjs',\n        debug: true,\n        singleRun: false,\n        log: 'info',\n        timeout: 60000,\n        port: 2345,\n        reportHTML: true\n    });\n});\n```\n\n##### path\n\nType: `string`\nDefault: `./source/e2e/features`\n\n##### browser\n\nType: `string`\nDefault `chrome`\n\n##### singleRun\n\nType: `boolean`\nDefault `true`\n\n##### debug\n\nType: `boolean`\nDefault `false`\n\n##### log\n\nType: `string`\nDefault: `info`\n\n##### timeout\n\nType: `number`\nDefault `60000`\n\n##### port\n\nType: `number`\nDefault `2356`\n\n##### reportHTML\n\nType: `boolean`\nDefault `true`\n\n\n## Troubleshooting\n**Permission Denied**\nIf you get this error message:\n`Error: EACCES: permission denied, mkdir...`\n\nTry deleting the .selenium directory using:\n```bash\nsudo rm -rf /usr/local/lib/node_modules/chimp/node_modules/selenium-standalone/.selenium`\n```\n\n**Failed at the fibers**\nIf you get this error message:\n`npm ERR! Failed at the fibers:::at:::1.0.9 install script 'node build.js || nodejs build.js'.`\n\nUpgrade to Node 4.x+\n\n---\n\n<a href=\"http://quality.xolv.io/?utm_source=XolvOSS&utm_medium=OSSDocs&utm_content=ChimpRM-Footer&utm_campaign=QFLaunch\"><img src=\"https://files.readme.io/764e495-qualityfasterbook-commas.small.png\" width=\"200\" align=\"right\" /></a>\n##Learn the Fundamentals of Testing, Specifications and Become a Chimp Ninja!\n[Checkout our new book](http://quality.xolv.io/?utm_source=XolvOSS&utm_medium=OSSDocs&utm_content=ChimpRM-Footer&utm_campaign=QFLaunch) where you can learn how to can use Chimp across the Full Stack from React to Node.JS, Mocha, Meteor and more.\n\n\n**[Quality, Faster.](http://quality.xolv.io/?utm_source=XolvOSS&utm_medium=OSSDocs&utm_content=ChimpRM-Footer&utm_campaign=QFLaunch)** By Sam Hatoum, creator of Chimp.","excerpt":"","slug":"installation","type":"basic","title":"Installation"}
## Prerequisite **Oracle JDK v1.8+** ([Download Here](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)) You can check your Java version in the terminal with `java -version` (single dash) Be sure to install the **JDK** not the JRE. ## Global Installation ```bash npm install -g chimp ``` Try not to use `sudo`. If you have any trouble, use the alternative method below. ## Local Installation If you have trouble installing globally, you can also install locally using this command: ```bash npm install chimp ``` and then you can run using `./node_modules/.bin/chimp` ## Gulp Installation [gulp-chimp](https://www.npmjs.com/package/gulp-chimp) is a wrapper to interact with Chimp.js in a gulp task. ## Quick Install In the terminal run the following command ``` npm install gulp-chimp --save-dev ``` ## Usage with chimp.conf.js file [chimp.conf.js](https://github.com/eduardogch/gulp-chimp/blob/master/chimp.conf.js) ``` var chimp = require('gulp-chimp'); /* Chimp.js - Automated/e2e Testing with a config file */ gulp.task('chimp', function () { return chimp('./chimp.conf.js'); }); ``` ## Cucumber HTML Report ![alt tag](https://github.com/eduardogch/gulp-chimp/raw/master/cucumber-html-report.png) ## Usage with chimp.js options ``` /* Chimp.js - Automated/e2e Testing with options */ gulp.task('chimp-options', function () { return chimp({ path: './source/e2e/features', // Cucumber features files browser: 'phantomjs', debug: true, singleRun: false, log: 'info', timeout: 60000, port: 2345, reportHTML: true }); }); ``` ##### path Type: `string` Default: `./source/e2e/features` ##### browser Type: `string` Default `chrome` ##### singleRun Type: `boolean` Default `true` ##### debug Type: `boolean` Default `false` ##### log Type: `string` Default: `info` ##### timeout Type: `number` Default `60000` ##### port Type: `number` Default `2356` ##### reportHTML Type: `boolean` Default `true` ## Troubleshooting **Permission Denied** If you get this error message: `Error: EACCES: permission denied, mkdir...` Try deleting the .selenium directory using: ```bash sudo rm -rf /usr/local/lib/node_modules/chimp/node_modules/selenium-standalone/.selenium` ``` **Failed at the fibers** If you get this error message: `npm ERR! Failed at the fibers@1.0.9 install script 'node build.js || nodejs build.js'.` Upgrade to Node 4.x+ --- <a href="http://quality.xolv.io/?utm_source=XolvOSS&utm_medium=OSSDocs&utm_content=ChimpRM-Footer&utm_campaign=QFLaunch"><img src="https://files.readme.io/764e495-qualityfasterbook-commas.small.png" width="200" align="right" /></a> ##Learn the Fundamentals of Testing, Specifications and Become a Chimp Ninja! [Checkout our new book](http://quality.xolv.io/?utm_source=XolvOSS&utm_medium=OSSDocs&utm_content=ChimpRM-Footer&utm_campaign=QFLaunch) where you can learn how to can use Chimp across the Full Stack from React to Node.JS, Mocha, Meteor and more. **[Quality, Faster.](http://quality.xolv.io/?utm_source=XolvOSS&utm_medium=OSSDocs&utm_content=ChimpRM-Footer&utm_campaign=QFLaunch)** By Sam Hatoum, creator of Chimp.