---
permalink: /plugins/pause
editLink: false
sidebar: auto
title: pause
---

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## pause

Pauses test execution interactively. Replaces the legacy `pauseOnFail`
plugin. The default `on=fail` matches the old `pauseOnFail` behavior.

#### Configuration

```js
plugins: {
  pause: {
    enabled: false,
    on: 'fail',
  }
}
```

#### `on=` modes

*   **fail** — pause when a step fails (default)
*   **test** — pause after each test
*   **step** — pause before the first step (interactive walk-through)
*   **file** — pause when execution reaches `path=...[;line=...]`
*   **url** — pause when the browser URL matches `pattern=...`

CLI examples:

    npx codeceptjs run -p pause
    npx codeceptjs run -p pause:on=step
    npx codeceptjs run -p pause:on=file:path=tests/login_test.js;line=43
    npx codeceptjs run -p pause:on=url:pattern=/users/*

### Parameters

*   `config`