Cavy

Cavy

  • Documentation
  • API
  • GitHub
  • Roadmap
  • FAQ

›Getting Started

Getting Started

  • Installing
  • Setting up the Cavy Tester
  • Writing tests

    • Hooking up components
    • Writing test cases
  • Running tests
  • Sample app

API reference

  • Tester Component
  • Test Hooks
  • Test Helpers
  • CLI Commands
  • Filtering tests
  • Cavy Native Reporter

Guides

  • Specifing a custom app entry point
  • Writing your own spec helpers
  • Writing your own custom reporter
  • Cavy Native Reporter

    • Using Cavy Native Reporter
    • iOS XCTest example (Obj-C)
    • iOS XCTest example (Swift)
    • Android example (JUnit)

Installing

To make it easier to get set up and testing, Cavy provides a command-line interface (called cavy-cli). We recommend you get started with this.

You can also run Cavy tests without cavy-cli. In which case, skip the CLI installation step and just install cavy. You may want to do this if you're integrating Cavy with your own custom reporting (e.g. Cavy Native Reporter).

Install cavy-cli globally using yarn or npm:

yarn global add cavy-cli

Add Cavy to your React Native project as a development dependency:

yarn add cavy --dev

Using TypeScript

If you're using TypeScript, you'll also need to install the types package:

yarn add @types/cavy --dev
Setting up the Cavy Tester →
Pixie Labs
Docs
Getting StartedGuidesAPI Reference
Community
HelpContributorsFurther reading
More
GitHub
StarFollow @pixielabsTweet
Cavy
Copyright © 2021 Pixie Labs