webdriverio-workflo/docs/guide/services/screenshots-cleanup.md

This is a customized version of webdriverio for use with workflo framework.

name: Screenshots Cleanup
category: services
tags: guide
index: 14
title: WebdriverIO - Screenshots Cleanup Service
---

WDIO Screenshots Cleanup Service
============================

> Wdio service to cleanup screenshots before tests run.

## Installation

The easiest way is to keep `wdio-screenshots-cleanup-service` as a devDependency in your `package.json`.

```json
{
  "devDependencies": {
    "wdio-screenshots-cleanup-service": "~0.0.7"
  }
}
```

You can simple do it by:

```bash
yarn add wdio-screenshots-cleanup-service -D
```

Instructions on how to install `WebdriverIO` can be found [here.](http://webdriver.io/guide/getstarted/install.html)

## Usage

```js
// wdio.conf.js
export.config = {
  // ...
  services: ['screenshots-cleanup'],
  // clean screenshots
  cleanScreenshotsFolder: {
    folder: 'screenshots',
    pattern: '/**/ERROR_*'
  },
  // ...
};
```

Where:
  - `folder` is absolute or relative path to your project screenshots folder
  - `pattern` is optional property to tell `wdio-screenshots-cleanup-service` what pattern to apply before deleting screenshots