Skip to content
Command line interface for Cavy
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Cavy logo


npm version

cavy-cli is a command line interface for Cavy, a cross-platform integration test framework for React Native, by Pixie Labs.

Getting started

Get set up with Cavy and cavy-cli by following our installation guide.

You might also want to check out some articles and watch talks about Cavy to find out a bit more before you write code.

We use cavy-cli to test Cavy itself! Check out our sample app Circle CI configuration for inspiration.


  • Output to a report file so continuous integration tools can give a richer report of what tests passed/failed.
  • Output the test results in progress, not just when they are all finished.
  • Handle when Cavy never runs; time out if the app doesn't boot after a certain amount of time.
  • Get a working example of an Android build in CI. We couldn't get an Android emulator running properly in Circle CI. If you have an example of cavy-cli working in CI for Android builds, please get in touch!


Before contributing, please read the code of conduct.

You can test your local version of cavy-cli by running npm link within the cavy-cli folder. This will make it so cavy is pointing to the cavy.js script in your local copy of cavy-cli. See the documentation for npm link for more information.

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Please try not to mess with the package.json, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so we can cherry-pick around it.
You can’t perform that action at this time.