# grunt-chrome-headless

> Start a Google Chrome headless instance.

Latest version **0.1.1** (published 2017-11-16) · 0 weekly downloads

## Install

```sh
npm install grunt-chrome-headless
pnpm add grunt-chrome-headless
yarn add grunt-chrome-headless
bun add grunt-chrome-headless
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2017-11-16 |
| First published | 2017-11-16 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Philipp Gildein |
| Maintainers | rmbl |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-chrome-headless
- Repository: https://github.com/rmbl/grunt-chrome-headless
- Issues: https://github.com/rmbl/grunt-chrome-headless/issues
- npm.io page: https://npm.io/package/grunt-chrome-headless

## Dependencies (1)

- [which](https://npm.io/package/which.md) ^1.3.0

## Recent versions

- 0.1.1 (latest) — 2017-11-16
- 0.1.0 — 2017-11-16

## README

# grunt-chrome-headless

> Start a Google Chrome headless instance.

## Getting Started
This plugin requires Grunt `1.0.0`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-chrome-headless --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-chrome-headless');
```

## The "chrome_headless" task

### Overview
In your project's Gruntfile, add a section named `chrome_headless` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  chrome_headless: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});
```

### Options

#### options.port
Type: `Int`
Default value: `9222`

The remote debugging port which Google Chrome should use.

#### options.bin
Type: `String`
Default value: ``

The full path under which Google Chrome can be found. By default `google-chrome`, `google-chrome-stable` and `chromium` are checked.

#### options.args
Type: `Array`
Default value: `[]`

Additional arguments to the command line.

### Usage Examples

#### Default Options

```js
grunt.initConfig({
  chrome_headless: {
    options: {
      port: 9222,
      bin: '/usr/bin/google-chrome'
    },
  },
});
```

#### Multiple instances
If you want to run multiple instances, use more than one target.

```js
grunt.initConfig({
  chrome_headless: {
    cucumber: {
      options: {
        port: 9222
      }
    },
    mocha: {
      options: {
        port: 9223
      }
    }
  },
});
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_0.1.0_
 - Initial release

---
_Source: https://npm.io/package/grunt-chrome-headless · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._