codeceptjs 4.0.0-rc.23 → 4.0.0-rc.24

package/docs/plugins.md

@@ -1,909 +1,87 @@
 ---
-permalink: plugins
-sidebarDepth: 
+permalink: /plugins
+editLink: false
 sidebar: auto
 title: Plugins
 ---
 
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+# Plugins
 
-## aiTrace
+CodeceptJS bundles the following plugins. Each plugin has its own page with full configuration reference.
 
-Generates AI-friendly trace files for debugging with AI agents.
-This plugin creates a markdown file with test execution logs and links to all artifacts
-(screenshots, HTML, ARIA snapshots, browser logs, HTTP requests) for each step.
+## [pause](/plugins/pause)
 
-#### Configuration
+Pauses test execution interactively. Replaces the legacy `pauseOnFail` plugin. The default `on=fail` matches the old `pauseOnFail` behavior.
 
-```js
-"plugins": {
-   "aiTrace": {
-     "enabled": true
-   }
- }
-```
+## [pageInfo](/plugins/pageInfo)
 
-Possible config options:
+Collects information from web page after each failed test and adds it to the test as an artifact. It is suggested to enable this plugin if you run tests on CI and you need to debug failed tests. This plugin can be paired with `analyze` plugin to provide more context.
 
-*   `deleteSuccessful`: delete traces for successfully executed tests. Default: false.
-*   `fullPageScreenshots`: should full page screenshots be used. Default: false.
-*   `output`: a directory where traces should be stored. Default: `output`.
-*   `captureHTML`: capture HTML for each step. Default: true.
-*   `captureARIA`: capture ARIA snapshot for each step. Default: true.
-*   `captureBrowserLogs`: capture browser console logs. Default: true.
-*   `captureHTTP`: capture HTTP requests (requires `trace` or `recordHar` enabled in helper config). Default: true.
-*   `captureDebugOutput`: capture CodeceptJS debug output. Default: true.
-*   `ignoreSteps`: steps to ignore in trace. Array of RegExps is expected.
+## [expose](/plugins/expose)
 
-### Parameters
+Exposes properties from helper instances as injectable test arguments. Use it to access the underlying Playwright/Puppeteer `page`, the wdio `browser` client, or any other helper internal directly from a Scenario:
 
