Skip to main content

UI Testing features and availability​

View as Markdown
FreeTeamsScaleEnterpriseSelf-HostedDedicated

What Keploy UI Testing does today, where you use each feature, and the page that explains it. The surfaces are the capture SDK (@keploy/capture-sdk 3.1.0, in your web app), the Keploy dashboard (UI Testing → UI Flows), the REST API, the Keploy MCP server, and the keploy CLI.

The status of each feature is one of these:

  • Beta: works today. The whole of UI Testing is in beta, and the dashboard says so.
  • Beta, not runnable yet: part of replay, which is in beta, and whose runner, keploy ui run, is not in a release build yet. You can see it, but no test runs.
  • Available: a part of Keploy that UI Testing uses but that is not UI Testing's own, such as the apps API.
  • Not available: not in the product yet.

Recording​

FeatureSurfaceStatusPage
Record each visit: the page, through rrweb, and every fetch and XMLHttpRequest callSDKBetaInstall the SDK
Mask personal data in the browser: three privacy modes, mask, unmask and block selectorsSDKBetaPrivacy and masking
Honour Do Not Track and Global Privacy ControlSDKBetaVisitors' privacy signals
Keep credentials in your app's URLs out of the recording (secretRoutes, keepRoutes)SDKBetaCredentials in URLs
Redact request and response bodies off the main thread, with markers for what is not keptSDKBetaNetwork calls and bodies
Name each GraphQL operation a request runs (requestTerm)SDKBetaGraphQL
Record a single-page app's route changes, so each step belongs to its pageSDKBetaSingle-page apps and navigation
Sample page loads, keep capturing a long-open page, use your own session ids, pauseSDKBetaSessions and sampling
Report errors and warnings with a KUI_E_ code and a link to its fixSDKBetaUI Capture errors and warnings
Build with Vite, Next.js, webpack, Parcel, esbuild or no bundler, under a CSPSDKBetaBundlers and frameworks, CSP and workers

Setting up​

FeatureSurfaceStatusPage
Create an app to record intoREST, MCPAvailableCreate an app
Create, list and revoke ingest keysDashboard, REST, MCPBetaIngest keys and environments
Check that recordings arrive and have become flowsDashboard, REST, MCPBetaCapture status
End a visit at once, so its flows follow within minutesREST (ingest)BetaEnd a visit at once
Check from CI that a build still recordsRESTBetaCheck capture in CI
A read-only service-account key for one app (UI_READER), on a paid planDashboard (create), REST, MCPBetaCreate the service account
Sign in from a terminal or an agent, and connect an agentCLI (keploy login, keploy mcp-install)AvailableCLI
Set up and read everything from an AI agentMCP, RESTBetaOperate UI capture from an AI agent

Reading what was recorded​

FeatureSurfaceStatusPage
Flows: each page of each visit, with its steps and network callsDashboard, REST, MCPBetaFrom first visit to journeys
Journeys and the journey graph, each with its share of sessionsDashboard, REST, MCPBetaJourneys and replay (beta)
The journeys Keploy selects to testDashboard, REST, MCPBetaWhich journeys Keploy selects
Recompute the journey plan now (refresh=true)REST, MCPBetaThe plan over REST and MCP
The share of sessions that took any of a set of journeysREST, MCPBetaShare of sessions affected
The flow graphREST, MCPBetaThe flow graph
Flows scrubbed for an agent's contextREST, MCPBetaWhat an agent sees

Replay​

FeatureSurfaceStatusPage
Replay journeys as Playwright tests, against recorded mocksCLI (keploy ui run)Beta, not runnable yetReplay (beta)
Generate Test on a flow's page: creates a UI test run that stays pendingDashboardBeta, not runnable yetReplay (beta)
Read UI test runs and their verdictsDashboard, REST, MCPBeta, not runnable yetList test runs

Not available yet​

FeatureNotes
Pin a journey into the test planNo surface pins one. See Pinning.
Recompute the journey plan from the dashboardUse refresh=true over the REST API or MCP.
Accept an intended changeOn no surface.
Run reports by email, and share linksOn no surface.
A service-account role that runs UI tests in CIUI_READER only reads.
The dashboard's Flow Graph panel, Coverage tab, Impact Analysis panel and generated test sourceEach says the server does not expose it. The flow graph is on the REST API and MCP.
A retention setting for recordingsRecordings have no retention setting. A journey plan is kept 14 days.