# TestVibe

## TestVibe

- [Welcome](https://docs.testvibe.com/readme.md): Learn how to set up TestVibe, create AI-generated Playwright tests, load-test the same journeys, watch live server telemetry, and review the evidence behind every result — all in isolated cloud sessio
- [What Is TestVibe?](https://docs.testvibe.com/readme/what-is-testvibe.md): TestVibe is an AI-native testing platform: turn plain test intent into generated Playwright UI tests, replay those journeys as load tests, and watch live server telemetry — all run in isolated cloud s
- [Who TestVibe Is For](https://docs.testvibe.com/readme/who-testvibe-is-for.md): TestVibe is for teams that want UI tests, load tests, and server telemetry to be easier to describe, generate, run, and understand across QA, product, and engineering.
- [Key Concepts](https://docs.testvibe.com/readme/key-concepts.md): Learn the core TestVibe terms for workspaces, projects, test suites, AI generation, cloud test sessions, results, and evidence.
- [Quickstart](https://docs.testvibe.com/quickstart.md): Follow the fastest path from signing in to TestVibe to reviewing the result of your first generated Playwright test.
- [Sign In](https://docs.testvibe.com/quickstart/sign-in-with-github.md): Sign in to TestVibe with email and password, GitHub, or Google to reach your workspaces and projects.
- [Create a Project](https://docs.testvibe.com/quickstart/create-or-connect-project.md): Create a TestVibe project with a name and the site URL(s) to test before adding your first test.
- [Create Your First Test](https://docs.testvibe.com/quickstart/create-first-test.md): Create your first TestVibe test by adding readable Gherkin-style intent in the Test Suite.
- [Generate Playwright Code](https://docs.testvibe.com/quickstart/generate-playwright-code.md): Generate Playwright code from your first TestVibe feature or test instructions.
- [Run Your First Test](https://docs.testvibe.com/quickstart/run-first-test.md): Run your first generated Playwright test from TestVibe and watch the live run status.
- [Review Your First Result](https://docs.testvibe.com/quickstart/review-first-result.md): Review the result of your first TestVibe run and decide whether to keep, edit, regenerate, or re-run the test.
- [Pricing](https://docs.testvibe.com/pricing.md): Compare TestVibe plans, included credits, billing periods, credit packs, and the usage signals shown in Settings.
- [Plans](https://docs.testvibe.com/pricing/plans.md): Compare the Free, Starter, Pro, and Enterprise TestVibe plans.
- [Credits and What They Cover](https://docs.testvibe.com/pricing/billable-minutes-and-credit.md): Learn what TestVibe credits cover and how included and purchased credits are consumed.
- [Manage Billing](https://docs.testvibe.com/pricing/manage-billing.md): Use Settings > Billing to review your plan, change plans, buy credit packs, and understand scheduled billing changes.
- [Set Up Your Workspace](https://docs.testvibe.com/workspace.md): Create a project with a name and the site URLs to test, organize your workspace, and optionally connect GitHub.
- [Connect GitHub (Optional)](https://docs.testvibe.com/workspace/install-github-app.md): Connect GitHub to TestVibe when you want source-code context or test files sync. Sign-in is identity-only and never requests repository permissions.
- [Choose a Source Repository (Optional)](https://docs.testvibe.com/workspace/choose-repository.md): Give a project an optional source repository so the assistant can read the application code when it explores your app or generates tests.
- [Create a New Project](https://docs.testvibe.com/workspace/create-new-project.md): Create a TestVibe project in the app with a name and the site URL to test — no repository required.
- [Join an Existing Project](https://docs.testvibe.com/workspace/connect-existing-project.md): Join a project that already exists in TestVibe — accept a workspace invite or request access from a project link.
- [Configure Environments and App Repository](https://docs.testvibe.com/workspace/configure-site-url-and-repository.md): Manage the site URLs a project tests against and the optional source code connection that gives generation extra context.
- [Add API Keys and Secrets](https://docs.testvibe.com/workspace/add-api-keys-and-secrets.md): Store the variables and secrets your tests need — and reference them from Gherkin with runtime tokens that never expose the value.
- [Manage Members](https://docs.testvibe.com/workspace/manage-teams-and-members.md): Work in personal and team workspaces, invite members from Settings → Members, and understand the Owner, Admin, Member, and Viewer roles.
- [Dashboard](https://docs.testvibe.com/workspace/dashboard.md): Use the dashboard to decide what needs attention across tests, runs, and recent activity.
- [Live Servers](https://docs.testvibe.com/workspace/live-servers.md): Watch real-time CPU, memory, sessions, threads, and GC heap from the servers running your application — on the Dashboard, any time you need it.
- [Create Tests](https://docs.testvibe.com/create-tests.md): Create and organize readable test intent before generating Playwright code or running browser automation.
- [Understand the Test Suite](https://docs.testvibe.com/create-tests/test-suite-overview.md): Learn how the Test Suite organizes groups, feature files, generated code, and test status.
- [Gherkin and Feature Files](https://docs.testvibe.com/create-tests/gherkin-and-feature-files.md): Learn how TestVibe uses Gherkin feature files to describe user behavior before generating Playwright tests.
- [Create Groups and Tests](https://docs.testvibe.com/create-tests/create-groups-and-tests.md): Add groups and feature files to organize user journeys in the Test Suite.
- [Write Good Test Instructions](https://docs.testvibe.com/create-tests/write-good-test-instructions.md): Write clear Gherkin and test instructions that help TestVibe generate reliable Playwright code.
- [Use Prerequisites and Dependencies](https://docs.testvibe.com/create-tests/use-prerequisites-and-dependencies.md): Use prerequisite and dependent tests to share setup without making every scenario long and repetitive.
- [Import Existing Tests](https://docs.testvibe.com/create-tests/import-existing-tests.md): Bring existing test material into a TestVibe group by importing a document or a GitHub issue, or by pasting Gherkin into a blank feature.
- [Edit Test Content](https://docs.testvibe.com/create-tests/edit-test-content.md): Edit Gherkin feature files and generated code from TestVibe, then save changes to your project.
- [Use the Recorder](https://docs.testvibe.com/create-tests/use-recorder.md): Record a browser journey and turn the captured steps into reviewable Gherkin in TestVibe.
- [Manage Generated Test Files](https://docs.testvibe.com/create-tests/manage-generated-test-files.md): Understand where generated feature and Playwright files live and when to regenerate or edit them.
- [Generate Tests With AI](https://docs.testvibe.com/ai-generation.md): Use AI generation to turn TestVibe feature intent into generated Gherkin, Playwright code, and runnable browser tests.
- [How AI Generation Works](https://docs.testvibe.com/ai-generation/how-ai-generation-works.md): Understand the generation lifecycle from saved test intent to generated Playwright output.
- [Generate a New Feature](https://docs.testvibe.com/ai-generation/generate-new-feature.md): Start from a feature idea or group and use TestVibe to draft new test intent.
- [Generate Playwright Code](https://docs.testvibe.com/ai-generation/generate-playwright-code.md): Generate runnable Playwright automation from a saved TestVibe feature file.
- [Choose an Agent and Model](https://docs.testvibe.com/ai-generation/choose-agent-and-model.md): Configure the reasoning effort and generation timeout TestVibe's AI uses to generate tests for your project.
- [Review Generation Progress](https://docs.testvibe.com/ai-generation/review-generation-progress.md): Follow queued, running, finalizing, succeeded, failed, and cancelled generation states.
- [Read Generated Output](https://docs.testvibe.com/ai-generation/read-generated-output.md): Review generated feature files, Playwright code, screenshots, traces, and project output before running tests.
- [Regenerate a Test](https://docs.testvibe.com/ai-generation/regenerate-test.md): Regenerate a test after editing instructions, fixing setup, or reviewing weak generated output.
- [Troubleshoot Failed Generation](https://docs.testvibe.com/ai-generation/troubleshoot-failed-generation.md): Recover from failed AI generation by checking keys, permissions, site access, session setup, and feature clarity.
- [AI Assistant](https://docs.testvibe.com/assistant.md): Chat with the TestVibe Assistant about your features, runs, and results — have it explore your app for you, or let per-view Ask AI / Debug with AI buttons seed the conversation for you.
- [Run Tests](https://docs.testvibe.com/run-tests.md): Start, monitor, cancel, and re-run TestVibe Playwright tests against your target site.
- [Run One Test](https://docs.testvibe.com/run-tests/run-one-test.md): Run a single generated test when you want fast feedback before expanding to a larger group or full suite.
- [Run a Group](https://docs.testvibe.com/run-tests/run-group.md): Run every generated test in a group to validate a feature area, workflow, or related set of scenarios.
- [Run the Full Suite](https://docs.testvibe.com/run-tests/run-full-suite.md): Run the full generated suite when you need broad regression coverage for a project or release candidate.
- [Choose Browser, Viewport, and Configuration](https://docs.testvibe.com/run-tests/browser-viewport-configuration.md): Choose the browser, viewport, and Playwright configuration TestVibe should use before starting a run.
- [Schedule Runs](https://docs.testvibe.com/run-tests/schedule-runs.md): Create scheduled TestVibe runs for recurring smoke checks, regression passes, and environment monitoring.
- [Automations](https://docs.testvibe.com/run-tests/automations.md): Trigger work automatically on a cron schedule, or when a run finishes — run a feature suite, a load test, or an AI assistant job.
- [Cancel or Re-run Tests](https://docs.testvibe.com/run-tests/cancel-or-rerun-tests.md): Stop active runs, re-run previous selections, and understand what happens to the original result history.
- [Understand Live Run Status](https://docs.testvibe.com/run-tests/understand-live-run-status.md): Learn what each live run state means and how to decide whether to wait, investigate, cancel, or re-run.
- [Load Testing](https://docs.testvibe.com/load-testing.md): Replay your UI journeys under load and watch latency, throughput, and error rates live — without writing k6 scripts by hand.
- [Create a Load Test](https://docs.testvibe.com/load-testing/create-a-load-test.md): Pick Simple (browser users replay your feature tests) or Advanced (protocol-level k6) and configure users, duration, and gates.
- [Run a Load Test and Read Results](https://docs.testvibe.com/load-testing/run-a-load-test-and-read-results.md): Dispatch a load test to the cloud fleet, watch live charts, and read latency percentiles, throughput, error rate, and per-step breakdowns.
- [Automate Load Tests](https://docs.testvibe.com/load-testing/automate-load-tests.md): Kick off load tests from CI, the testvibe CLI, or an AI tool — the same load runs you dispatch from the app, driven over the API.
- [Server Telemetry](https://docs.testvibe.com/load-testing/server-telemetry.md): Install the TestVibe telemetry agent in any .NET (or Node.js) app to see server-side CPU, memory, sessions, and custom metrics next to your results.
- [Where Runs Execute](https://docs.testvibe.com/runners.md): Learn where TestVibe runs execute: isolated cloud sandboxes by default, a private self-hosted runner, or a tunnel to a private app.
- [What Are Cloud Sandboxes?](https://docs.testvibe.com/runners/what-are-runners.md): Understand the isolated cloud sandboxes that execute TestVibe runs — an isolated sandbox per run, prepared automatically.
- [Choose an Execution Target](https://docs.testvibe.com/runners/choose-a-runner.md): Decide which execution target a TestVibe project uses — cloud sandboxes, a private self-hosted runner, or a tunnel to a private app.
- [Private Runners](https://docs.testvibe.com/runners/self-hosted-runners.md): Host the TestVibe runner inside your firewall so tests run on your own infrastructure against fully private applications.
- [Set a Project's Execution Target](https://docs.testvibe.com/runners/set-default-runner.md): Set a project's execution target — cloud, private runner, or tunneled — and pin a tunnel device per project.
- [Troubleshoot Execution](https://docs.testvibe.com/runners/troubleshooting-runners.md): Fix runs that cannot reach the target site, offline private runners and tunnel devices, credit gates, and runs stuck in preparing.
- [Review Results](https://docs.testvibe.com/results.md): Read TestVibe run outcomes, inspect failed tests, and use screenshots, videos, and Playwright traces to understand what happened.
- [Read Pass/Fail Status](https://docs.testvibe.com/results/read-pass-fail-status.md): Understand run-level and test-level result states, summary counts, and mixed outcomes in TestVibe.
- [Inspect Failed Steps](https://docs.testvibe.com/results/inspect-failed-steps.md): Open a failed test row and use the failure reason, screenshot, error details, and related evidence to decide what to fix.
- [View Screenshots](https://docs.testvibe.com/results/view-screenshots.md): Use run screenshots and failure screenshots to understand visible browser state at the time a test passed, failed, or captured evidence.
- [Watch Videos](https://docs.testvibe.com/results/watch-videos.md): Replay run video artifacts to see the browser behavior that led to a test result or failure.
- [Open Traces](https://docs.testvibe.com/results/open-traces.md): Open Playwright trace evidence from TestVibe to inspect actions, snapshots, timing, console, and network activity around a failure.
- [Share or Export Results](https://docs.testvibe.com/results/share-or-export-results.md): Share run outcomes with teammates and download the reports or evidence needed to explain a failure.
- [App Code](https://docs.testvibe.com/codebase.md): See which parts of your app your tests cover — files, areas, and gaps.
- [Plugins](https://docs.testvibe.com/skills.md): Extend TestVibe with plugins — packaged steps you can call straight from Gherkin, from LLM checks to Jira, Slack, and database helpers.
- [Manage Plugins](https://docs.testvibe.com/skills/manage-skills.md): Install, update, remove, and configure plugins in the TestVibe Plugins marketplace.
- [Account & Settings](https://docs.testvibe.com/account-settings.md): Manage your profile, workspace, tunnels, billing, project configuration, and the values available to runs.
- [Profile](https://docs.testvibe.com/account-settings/account-settings.md): Review your profile, the active workspace, plan, and test-generation defaults.
- [CLI & API Keys](https://docs.testvibe.com/account-settings/api-keys.md): Create and manage the tvb\_… API keys used by the testvibe CLI, MCP and AI tools, the tunnel agent, and the load telemetry agent.
- [Tunnels](https://docs.testvibe.com/account-settings/tunnel-devices.md): Run the tvtunnel agent inside your network so TestVibe's cloud runs can reach private apps — no inbound firewall changes, end-to-end encrypted.
- [Notes](https://docs.testvibe.com/account-settings/notes.md): Write durable instructions the AI reuses on every generation, and review the app knowledge it discovers on its own.
- [Notifications](https://docs.testvibe.com/account-settings/notifications.md): Use TestVibe activity notifications to follow active generation and runs, failures that need attention, and recent history.
- [App Repository & Test Files Sync](https://docs.testvibe.com/account-settings/repository-settings.md): Connect the optional Git panels: a read-only App Repository that grounds the AI and maps coverage, and two-way Test Files Sync for the project's tests.
- [Assets](https://docs.testvibe.com/account-settings/project-settings.md): Store and organize project files (images, PDFs) that your tests reference by handle.
- [Billing](https://docs.testvibe.com/account-settings/usage.md): Manage this workspace's plan and TestVibe credits — balance, top-ups, plan changes, and purchase history — in Settings → Billing.
- [Credit Usage](https://docs.testvibe.com/account-settings/credit-usage.md): See where this cycle's TestVibe credits went — by area and over time — in Settings → Credit Usage.
- [Storage](https://docs.testvibe.com/account-settings/storage.md): Track the workspace's shared storage quota, see where it goes by data type and project, and set per-type retention in Settings → Storage.
- [Members](https://docs.testvibe.com/account-settings/team-settings.md): Understand how workspace membership and roles decide what each user can see and change in TestVibe.
- [Workflow Settings (Retired)](https://docs.testvibe.com/account-settings/workflow-settings.md): The Workflows panel was retired — generation, run, and scheduling defaults now live in dedicated settings panels.
- [Self-Hosting](https://docs.testvibe.com/self-hosting.md): Run the entire TestVibe product on your own infrastructure — inside your firewall, off the public cloud — with Docker.
- [How It Works](https://docs.testvibe.com/self-hosting/how-it-works.md): The containers that make up a self-hosted TestVibe, how they connect, and the order they start in.
- [Install](https://docs.testvibe.com/self-hosting/install.md): Prerequisites, the quick-start flow, and how upgrades and data persistence work for a self-hosted TestVibe.
- [Configuration](https://docs.testvibe.com/self-hosting/configuration.md): How a self-hosted TestVibe is configured: environment variables only, with secret-file support. The required values and the optional integrations.
- [AI Models](https://docs.testvibe.com/self-hosting/ai-models.md): Powering AI test generation on-prem — use hosted Claude/OpenAI keys, or bring your own local OpenAI-compatible model.
- [Licensing](https://docs.testvibe.com/self-hosting/licensing.md): How a self-hosted instance is licensed — an offline signed license, a grace window, and the activation flow.
- [REST API](https://docs.testvibe.com/rest-api.md): Automate TestVibe from your own tools — projects, features, runs, and load tests over a key-authenticated REST API.
- [Troubleshooting](https://docs.testvibe.com/troubleshooting.md): Recover from common sign-in, project access, generation, run, and result issues in TestVibe.
- [Sign-in Problems](https://docs.testvibe.com/troubleshooting/sign-in-problems.md): Fix email verification, password reset, and GitHub or Google sign-in problems.
- [Can't See a Project](https://docs.testvibe.com/troubleshooting/missing-repositories.md): Find a project that does not appear in TestVibe by checking the active workspace and your membership.
- [GitHub Connection Issues](https://docs.testvibe.com/troubleshooting/github-app-permissions.md): Fix issues with the optional GitHub integration: sign-in identity, App Repository reading, and Test Files Sync.
- [Missing Secrets](https://docs.testvibe.com/troubleshooting/missing-secrets.md): Add missing variables and secrets so generation and test runs can resolve the tokens referenced in your Gherkin.
- [Generation Failed](https://docs.testvibe.com/troubleshooting/generation-failed.md): Recover from failed AI generation by checking credits, site access, secrets, and test instructions.
- [Run Failed](https://docs.testvibe.com/troubleshooting/run-failed.md): Understand a failed run by reviewing result evidence, setup, test data, and environment health before retrying.
- [No Screenshots or Videos](https://docs.testvibe.com/troubleshooting/no-screenshots-or-videos.md): Understand why screenshots, videos, traces, or other visual evidence may be missing from a run.
- [Run Still Running or Stuck](https://docs.testvibe.com/troubleshooting/workflow-running-or-stuck.md): Understand queued, preparing, running, and stuck run states in TestVibe and when to cancel.
- [Common Error Messages](https://docs.testvibe.com/troubleshooting/common-error-messages.md): Map common TestVibe error messages to practical next steps.
- [Reference](https://docs.testvibe.com/reference.md): Lookup pages for TestVibe terms, browser presets, optional GitHub integration, and contextual help URLs.
- [Glossary](https://docs.testvibe.com/reference/glossary.md): Definitions for common TestVibe, execution, generation, and result terms.
- [Form/Page Reference](https://docs.testvibe.com/reference/form-page-reference.md): Find contextual help pages for TestVibe forms, dialogs, and workspace screens.
- [Supported Browsers and Viewport Presets](https://docs.testvibe.com/reference/supported-browsers-and-viewports.md): Review the browser choices and viewport presets commonly used by TestVibe Playwright runs.
- [GitHub Permissions Overview](https://docs.testvibe.com/reference/github-permissions-overview.md): GitHub is optional in TestVibe. See the three places it can appear and what access is requested for each.
- [Help URL Index](https://docs.testvibe.com/reference/help-urls.md): Stable URL conventions for TestVibe contextual help pages.
- [Authoring](https://docs.testvibe.com/reference/authoring.md)
- [Form Help Pages](https://docs.testvibe.com/reference/forms.md)
- [Account](https://docs.testvibe.com/reference/forms/account.md)
- [Assistant](https://docs.testvibe.com/reference/forms/assistant.md)
- [Editor](https://docs.testvibe.com/reference/forms/editor.md)
- [ExceptionViewer](https://docs.testvibe.com/reference/forms/exception-viewer.md)
- [HelpDialog](https://docs.testvibe.com/reference/forms/help-dialog.md)
- [Import](https://docs.testvibe.com/reference/forms/import.md)
- [Login](https://docs.testvibe.com/reference/forms/login.md)
- [NotificationCenter](https://docs.testvibe.com/reference/forms/notification-center.md)
- [Picture](https://docs.testvibe.com/reference/forms/picture.md)
- [PlaywrightAdvancedOptions](https://docs.testvibe.com/reference/forms/playwright-advanced-options.md)
- [PlaywrightTestConfiguration](https://docs.testvibe.com/reference/forms/playwright-test-configuration.md)
- [Project](https://docs.testvibe.com/reference/forms/project.md)
- [ProjectSetup](https://docs.testvibe.com/reference/forms/project-setup.md)
- [Prompt](https://docs.testvibe.com/reference/forms/prompt.md)
- [RecorderHelp](https://docs.testvibe.com/reference/forms/recorder-help.md)
- [Run](https://docs.testvibe.com/reference/forms/run.md)
- [SelectProject](https://docs.testvibe.com/reference/forms/select-project.md)
- [TeamMembers](https://docs.testvibe.com/reference/forms/team-members.md)
- [Test](https://docs.testvibe.com/reference/forms/test.md)
- [TestFailureDetails](https://docs.testvibe.com/reference/forms/test-failure-details.md)
- [TestGenerationGroupsInfo](https://docs.testvibe.com/reference/forms/test-generation-groups-info.md)
- [Usage](https://docs.testvibe.com/reference/forms/usage.md)
- [Video](https://docs.testvibe.com/reference/forms/video.md)

## Testvibe API

- [Welcome](https://docs.testvibe.com/testvibe-api/welcome/readme.md): Everything a TestVibe project offers — features, AI test generation, cloud test runs — from your terminal, your CI, and your AI tools.
- [Quickstart](https://docs.testvibe.com/testvibe-api/getting-started/quickstart.md): Create a feature, generate its Playwright tests with AI, and run them in a cloud sandbox — in about five minutes.
- [Authentication & API keys](https://docs.testvibe.com/testvibe-api/getting-started/authentication.md): API keys, the Authorization header, and how access is scoped.
- [Connect your AI tools](https://docs.testvibe.com/testvibe-api/getting-started/connect-ai-tools.md): Plug TestVibe into Claude Code, Claude Desktop, Codex, or any MCP client — every API operation becomes a tool.
- [Projects](https://docs.testvibe.com/testvibe-api/core-concepts/projects.md): A project is a web app under test, identified by a URL.
- [Features & the lifecycle](https://docs.testvibe.com/testvibe-api/core-concepts/features.md): A feature is desired behavior in Gherkin, with a lifecycle from draft to generated, runnable tests.
- [Runs & artifacts](https://docs.testvibe.com/testvibe-api/core-concepts/runs-and-artifacts.md): A run executes a feature's generated tests in an isolated cloud sandbox and leaves behind a results digest and downloadable artifacts.
- [Files & configurations](https://docs.testvibe.com/testvibe-api/core-concepts/files-and-configurations.md): Every project is also a file tree — stored content layered over the Playwright template — and you can edit the safe parts of it.
- [Overview](https://docs.testvibe.com/testvibe-api/api-reference/reference.md): Every operation, across all three surfaces. One ops core means the REST API, the CLI, and the MCP tools can never disagree.
- [Conventions & errors](https://docs.testvibe.com/testvibe-api/api-reference/conventions.md): Request/response basics shared by every operation.
- [Long-running operations](https://docs.testvibe.com/testvibe-api/api-reference/async-operations.md): Generation and runs are dispatched, not awaited — here's the polling pattern every surface uses.
- [Projects](https://docs.testvibe.com/testvibe-api/api-reference/projects.md): The workspace's projects — the entry point for everything else.
- [list\_projects](https://docs.testvibe.com/testvibe-api/api-reference/projects/list_projects.md): List the projects in the workspace (id, name, base URL).
- [get\_project](https://docs.testvibe.com/testvibe-api/api-reference/projects/get_project.md): One project's details — base URL, execution target, and test site URLs.
- [Billing](https://docs.testvibe.com/testvibe-api/api-reference/billing.md): The workspace's prepaid credits — balance and ledger.
- [get\_credits](https://docs.testvibe.com/testvibe-api/api-reference/billing/get_credits.md): The workspace's current credit balance and plan.
- [list\_billing\_history](https://docs.testvibe.com/testvibe-api/api-reference/billing/list_billing_history.md): The workspace's credit additions (purchases + grants), newest first.
- [list\_credit\_usage](https://docs.testvibe.com/testvibe-api/api-reference/billing/list_credit_usage.md): The workspace's credit consumption — per-area rollup + recent usage.
- [Features](https://docs.testvibe.com/testvibe-api/api-reference/features.md): Create, read, update, and delete the Gherkin features of a project.
- [list\_features](https://docs.testvibe.com/testvibe-api/api-reference/features/list_features.md): List the project's features with their lifecycle status.
- [get\_feature](https://docs.testvibe.com/testvibe-api/api-reference/features/get_feature.md): Read one feature in full — Gherkin source, status, and rationale.
- [create\_feature](https://docs.testvibe.com/testvibe-api/api-reference/features/create_feature.md): Create a new feature from a name and Gherkin source.
- [update\_feature](https://docs.testvibe.com/testvibe-api/api-reference/features/update_feature.md): Update a feature's Gherkin source and/or rename it.
- [delete\_feature](https://docs.testvibe.com/testvibe-api/api-reference/features/delete_feature.md): Delete a feature and its generated test files. Irreversible.
- [Generation](https://docs.testvibe.com/testvibe-api/api-reference/generation.md): Turn a feature's Gherkin into runnable Playwright tests with AI.
- [generate\_feature](https://docs.testvibe.com/testvibe-api/api-reference/generation/generate_feature.md): Generate Playwright tests for a feature from its Gherkin.
- [get\_generation\_status](https://docs.testvibe.com/testvibe-api/api-reference/generation/get_generation_status.md): The feature's generation state — lifecycle status plus live per-section progress.
- [wait\_for\_generation](https://docs.testvibe.com/testvibe-api/api-reference/generation/wait_for_generation.md): Poll a feature's generation until it finishes (or the timeout).
- [get\_generation\_log](https://docs.testvibe.com/testvibe-api/api-reference/generation/get_generation_log.md): The latest generation's per-section transcript — diagnose a failed generation.
- [cancel\_generation](https://docs.testvibe.com/testvibe-api/api-reference/generation/cancel_generation.md): Cancel a feature's in-flight generation.
- [Runs](https://docs.testvibe.com/testvibe-api/api-reference/runs.md): Execute generated tests in cloud sandboxes and read the results.
- [run\_feature](https://docs.testvibe.com/testvibe-api/api-reference/runs/run_feature.md): Run a feature's generated Playwright tests in a cloud sandbox.
- [run\_suite](https://docs.testvibe.com/testvibe-api/api-reference/runs/run_suite.md): Run several features at once — one cloud run per feature.
- [wait\_for\_run](https://docs.testvibe.com/testvibe-api/api-reference/runs/wait_for_run.md): Poll a run until it finishes (or the timeout) and return its results digest.
- [get\_run](https://docs.testvibe.com/testvibe-api/api-reference/runs/get_run.md): One run's status and results digest — per-test statuses, errors, and the artifact manifest.
- [diagnose\_run](https://docs.testvibe.com/testvibe-api/api-reference/runs/diagnose_run.md): A failed run's full failure context in one call.
- [list\_runs](https://docs.testvibe.com/testvibe-api/api-reference/runs/list_runs.md): List the project's recent test runs, newest first.
- [get\_run\_artifacts](https://docs.testvibe.com/testvibe-api/api-reference/runs/get_run_artifacts.md): Short-lived download links for a run's uploaded artifacts.
- [Load testing](https://docs.testvibe.com/testvibe-api/api-reference/load.md): List and dispatch load tests on the cloud load pool.
- [list\_load\_tests](https://docs.testvibe.com/testvibe-api/api-reference/load/list_load_tests.md): List the project's load tests.
- [create\_load\_test](https://docs.testvibe.com/testvibe-api/api-reference/load/create_load_test.md): Create a load test (a kind "load" feature) from a configuration.
- [update\_load\_test](https://docs.testvibe.com/testvibe-api/api-reference/load/update_load_test.md): Edit a load test's name and/or configuration.
- [delete\_load\_test](https://docs.testvibe.com/testvibe-api/api-reference/load/delete_load_test.md): Delete a load test.
- [run\_load\_test](https://docs.testvibe.com/testvibe-api/api-reference/load/run_load_test.md): Dispatch a load test onto the cloud load pool.
- [Telemetry](https://docs.testvibe.com/testvibe-api/api-reference/telemetry.md): Read live server vitals, application errors, and per-run server metrics.
- [get\_live\_servers](https://docs.testvibe.com/testvibe-api/api-reference/telemetry/get_live_servers.md): Read the project's live streaming server vitals.
- [list\_error\_groups](https://docs.testvibe.com/testvibe-api/api-reference/telemetry/list_error_groups.md): List the project's fingerprinted application-error groups.
- [list\_server\_metrics](https://docs.testvibe.com/testvibe-api/api-reference/telemetry/list_server_metrics.md): List a load run's persisted server-telemetry samples.
- [Automations](https://docs.testvibe.com/testvibe-api/api-reference/automations.md): Schedule (cron) or event triggers that run a suite or a load test.
- [list\_automations](https://docs.testvibe.com/testvibe-api/api-reference/automations/list_automations.md): List the project's automations.
- [get\_automation](https://docs.testvibe.com/testvibe-api/api-reference/automations/get_automation.md): Read one automation.
- [create\_automation](https://docs.testvibe.com/testvibe-api/api-reference/automations/create_automation.md): Create an automation.
- [update\_automation](https://docs.testvibe.com/testvibe-api/api-reference/automations/update_automation.md): Update an automation (or pause it).
- [delete\_automation](https://docs.testvibe.com/testvibe-api/api-reference/automations/delete_automation.md): Delete an automation and its history.
- [run\_automation](https://docs.testvibe.com/testvibe-api/api-reference/automations/run_automation.md): Fire an automation now (manual trigger).
- [list\_automation\_runs](https://docs.testvibe.com/testvibe-api/api-reference/automations/list_automation_runs.md): One automation's firing history.
- [Coverage](https://docs.testvibe.com/testvibe-api/api-reference/coverage.md): See what your app does, how much of it your tests cover, and run coverage.
- [get\_coverage](https://docs.testvibe.com/testvibe-api/api-reference/coverage/get_coverage.md): The project's coverage snapshot.
- [scan\_coverage](https://docs.testvibe.com/testvibe-api/api-reference/coverage/scan_coverage.md): Start an AI coverage scan.
- [list\_coverage\_runs](https://docs.testvibe.com/testvibe-api/api-reference/coverage/list_coverage_runs.md): List recent execution-coverage runs.
- [run\_coverage](https://docs.testvibe.com/testvibe-api/api-reference/coverage/run_coverage.md): Start an execution-coverage run for a build/test target.
- [Plugins](https://docs.testvibe.com/testvibe-api/api-reference/plugins.md): Browse the plugin catalog, enable plugins per project, and publish your own.
- [list\_plugins](https://docs.testvibe.com/testvibe-api/api-reference/plugins/list_plugins.md): List the plugin catalog with each plugin's install state for this project.
- [install\_plugin](https://docs.testvibe.com/testvibe-api/api-reference/plugins/install_plugin.md): Enable a catalog plugin for this project.
- [remove\_plugin](https://docs.testvibe.com/testvibe-api/api-reference/plugins/remove_plugin.md): Disable a plugin for this project.
- [publish\_plugin](https://docs.testvibe.com/testvibe-api/api-reference/plugins/publish_plugin.md): Publish a plugin package to your workspace's catalog and enable it here.
- [unpublish\_plugin](https://docs.testvibe.com/testvibe-api/api-reference/plugins/unpublish_plugin.md): Delete a workspace-published plugin from the catalog.
- [Variables & secrets](https://docs.testvibe.com/testvibe-api/api-reference/environment.md): Per-project environment values for Gherkin steps, runs, and generation.
- [list\_variables](https://docs.testvibe.com/testvibe-api/api-reference/environment/list_variables.md): List the project's variables with their values.
- [set\_variable](https://docs.testvibe.com/testvibe-api/api-reference/environment/set_variable.md): Create or update a project variable.
- [delete\_variable](https://docs.testvibe.com/testvibe-api/api-reference/environment/delete_variable.md): Delete a project variable.
- [list\_secrets](https://docs.testvibe.com/testvibe-api/api-reference/environment/list_secrets.md): List the project's secret names — never their values.
- [set\_secret](https://docs.testvibe.com/testvibe-api/api-reference/environment/set_secret.md): Create or update a project secret (encrypted, write-only).
- [delete\_secret](https://docs.testvibe.com/testvibe-api/api-reference/environment/delete_secret.md): Delete a project secret.
- [Files](https://docs.testvibe.com/testvibe-api/api-reference/files.md): Read the project's file tree, and write the parts you own.
- [list\_files](https://docs.testvibe.com/testvibe-api/api-reference/files/list_files.md): List the project's files — stored content plus the Playwright template scaffolding.
- [read\_file](https://docs.testvibe.com/testvibe-api/api-reference/files/read_file.md): Read one project file by path — stored content first, template fallback.
- [write\_file](https://docs.testvibe.com/testvibe-api/api-reference/files/write_file.md): Create or overwrite a project file under Features/ or Configurations/.
- [delete\_file](https://docs.testvibe.com/testvibe-api/api-reference/files/delete_file.md): Delete a stored project file under Features/ or Configurations/.
- [Configurations](https://docs.testvibe.com/testvibe-api/api-reference/configurations.md): The named Playwright configurations a run can execute under.
- [list\_configs](https://docs.testvibe.com/testvibe-api/api-reference/configurations/list_configs.md): List the Playwright configurations available to runs.
- [The testvibe CLI](https://docs.testvibe.com/testvibe-api/cli/cli.md): TestVibe from your terminal — manage features, run tests in cloud sandboxes, generate tests from Gherkin, and edit project files.
- [The TestVibe MCP server](https://docs.testvibe.com/testvibe-api/mcp-server/mcp.md): Every API operation as an MCP tool — point Claude or Codex at your TestVibe workspace.
- [Your first test from Claude Code](https://docs.testvibe.com/testvibe-api/guides/first-test-from-claude-code.md): Let an AI assistant create, generate, and run a TestVibe feature end to end.
- [Add a custom Playwright configuration](https://docs.testvibe.com/testvibe-api/guides/custom-playwright-config.md): Add a named Playwright configuration (e.g. Mobile) and run features under it.
- [Diagnose a failed generation](https://docs.testvibe.com/testvibe-api/guides/diagnose-a-failed-generation.md): A generation came back failed — here's how to find out why and fix it.
- [Run TestVibe in CI](https://docs.testvibe.com/testvibe-api/guides/run-in-ci.md): Gate your deploys on a green TestVibe run.
- [Statuses & limits](https://docs.testvibe.com/testvibe-api/resources/statuses-and-limits.md): Every enum and limit in one place.
- [Roadmap & changelog](https://docs.testvibe.com/testvibe-api/resources/roadmap-and-changelog.md): Where the API is headed, and what changed when.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.testvibe.com/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.