-*   `config` **any**&#x20;
-
-## analyze
-
-Uses AI to analyze test failures and provide insights
-
-This plugin analyzes failed tests using AI to provide detailed explanations and group similar failures.
-When enabled with --ai flag, it generates reports after test execution.
-
-#### Usage
-
-```js
-// in codecept.conf.js
-exports.config = {
-  plugins: {
-    analyze: {
-      enabled: true,
-      clusterize: 5,
-      analyze: 2,
-      vision: false
-    }
-  }
-}
-```
-
-#### Configuration
-
-*   `clusterize` (number) - minimum number of failures to trigger clustering analysis. Default: 5
-*   `analyze` (number) - maximum number of individual test failures to analyze in detail. Default: 2
-*   `vision` (boolean) - enables visual analysis of test screenshots. Default: false
-*   `categories` (array) - list of failure categories for classification. Defaults to:
-    *   Browser connection error / browser crash
-    *   Network errors (server error, timeout, etc)
-    *   HTML / page elements (not found, not visible, etc)
-    *   Navigation errors (404, etc)
-    *   Code errors (syntax error, JS errors, etc)
-    *   Library & framework errors
-    *   Data errors (password incorrect, invalid format, etc)
-    *   Assertion failures
-    *   Other errors
-*   `prompts` (object) - customize AI prompts for analysis
-    *   `clusterize` - prompt for clustering analysis
-    *   `analyze` - prompt for individual test analysis
-
-#### Features
-
-*   Groups similar failures when number of failures >= clusterize value
-*   Provides detailed analysis of individual failures
-*   Analyzes screenshots if vision=true and screenshots are available
-*   Classifies failures into predefined categories
-*   Suggests possible causes and solutions
-
-### Parameters
-
-*   `config` **[Object][1]** Plugin configuration (optional, default `{}`)
-
-Returns **void**&#x20;
-
-## auth
-
-Logs user in for the first test and reuses session for next tests.
-Works by saving cookies into memory or file.
-If a session expires automatically logs in again.
-
-> For better development experience cookies can be saved into file, so a session can be reused while writing tests.
-
-#### Usage
-
-1.  Enable this plugin and configure as described below
-2.  Define user session names (example: `user`, `editor`, `admin`, etc).
-3.  Define how users are logged in and how to check that user is logged in
-4.  Use `login` object inside your tests to log in:
-
-```js
-// inside a test file
-// use login to inject auto-login function
-Feature('Login');
-
-Before(({ login }) => {
-   login('user'); // login using user session
-});
-
-// Alternatively log in for one scenario.
-Scenario('log me in', ( { I, login } ) => {
-   login('admin');
-   I.see('I am logged in');
-});
-```
-
-#### Configuration
-
-*   `saveToFile` (default: false) - save cookies to file. Allows to reuse session between execution.
-*   `inject` (default: `login`) - name of the login function to use
-*   `users` - an array containing different session names and functions to:
-    *   `login` - sign in into the system
-    *   `check` - check that user is logged in
-    *   `fetch` - to get current cookies (by default `I.grabCookie()`)
-    *   `restore` - to set cookies (by default `I.amOnPage('/'); I.setCookie(cookie)`)
-
-#### How It Works
-
-1.  `restore` method is executed. It should open a page and set credentials.
-2.  `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged-in user. When you pass the second args `session`, you could perform the validation using passed session.
-3.  If `restore` and `check` were not successful, `login` is executed
-4.  `login` should fill in login form
-5.  After successful login, `fetch` is executed to save cookies into memory or file.
-
-#### Example: Simple login
-
-```js
-auth: {
-  enabled: true,
-  saveToFile: true,
-  inject: 'login',
-  users: {
-    admin: {
-      // loginAdmin function is defined in `steps_file.js`
-      login: (I) => I.loginAdmin(),
-      // if we see `Admin` on page, we assume we are logged in
-      check: (I) => {
-         I.amOnPage('/');
-         I.see('Admin');
-      }
-    }
-  }
-}
-```
-
-#### Example: Multiple users
-
-```js
-auth: {
-  enabled: true,
-  saveToFile: true,
-  inject: 'loginAs', // use `loginAs` instead of login
-  users: {
-    user: {
-      login: (I) => {
-         I.amOnPage('/login');
-         I.fillField('email', 'user@site.com');
-         I.fillField('password', '123456');
-         I.click('Login');
-      },
-      check: (I) => {
-         I.amOnPage('/');
-         I.see('User', '.navbar');
-      },
-    },
-    admin: {
-      login: (I) => {
-         I.amOnPage('/login');
-         I.fillField('email', 'admin@site.com');
-         I.fillField('password', '123456');
-         I.click('Login');
-      },
-      check: (I) => {
-         I.amOnPage('/');
-         I.see('Admin', '.navbar');
-      },
-    },
-  }
-}
-```
-
-#### Example: Keep cookies between tests
-
-If you decide to keep cookies between tests you don't need to save/retrieve cookies between tests.
-But you need to login once work until session expires.
-For this case, disable `fetch` and `restore` methods.
-
-```js
-helpers: {
-   WebDriver: {
-     // config goes here
-     keepCookies: true; // keep cookies for all tests
-   }
-},
-plugins: {
-   auth: {
-     users: {
-       admin: {
-         login: (I) => {
-           I.amOnPage('/login');
-           I.fillField('email', 'admin@site.com');
-           I.fillField('password', '123456');
-           I.click('Login');
-         },
-         check: (I) => {
-           I.amOnPage('/dashboard');
-           I.see('Admin', '.navbar');
-         },
-         fetch: () => {}, // empty function
-         restore: () => {}, // empty funciton
-       }
-    }
-  }
-}
-```
-
-#### Example: Getting sessions from local storage
-
-If your session is stored in local storage instead of cookies you still can obtain sessions.
-
-```js
-plugins: {
-   auth: {
-    admin: {
-      login: (I) => I.loginAsAdmin(),
-      check: (I) => I.see('Admin', '.navbar'),
-      fetch: (I) => {
-        return I.executeScript(() => localStorage.getItem('session_id'));
-      },
-      restore: (I, session) => {
-        I.amOnPage('/');
-        I.executeScript((session) => localStorage.setItem('session_id', session), session);
-      },
-    }
-  }
-}
-```
-
-#### Tips: Using async function in the auth
-
-If you use async functions in the auth plugin, login function should be used with `await` keyword.
-
-```js
-auth: {
-  enabled: true,
-  saveToFile: true,
-  inject: 'login',
-  users: {
-    admin: {
-      login: async (I) => {  // If you use async function in the auth plugin
-         const phrase = await I.grabTextFrom('#phrase')
-         I.fillField('username', 'admin'),
-         I.fillField('password', 'password')
-         I.fillField('phrase', phrase)
-      },
-      check: (I) => {
-         I.amOnPage('/');
-         I.see('Admin');
-      },
-    }
-  }
-}
-```
-
-```js
-Scenario('login', async ( {I, login} ) => {
-  await login('admin') // you should use `await`
-})
-```
-
-#### Tips: Using session to validate user
-
-Instead of asserting on page elements for the current user in `check`, you can use the `session` you saved in `fetch`
-
-```js
-auth: {
-  enabled: true,
-  saveToFile: true,
-  inject: 'login',
-  users: {
-    admin: {
-      login: async (I) => {  // If you use async function in the auth plugin
-         const phrase = await I.grabTextFrom('#phrase')
-         I.fillField('username', 'admin'),
-         I.fillField('password', 'password')
-         I.fillField('phrase', phrase)
-      },
-      check: (I, session) => {
-         // Throwing an error in `check` will make CodeceptJS perform the login step for the user
-         if (session.profile.email !== the.email.you.expect@some-mail.com) {
-              throw new Error ('Wrong user signed in');
-        }
-      },
-    }
-  }
-}
-```
-
-```js
-Scenario('login', async ( {I, login} ) => {
-  await login('admin') // you should use `await`
-})
-```
-
-### Parameters
-
-*   `config` &#x20;
-
-## autoDelay
-
-Sometimes it takes some time for a page to respond to user's actions.
-Depending on app's performance this can be either slow or fast.
-
-For instance, if you click a button and nothing happens - probably JS event is not attached to this button yet
-Also, if you fill field and input validation doesn't accept your input - maybe because you typed value too fast.
-
-This plugin allows to slow down tests execution when a test running too fast.
-It puts a tiny delay for before and after action commands.
-
-Commands affected (by default):
-
-*   `click`
-*   `fillField`
-*   `checkOption`
-*   `pressKey`
-*   `doubleClick`
-*   `rightClick`
-
-#### Configuration
-
-```js
-plugins: {
-   autoDelay: {
-     enabled: true
-   }
-}
-```
-
-Possible config options:
-
-*   `methods`: list of affected commands. Can be overridden
-*   `delayBefore`: put a delay before a command. 100ms by default
-*   `delayAfter`: put a delay after a command. 200ms by default
-
-### Parameters
-
-*   `config` &#x20;
-
-## browser
-
-Overrides browser helper config from the command line. Works for all browser helpers
-(Playwright, Puppeteer, WebDriver, Appium) without touching `codecept.conf`.
-
-Enable it via `-p` option with one or more colon-chained args:
-
-    npx codeceptjs run -p browser:show
-    npx codeceptjs run -p browser:hide
-    npx codeceptjs run -p browser:browser=firefox
-    npx codeceptjs run -p browser:windowSize=1024x768:video=false
-    npx codeceptjs run -p browser:hide:browser=webkit:windowSize=800x600
-
-#### Args
-
-*   **show** — force visible browser
-*   **hide** — force headless (also injects `--headless` into WebDriver chrome/firefox capability args)
-*   **`<key>=<value>`** — set `helpers.<eachBrowserHelper>.<key> = <value>`. Three keys
-    get per-helper translation via `setBrowserConfig`:
-    *   `browser=<name>` — Puppeteer receives `product`, Playwright receives `browser`
-    *   `windowSize=WxH` — also adds `--window-size=W,H` chromium/chrome args
-    *   `show=true|false` — toggles `show` on Playwright/Puppeteer; injects/strips
-        `--headless` in WebDriver chrome/firefox capability args
-
-Values stay as strings. `true` / `false` are coerced to booleans.
-
-Requires `@codeceptjs/configure` to be installed; if missing, the plugin
-logs a hint and skips the override.
-
-### Parameters
-
-*   `config`   (optional, default `{}`)
-
-## coverage
-
-Dumps code coverage from Playwright/Puppeteer after every test.
-
-#### Configuration
-
-```js
-plugins: {
-   coverage: {
-     enabled: true,
-     debug: true,
-     name: 'CodeceptJS Coverage Report',
-     outputDir: 'output/coverage'
-   }
-}
-```
-
-Possible config options, More could be found at [monocart-coverage-reports][2]
-
-*   `debug`: debug info. By default, false.
-*   `name`: coverage report name.
-*   `outputDir`: path to coverage report.
-*   `sourceFilter`: filter the source files.
-*   `sourcePath`: option to resolve a custom path.
-
-### Parameters
-
-*   `config` &#x20;
-
-## customLocator
-
-Creates a [custom locator][3] by using special attributes in HTML.
-
-If you have a convention to use `data-test-id` or `data-qa` attributes to mark active elements for e2e tests,
-you can enable this plugin to simplify matching elements with these attributes:
-
-```js
-// replace this:
-I.click({ css: '[data-test-id=register_button]');
-// with this:
-I.click('$register_button');
-```
-
-This plugin will create a valid XPath locator for you.
-
-#### Configuration
-
-*   `enabled` (default: `false`) should a locator be enabled
-*   `prefix` (default: `$`) sets a prefix for a custom locator.
-*   `attribute` (default: `data-test-id`) to set an attribute to be matched.
-*   `strategy` (default: `xpath`) actual locator strategy to use in query (`css` or `xpath`).
-*   `showActual` (default: false) show in the output actually produced XPath or CSS locator. By default shows custom locator value.
-
-#### Examples:
-
-Using `data-test` attribute with `$` prefix:
-
-```js
-// in codecept.conf.js
-plugins: {
- customLocator: {
-   enabled: true,
-   attribute: 'data-test'
- }
-}
-```
-
-In a test:
-
-```js
-I.seeElement('$user'); // matches => [data-test=user]
-I.click('$sign-up'); // matches => [data-test=sign-up]
-```
-
-Using `data-qa` attribute with `=` prefix:
-
-```js
-// in codecept.conf.js
-plugins: {
- customLocator: {
-   enabled: true,
-   prefix: '=',
-   attribute: 'data-qa'
- }
-}
-```
-
-In a test:
-
-```js
-I.seeElement('=user'); // matches => [data-qa=user]
-I.click('=sign-up'); // matches => [data-qa=sign-up]
-```
-
-Using `data-qa` OR `data-test` attribute with `=` prefix:
-
-```js
-// in codecept.conf.js
-plugins: {
- customLocator: {
-   enabled: true,
-   prefix: '=',
-   attribute: ['data-qa', 'data-test'],
-   strategy: 'xpath'
- }
-}
-```
-
-In a test:
-
-```js
-I.seeElement('=user'); // matches => //*[@data-qa=user or @data-test=user]
-I.click('=sign-up'); // matches => //*[data-qa=sign-up or @data-test=sign-up]
-```
-
-```js
-// in codecept.conf.js
-plugins: {
- customLocator: {
-   enabled: true,
-   prefix: '=',
-   attribute: ['data-qa', 'data-test'],
-   strategy: 'css'
- }
-}
-```
-
-In a test:
-
-```js
-I.seeElement('=user'); // matches => [data-qa=user],[data-test=user]
-I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up]
-```
-
-### Parameters
-
-*   `config` &#x20;
-
-## customReporter
-
-Sample custom reporter for CodeceptJS.
-
-### Parameters
-
-*   `config` &#x20;
-
-## heal
-
-Self-healing tests with AI.
-
-Read more about heaking in [Self-Healing Tests][4]
-
-```js
-plugins: {
-  heal: {
-   enabled: true,
-  }
-}
-```
-
-More config options are available:
-
-*   `healLimit` - how many steps can be healed in a single test (default: 2)
-
-### Parameters
-
-*   `config`   (optional, default `{}`)
-
-## junitReporter
+## [junitReporter](/plugins/junitReporter)
 
 Generates a JUnit-compatible XML report after a test run.
 
-Unlike Mocha's `mocha-junit-reporter`, this plugin understands CodeceptJS steps and substeps.
-For every `<testcase>` it includes:
-
-*   `<properties>` — the test's meta information: every `meta` key from `Scenario('...', { meta })`, plus its `tags` and `retries`
-*   `<system-out>` — an indented step/substep log (substeps are nested under their meta step); only failed steps are marked
-*   `<failure>` — for failed tests: the error message, type, stack trace and (optionally) the step trace
-
-The produced file is consumable by Jenkins, GitLab CI, CircleCI, GitHub Actions test reporters, etc.
-
-#### Configuration
-
-```js
-"plugins": {
-   "junitReporter": {
-     "enabled": true
-   }
- }
-```
-
-Possible config options:
-
-*   `outputName`: file name for the report. Default: `report.xml`.
-*   `output`: directory where the report is stored, relative to the project root. Default: the `output` directory.
-*   `testGroupName`: value of the `name` attribute on the root `<testsuites>` element. Default: `CodeceptJS`.
-*   `attachMeta`: add the test's meta information (`meta` keys, `tags`, `retries`) as `<properties>`. Default: true.
-*   `attachSteps`: add the step/substep log as `<system-out>`. Default: true.
-*   `stepsInFailure`: append the step trace to the `<failure>` body. Default: true.
-
-CLI examples:
-
-    npx codeceptjs run -p junitReporter
-    npx codeceptjs run -p junitReporter:outputName=junit.xml
-
-> ℹ When running with `run-workers`, steps are serialized between processes and substep nesting is flattened.
-
-### Parameters
-
-*   `config` **any**  (optional, default `{}`)
-
-## pageInfo
-
-Collects information from web page after each failed test and adds it to the test as an artifact.
-It is suggested to enable this plugin if you run tests on CI and you need to debug failed tests.
-This plugin can be paired with `analyze` plugin to provide more context.
-
-It collects URL, HTML errors (by classes), and browser logs.
-
-Enable this plugin in config:
-
-```js
-plugins: {
- pageInfo: {
-  enabled: true,
-}
-```
-
-Additional config options:
-
-*   `errorClasses` - list of classes to search for errors (default: `['error', 'warning', 'alert', 'danger']`)
-*   `browserLogs` - list of types of errors to search for in browser logs (default: `['error']`)
-
-### Parameters
-
-*   `config`   (optional, default `{}`)
-
-## pause
+## [coverage](/plugins/coverage)
 
-Pauses test execution interactively. Replaces the legacy `pauseOnFail` plugin.
-Default `on=fail` matches the old `pauseOnFail` behavior.
-
-```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 current 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
-    npx codeceptjs run -p pause:on=file:path=tests/login_test.js;line=43
-    npx codeceptjs run -p pause:on=url:pattern=/users/*
-
-> The legacy `pauseOnFail` plugin remains as a deprecated alias that emits a
-> deprecation warning and forwards to `pause` with `on=fail`.
-
-### Parameters
-
-*   `config`   (optional, default `{}`)
-
-## retryFailedStep
-
-Retries each failed step in a test.
-
-Add this plugin to config file:
-
-```js
-plugins: {
-    retryFailedStep: {
-       enabled: true
-    }
-}
-```
-
-Run tests with plugin enabled:
-
-    npx codeceptjs run --plugins retryFailedStep
-
-#### Configuration:
-
-*   `retries` - number of retries (by default 3),
-*   `when` - function, when to perform a retry (accepts error as parameter)
-*   `factor` - The exponential factor to use. Default is 1.5.
-*   `minTimeout` - The number of milliseconds before starting the first retry. Default is 1000.
-*   `maxTimeout` - The maximum number of milliseconds between two retries. Default is Infinity.
-*   `randomize` - Randomizes the timeouts by multiplying with a factor from 1 to 2. Default is false.
-*   `defaultIgnoredSteps` - an array of steps to be ignored for retry. Includes:
-    *   `amOnPage`
-    *   `wait*`
-    *   `send*`
-    *   `execute*`
-    *   `run*`
-    *   `have*`
-*   `ignoredSteps` - an array for custom steps to ignore on retry. Use it to append custom steps to ignored list.
-    You can use step names or step prefixes ending with `*`. As such, `wait*` will match all steps starting with `wait`.
-    To append your own steps to ignore list - copy and paste a default steps list. Regexp values are accepted as well.
-*   `deferToScenarioRetries` - when enabled (default), step retries are automatically disabled if scenario retries are configured to avoid excessive total retries.
-
-#### Example
-
-```js
-plugins: {
-    retryFailedStep: {
-        enabled: true,
-        ignoredSteps: [
-          'scroll*', // ignore all scroll steps
-          /Cookie/, // ignore all steps with a Cookie in it (by regexp)
-        ]
-    }
-}
-```
-
-#### Disable Per Test
-
-This plugin can be disabled per test. In this case you will need to stet `I.retry()` to all flaky steps:
-
-Use scenario configuration to disable plugin for a test
-
-```js
-Scenario('scenario tite', { disableRetryFailedStep: true }, () => {
-   // test goes here
-})
-```
-
-### Parameters
-
-*   `config` &#x20;
-
-## screencast
-
-Records WebM video of tests using Playwright's screencast API (Playwright >= 1.59).
-When `captions` is enabled, action annotations are burned into the video; when
-`subtitles` is enabled, a standalone `.srt` file is also produced.
-
-```js
-plugins: {
-  screencast: {
-    enabled: true,
-    on: 'fail',
-  }
-}
-```
-
-#### `on=` modes
-
-*   **fail** — record while running; delete on pass, keep on fail (default)
-*   **test** — record and keep every test's video
-
-CLI examples:
-
-    npx codeceptjs run -p screencast
-    npx codeceptjs run -p screencast:on=test
-    npx codeceptjs run -p screencast:on=test;captions=false;subtitles=true
-
-Possible config options:
-
-*   `captions`: burn-in action overlays via `page.screencast.showActions()`. Default: true.
-*   `subtitles`: also write a standalone `.srt` file alongside the video. Default: false.
-*   `video`: record a video. With `video=false, subtitles=true`, only the `.srt` is produced (next to `test.artifacts.video` if a helper recorded one). Default: true.
-*   `size`: pass-through `{ width, height }` for `screencast.start`.
-*   `quality`: pass-through 0–100 for `screencast.start`.
-
-> Enabling Playwright's helper-level `video: true` and this plugin together
-> produces two independent recordings. Pick one.
-
-### Parameters
+Dumps code coverage from Playwright/Puppeteer after every test.
 
-*   `config` &#x20;
+## [screenshot](/plugins/screenshot)
 
-## screenshot
+Saves screenshots from the browser at points triggered by `on=`.
 
-Saves screenshots from the browser at points triggered by `on=`. Replaces the
-legacy `screenshotOnFail` plugin. Default `on=fail` preserves the old behavior.
+## [screencast](/plugins/screencast)
 
-This plugin is **enabled by default**.
+Records WebM video of tests using Playwright's screencast API.
 
-```js
-plugins: {
-  screenshot: {
-    enabled: true,
-    on: 'fail',
-  }
-}
-```
+## [customLocator](/plugins/customLocator)
 
-#### `on=` modes
+Creates a [custom locator][1] by using special attributes in HTML.
 
-*   **fail** — screenshot when a test fails (default)
-*   **test** — screenshot at the end of every test
-*   **step** — screenshot after every step
-*   **file** — screenshot for steps in `path=...[;line=...]`
-*   **url** — screenshot when the current URL matches `pattern=...`
+## [aiTrace](/plugins/aiTrace)
 
-CLI examples:
+Generates AI-friendly trace files for debugging with AI agents. This plugin creates a markdown file with test execution logs and links to all artifacts (screenshots, HTML, ARIA snapshots, browser logs, HTTP requests) for each step.
 
-    npx codeceptjs run -p screenshot
-    npx codeceptjs run -p screenshot:on=step
-    npx codeceptjs run -p screenshot:on=step;slides=true
-    npx codeceptjs run -p screenshot:on=file:path=tests/login_test.js
-    npx codeceptjs run -p screenshot:on=url:pattern=/users/*
+## [auth](/plugins/auth)
 
-Possible config options:
+Logs user in for the first test and reuses session for next tests. Works by saving cookies into memory or file. If a session expires automatically logs in again.
 
-*   `uniqueScreenshotNames`: use unique names for screenshot. Default: false.
-*   `fullPageScreenshots`: make full page screenshots. Default: false.
-*   `slides`: generate a step-by-step slideshow report (works with `on=step|file|url`). Replaces the legacy `stepByStepReport` plugin. Default: false.
-*   `deleteSuccessful`: when `slides=true`, drop slideshow folders for passing tests. Default: true.
-*   `animateSlides`: when `slides=true`, animate transitions between slides. Default: true.
-*   `ignoreSteps`: when `slides=true`, RegExps of step names to skip in the slideshow.
+## [pauseOnFail](/plugins/pauseOnFail)
 
-#### Step-by-step slideshow
+Starts an interactive pause when a test fails.
 
-`screenshot:on=step;slides=true` writes a per-test `record_<hash>/index.html`
-slideshow and a top-level `records.html` index. The output is a self-contained
-HTML page with keyboard / dot navigation — no external assets, no JavaScript
-frameworks.
+## [analyze](/plugins/analyze)
 
-> The legacy `screenshotOnFail` plugin remains as a deprecated alias. The legacy
-> `stepByStepReport` plugin has been replaced by `screenshot:slides=true`.
+Uses AI to analyze test failures and provide insights
 
-### Parameters
+## [autoDelay](/plugins/autoDelay)
 
-*   `config` &#x20;
+Sometimes it takes some time for a page to respond to user's actions. Depending on app's performance this can be either slow or fast.
 
-## stepTimeout
+## [stepTimeout](/plugins/stepTimeout)
 
 Set timeout for test steps globally.
 
-Add this plugin to config file:
-
-```js
-plugins: {
-    stepTimeout: {
-       enabled: true
-    }
-}
-```
+## [heal](/plugins/heal)
 
-Run tests with plugin enabled:
-
-    npx codeceptjs run --plugins stepTimeout
-
-#### Configuration:
-
-*   `timeout` - global step timeout, default 150 seconds
-
-*   `overrideStepLimits` - whether to use timeouts set in plugin config to override step timeouts set in code with I.limitTime(x).action(...), default false
-
-*   `noTimeoutSteps` - an array of steps with no timeout. Default:
-
-    *   `amOnPage`
-    *   `wait*`
-
-    you could set your own noTimeoutSteps which would replace the default one.
-
-*   `customTimeoutSteps` - an array of step actions with custom timeout. Use it to override or extend noTimeoutSteps.
-    You can use step names or step prefixes ending with `*`. As such, `wait*` will match all steps starting with `wait`.
-
-#### Example
+Self-healing tests with AI.
 
-```js
-plugins: {
-    stepTimeout: {
-        enabled: true,
-        overrideStepLimits: true,
-        noTimeoutSteps: [
-          'scroll*', // ignore all scroll steps
-          /Cookie/, // ignore all steps with a Cookie in it (by regexp)
-        ],
-        customTimeoutSteps: [
-          ['myFlakyStep*', 1],
-          ['scrollWhichRequiresTimeout', 5],
-        ]
-    }
-}
-```
+## [customReporter](/plugins/customReporter)
 
-### Parameters
+Sample custom reporter for CodeceptJS.
 
-*   `config` &#x20;
+## [screenshotOnFail](/plugins/screenshotOnFail)
 
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+Saves a screenshot when a test fails.
 
-[2]: https://github.com/cenfun/monocart-coverage-reports?tab=readme-ov-file#default-options
+## [retryFailedStep](/plugins/retryFailedStep)
 
-[3]: https://codecept.io/locators#custom-locators
+Retries each failed step in a test.
 
-[4]: https://codecept.io/heal/
+## [browser](/plugins/browser)
 
-[5]: /basics/#pause
+Overrides browser helper config from the command line. Works for all browser helpers (Playwright, Puppeteer, WebDriver, Appium) without touching `codecept.conf`.
 
-[6]: https://codecept.io/img/codeceptjs-slideshow.gif