[jochen-testingbot]

Part of https://testingbot-team.atlassian.net/browse/TB-1008 (docs audit: run every SDK README snippet).

Running the README (npm 1.1.5, node:22-bookworm-slim)

• npm install -g testingbot-cypress-cli, testingbot-cypress init and testingbot-cypress run all work.
• The README says to set cypress_proj_dir, but init writes run_settings.cypress_project_dir. A reader who adds the key the README names gets a config the CLI ignores.
• It doesn't say that the generated config has "start_tunnel": true. The tunnel needs Java, which the README only mentions in passing.

Change (README only)

• Name the real keys: auth.key/auth.secret and run_settings.cypress_project_dir.
• One line on start_tunnel (defaults to true; set false for public sites; needs Java).
• Docs link → /support/web-automate/cypress (the old URL 301s).

Verification

testingbot-cypress --version   -> 1.1.5
testingbot-cypress init        -> testingbot.json with run_settings.cypress_project_dir
(set cypress_project_dir=".", start_tunnel=false, credentials via TESTINGBOT_KEY/TESTINGBOT_SECRET;
 npm_dependencies.typescript for the TypeScript sample project used)
testingbot-cypress run         -> √ All specs passed!  ✔ Cypress Project has finished running on TestingBot

The npm page only changes with a release. That is needs-jochen and low priority (README only).

[Copilot]

🟡 Changes recommended

README.md incorrectly documents start_tunnel as a top-level key even though the CLI reads run_settings.start_tunnel, which could lead users to configure an ignored setting.

1 open issue

• Specify start_tunnel under run_settings · New

What changed in this PR

Updates the README to match the configuration generated and consumed by testingbot-cypress, clarifies tunnel behavior, and updates the Cypress documentation link.

Changes:

• Documents credentials under auth and the project directory under run_settings.cypress_project_dir.
• Explains that the tunnel is enabled by default, requires Java, and can be disabled for public sites.
• Replaces the outdated Cypress documentation URL.

File	Summary	Review comment
README.md	Aligns configuration guidance, tunnel instructions, and documentation links with the current CLI behavior.	Nit: Document start_tunnel as run_settings.start_tunnel; the generated configuration places it under run_settings, and the CLI reads it from there.

_{Review effort: Lite}

[Copilot]

🟢 Approved

The review identifies no active issues, and the README changes align the documented configuration, tunnel behavior, and Cypress documentation link with the CLI guidance.

No open issues 🎉

1 resolved since last review

• Specify start_tunnel under run_settings

_{Review effort: Lite}