This is the command-line interface (CLI) for Stryker, the JavaScript mutation testing framework.

If you plan on using Stryker in more projects, the Stryker-CLI is the easiest way to install, configure and run Stryker for your project.

The Stryker-CLI can be easily installed using NPM.

$ npm install -g stryker-cli

Please always install the Stryker-CLI globally with -g or --global. The Stryker-CLI does not include a copy of Stryker itself. Instead, it needs your local Stryker installation (i.e. the Stryker installation contained in your project's node_modules folder). If you don't have Stryker installed yet, the Stryker-CLI will help you with your Stryker installation. If you want to use stryker directly from npm scripts, feel free to do so without the Stryker-CLI. The Stryker-CLI's only task is to make Stryker more easy to use.

The Stryker-CLI works by passing received commands to your local Stryker installation. If you don't have Stryker installed yet, the Stryker-CLI will help you with your Stryker installation. This method allows us to provide additional commands with updates of Stryker itself.

For example, you can kick off mutation testing using:

$ stryker run

Please always execute the Styker-CLI commands from your project's root directory. Although we are able to find your local Stryker installation in parent folders, running Stryker from a different folder than your project's root directory may result in unexpected behavior.

To list all of the functionality available for Stryker through the Stryker-CLI, please execute the help command.

$ stryker --help