Back to Codeceptjs

browser

docs/plugins/browser.md

4.0.01.4 KB
Original Source
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

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