Getting the Most Out of the Rainforest CLI title image

Getting the Most Out of the Rainforest CLI

While Rainforest has an intuitive UI where you can manage test cases and review your results, many teams like to have a workflow-native alternative for test execution. For dev-centric teams who are comfortable with technical solutions, or who use continuous integration and continuous delivery methods, the Rainforest command line interface (CLI) provides a more streamlined way to initiate test runs.

How Teams are Using the Rainforest CLI

Over 30% of all the test runs in Rainforest are executed via our command line interface, allowing technical users to initiate tests from any script and better integrate QA into their development process. Here are just a few examples of how teams are using the CLI:

  • Guru doesn’t have an in-house QA team and relies on developers to own their own code quality. The team at Guru uses the Rainforest CLI along with Rainforest DevX, which allows developers to write tests in their code editor, then kick them off without leaving their workflow. As a result, the team is able to stay focused on development without sacrificing testing. Find out more about Guru's dev team.
  • GrowthHackers moved their testing process in-house after relying on an outsourced team, and wanted to make sure that QA didn’t start eating up developer time. They use the CLI to easily initiate tests multiple times per week at night, then review the results in the morning. Learn how GrowthHackers is using Rainforest.
  • Exaptive has used the Rainforest CLI to speed up their QA process and streamline testing, allowing them to release more frequently. Because Rainforest fits into their development workflow, Exaptive’s developers are getting more involved in the testing process. “Everyone has bought into the efficacy of [Rainforest], and now they’re seeing how easy it is to add to the test suite, so they’re jumping in to do it,” says Engineering Directory Cory White. Read Exaptive's story.

Here are the steps you’ll need to take to get your Rainforest CLI up and running.

1. Install the CLI

Visit our CLI page to download the rainforest-cli file and install it. We support Mac, Windows and Linux.

2. Retrieve your API token

In your Rainforest account, go to Settings > Integrations and copy your API token. This token is unique to each user in your company account.

3. Run your first test

To run your first test, go to your terminal window and try the following basic command. The test ID can be found on any test page, next to the title.

rainforest run  --token
For example, to run test ID 1 using your token xyz, the command would look like this:
rainforest run 1 --token xyz
Voilà! You ran your first test from the CLI. To perform other commands, check out the CLI documentation on our GitHub page. Watch the video below to see how it works in action:

Integrating Rainforest into your Development Workflow

Rainforest is designed to fit seamlessly into developer workflows and bring QA closer to development. Learn more about setting up your CLI for Continuous Integration here.