https://github.com/stryker-mutator/stryker-cli

The command-line interface for Stryker, the JavaScript mutation testing framework
https://github.com/stryker-mutator/stryker-cli

cli javascript mutation-testing stryker

Last synced: 3 months ago
JSON representation

The command-line interface for Stryker, the JavaScript mutation testing framework

• Host: GitHub
• URL: https://github.com/stryker-mutator/stryker-cli
• Owner: stryker-mutator
• License: apache-2.0
• Created: 2017-01-28T11:12:52.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T00:52:14.000Z (about 2 years ago)
• Last Synced: 2024-09-17T19:56:36.530Z (4 months ago)
• Topics: cli, javascript, mutation-testing, stryker
• Language: TypeScript
• Homepage: http://stryker-mutator.github.io
• Size: 381 KB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/stryker-mutator/stryker-cli.svg?branch=master)](https://travis-ci.org/stryker-mutator/stryker-cli)

[![Gitter](https://badges.gitter.im/stryker-mutator/stryker.svg)](https://gitter.im/stryker-mutator/stryker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

![Stryker](https://github.com/stryker-mutator/stryker/raw/master/stryker-80x80.png)

# Stryker Command-Line Interface

This is the command-line interface (CLI) for [Stryker](https://stryker-mutator.github.io), 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.

# Installation

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.

# Usage 

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.

# More

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

```

$ stryker --help

```