Skip to content

[Docs]: --debug mode argument and --run-agents missing from test-cli options table #42889

Description

Page(s)

Description

Two playwright test options that appear in npx playwright test --help are missing from the CLI docs, and a documented option is missing its mode argument. packages/playwright/src/program.ts carries an explicit note — "update docs/src/test-cli-js.md when you update this, program is the source of truth" — both options below landed without that docs update.

  1. --debug [mode] modes undocumented. The option is defined with choices: ['inspector', 'cli'] and preset: 'inspector' in program.ts (added in feat(cli): running with --debug=cli allows attaching and debugging over cli #39717). Both --debug rows in test-cli-js.md document the plain flag and the PWDEBUG=1 shortcut, but not the optional mode argument: --debug=cli allows attaching and debugging over the CLI.

  2. --run-agents <mode> undocumented. The option is defined with choices: ['missing', 'all', 'none'] and preset: 'none' (made visible again in Revert "chore: hide stuff" #38917) and is printed by --help, but it has no row in the options table and is not mentioned in the agents guide either.

Suggested fix

  • Extend both --debug rows with the [mode] argument and the two modes (default inspector).
  • Add a --run-agents <mode> row to the options table.

Related gaps noticed in the same table while auditing (possibly separate, happy to follow up):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions