Skip to content

All package options

All on/off switches below default to off. Paths and issue keys are text values and default to unset; --xray-comment-limit is an integer defaulting to 32000. The table describes the combinations required to make each option useful.

Option Effect
--xray-case-report=PATH Write observed cases locally. Parent folder must exist. Audit/debug output; does not upload.
--xray-case-values Include scalar input values in the case report; requires its path.
--xray-case-redact-identities Replace local names/IDs with per-run aliases; requires the case report and excludes case values.
--jira-xray Enable export of marked tests. Uploads unless --xraypath is set.
--xraypath=PATH With --jira-xray, write Xray JSON instead of uploading. Creates parent folders.
--allow-duplicate-ids Combine cases that share a Jira Test key.
--xray-parameter-details Add parameter identities and scalar values to legacy comments.
--xray-comment-limit=BYTES Maximum UTF-8 bytes per final comment; default 32000, minimum 256.
--xray-full-report=PATH Archive the complete original legacy payload before shortening comments; requires --jira-xray.
--execution=KEY Update an existing Test Execution.
--testplan=KEY Set a Test Plan key in execution metadata.
--api-key-auth Authenticate using XRAY_API_KEY as a Bearer token.
--client-secret-auth Authenticate with Xray Cloud client credentials.
--cloud Use the Cloud import endpoint and status spelling.
--add-captures Add captured stdout, stderr and logs to comments; may expose secrets.

Use python -m pytest --help for pytest's own options. --collect-only does not write reports. No option enables native iteration rows.