https://github.com/metaware/rainforest
Rainforest CLI written in NodeJS
https://github.com/metaware/rainforest
Last synced: 4 months ago
JSON representation
Rainforest CLI written in NodeJS
- Host: GitHub
- URL: https://github.com/metaware/rainforest
- Owner: metaware
- License: mit
- Created: 2013-12-03T15:53:15.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-01-08T22:56:08.000Z (over 10 years ago)
- Last Synced: 2025-10-20T12:44:54.201Z (8 months ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# rainforest [](https://travis-ci.org/metaware/rainforest) [](https://codeclimate.com/github/jasdeepsingh/rainforest)
A command line interface to interact with RainforestQA.
## Installation
```
$ npm install -g rainforest
```
**Make sure you install it globally so that the rainforest command is accessible from anywhere on your system**
## Examples
To use the CLI client, you'll need your API token from a test settings page from inside [Rainforest](https://app.rainforestqa.com/).
Run all of your tests
rainforest run --all --token YOUR_TOKEN_HERE
Run tests with test ids `123`, `345`
rainforest run --tests 123,345 --token YOUR_TOKEN_HERE
Run all tests with tags `tag1`, `tag2`, `tag3`
rainforest run --tags tag1,tag2,tag3 --token YOUR_TOKEN_HERE
Run all tests with tag `tag1` and on browsers `chrome` and `safari`
rainforest run --tags tag1 --browsers chrome,safari --token YOUR_TOKEN_HERE
Run all tests with tag `tag1` and also specify a webhook where Rainforest can POST a notification back
rainforest run --tags tag1 --webhook http://your-url.com/callback --token YOUR_TOKEN_HERE
Run all tests with tag `tag1` and abort any previous runs for this test suite
rainforest run --tags tag1 --conflict abort --token YOUR_TOKEN_HERE
## Documentation
```
Usage: rainforest run [options]
Options:
-h, --help output usage information
-a, --all Run All Tests
-t, --tags Specify test tags you want to use
-b, --browsers Specify which browsers you want to test against
-x, --tests Specify comma seperated test IDs to execute
-w, --webhook Specify if you would like to use a webhook URL
-c, --conflict Specify if you would like to abort previously running tests
--token Assign your API token for this command
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
**You get extra attention, if your PR includes specs/tests.**
1. Fork or clone the project.
2. Create your feature branch (`$ git checkout -b my-new-feature`)
3. Install the dependencies by doing: `$ npm install` in the project directory.
4. Run the specs runner/project watcher by doing `$ grunt`
- Now, any time you change files, specs will run. Sort of like Guard for Ruby projects.
5. Add your bug fixes or new feature code.
- New features should include new specs/tests.
- Bug fixes should ideally include exposing specs/tests.
6. Commit your changes (`$ git commit -am 'Add some feature'`)
7. Push to the branch (`$ git push origin my-new-feature`)
8. Open your Pull Request!
## License
Copyright (c) 2013 Jasdeep Singh
Licensed under the MIT license.