Reticle — Complete Usage Guide
The full reference and cookbook. If you haven’t set up Reticle yet, start with Getting Started. Contents- How Reticle helps you
- Core concepts
- The tools — full reference
- The predicate DSL — full reference
- Actions — full list
- Snapshot modes & scoping
- Cookbook: real situations
- Regression: baselines & diff
- Recording a flow
- Autonomous exploration
- Turning your test cases into agent checks
- Token discipline
- Best practices & gotchas
- FAQ
- Security & privacy
1. How Reticle helps you
You mostly talk to your agent in plain English — “add X and verify it works.” The agent uses Reticle under the hood. Here’s the value, by situation:- You stop being the agent’s eyes. Today you build a feature, then you click through the browser to check it. With Reticle the agent checks its own work and only comes back when it’s actually verified — or with a precise reason it failed.
- Silent breakage gets caught. A console error, a 500 on one locale, a button that quietly disappeared after a refactor — humans skim past these; Reticle asserts on them.
- The fix loop closes. When something’s wrong, Reticle reports the evidence — the failing network call, the console stack, and (on React) the source file:line to edit.
- It’s cheap enough to run constantly. ~100 tokens per verified interaction means the agent can verify on every edit, not just at the end (see token-efficiency).
- Your manual QA becomes automated. The checklist you never turned into Playwright tests? Your agent runs it now (see §11).
2. Core concepts
The loop: look → act → observe → assert.- Look with
reticle_snapshot(what’s on screen) orreticle_query(find a specific thing). - Act with
reticle_act(click/fill/…). It returns asincecursor — a timestamp marker. - Observe with
reticle_observe({ since })— everything the app did after that action. - Assert with
reticle_assert({ predicate })— verify it, get evidence.
e7. You get them from snapshot or query, then pass them to act/inspect. A ref re-resolves to its element across re-renders; if the element is gone, you get a clear error.
Evidence, not prose. Every tool returns structured data — counts, the matching network call, the snapshot delta — so the agent reasons over facts, not a vibe.
Sessions. Each connected browser tab is a session (named via reticle.connect({ session })). With one tab open you never specify it; with several, pass sessionId.
3. The tools — full reference
reticle_sessions
List connected tabs. → { sessions: [{ sessionId, url, title, lastSeenMs, hidden, focused, throttled }] }. lastSeenMs is the silence since the tab last reported (not time-since-connect); throttled is true when the tab is hidden or has gone quiet — a throttled tab silently no-ops timers/rAF/pointer.
reticle_snapshot
A semantic, accessibility-tree view of the page.
- args:
mode?: 'full' | 'interactive' | 'status'(defaultfull),scope?(CSS selector or ref),diff?: boolean,sessionId?. - returns:
{ tree, status: { route, title, visibleDialogs }, nodes, truncated, cost: { bytes, tokens } }. diff: truereturns only what changed since your last snapshot of the same scope/mode —{ mode: 'delta', delta: { added, removed, addedCount, removedCount } }or{ mode: 'unchanged' }(no full tree). The first call (and any call after a route change) still returns the full tree. ~99% fewer tokens to re-look after an action; see token-efficiency.md.costis an estimated size of the result — re-scope (mode/scope) before reading if large.
reticle_query
Find elements (Testing-Library semantics).
- args:
by: 'role'|'text'|'label'|'placeholder'|'testid'|'alt',value,name?(for role),scope?,sessionId?. - returns:
{ elements: [{ ref, role, name, value?, states, visible, text? }] }.
reticle_inspect
Deep detail on one element — including the signals a snapshot/a11y tree omits, so you can tell “present” from “actually usable / on-theme”.
- args:
ref,sessionId?. - returns: descriptor +
tag+box+occluded(another element covers its center — a z-index/overlay bug) +styles { color, backgroundColor, opacity, cursor, display, visibility }+theme { colorToken, backgroundToken, offTheme, tokenCount }(compliance vs the app’s:rootdesign tokens —offTheme:trueflags an off-palette color) +component { componentStack, source?: { file, line, column } }(with@reticlehq/react). - Use it to catch present-but-broken UI:
opacity:0/box0×0 /occluded:true(invisible or unclickable),cursornotpointer(dead control),offTheme:true(off-design-token color).
reticle_act / reticle_act_sequence
Perform one action / several in order.
reticle_actargs:ref,action,args?,refuseWhenThrottled?,sessionId?. →{ since, dispatched, settled, settleReason, result, session, warning? }whereresult = { ok, ref, action, dispatched, settled, settleReason, effect }. Thesessionblock{ lastSeenMs, throttled, focused }(F2) reports tab health on every act; whenthrottledis true awarningstring is also attached. PassrefuseWhenThrottled: trueto hard-fail instead of warning (opt-in; default is warn-only so background testing never breaks).reticle_act_sequenceargs:steps: [{ ref, action, args? }]. →{ since, dispatched, result }whereresult = { ok, count, effects: [...], steps: [...] }(oneeffectper step; each step carries its owndispatched/settled/settleReason).- See §5 for the action list.
requestAnimationFrame never fires, so Reticle falls back to a timer and resolves anyway. A settle timeout is therefore never an error — reticle_act resolves with settled:false, settleReason:"timeout" and the dispatch (the click) has still landed. Only a real dispatch failure (stale ref, wrong element type) throws.
result.effect — best-effort evidence the action landed. All probes are cheap and capture only the immediate effect (one microtask + one rAF after dispatch); async, network-driven re-renders show up in reticle_observe, not here.
Use it to distinguish failure modes:
visible:false/enabled:false/targetMatched:false → your action missed; the tool throwing → it never dispatched; occluded:true → the control is covered by something (a real user is blocked even though the synthetic event landed); defaultPrevented:true or all of valueChanged:false/focusMoved:null/domMutatedWithin:0 → the app didn’t react.
Clicks run the code, they don’t push pixels. A click/dblclick fires the full pointerdown → mousedown → focus → pointerup → mouseup → click sequence directly on the resolved element — so pointer- and focus-gated handlers fire the way they do for a real user, with no coordinate gesture to be intercepted by the presenter HUD or missed off-screen. This is the default even when native CDP real input is configured (inputMode:"synthetic", inputModeReason:"synthetic-click-preferred"). Before dispatch Reticle hit-tests the click point (occluded) and scrolls an off-screen target in (scrolledIntoView), so a blocked or off-viewport target is reported, never silently “successful”. For the rare case that needs a trusted native click — a native file picker, clipboard, or an isTrusted-gated handler — pass args:{ native:true } to drive it through CDP. hover/drag still use native pointer input (they need real hit-testing).
Cookbook — “Did my action even land?”
reticle_observe
The timeline + summary of what happened.
- args:
window_ms?(default 2000) orsince?(cursor from an act),filters?(event-type names),max_events?(cap the timeline to the most recent N),sessionId?. - returns:
{ window_ms, events: [...], summary: { network, domAdded, domRemoved, routeChanges, consoleErrors, animations, signals }, cost: { events, bytes, droppedOldest? } }. - Output budget. Every result carries a
cost:{ events, bytes }hint so you can self-budget your next call. Whenmax_eventstruncates the timeline, the dropped count is surfaced ascost.droppedOldest— never a silent cap. (The presenter HUD’s own animations are filtered out of the timeline automatically, soobserveshows the app, not the instrument.)
reticle_act_and_wait
Act, then wait for a predicate — the whole act→observe→assert loop in one hop.
- args:
ref,action,args?,until: <predicate>,timeout_ms?(default 4000; 0 = evaluate once),refuseWhenThrottled?,sessionId?. - returns:
{ effect, verdict, trace, session, warning? }—effectis the action result ({ ok, ref, action }),verdictis{ pass, evidence?, failureReason? },traceis the reaction report of everything the app did after the action, andsession(F2) is the tab-health block{ lastSeenMs, throttled, focused }(with awarningwhen throttled). A failingverdictstill returnseffect+traceso you can see what did happen. The predicate is automatically floored at this act’s cursor, so it only matches events the action actually caused.
reticle_wait_for
Block until a predicate holds (or time out). Looks both backward (recent buffer) and forward.
- args:
predicate,timeout_ms?(default 4000),since?,sessionId?. - No stale-signal false passes. By default the evaluation window is floored at your last act’s cursor, so a signal/network/console/animation event buffered before the action can never satisfy the predicate (the report’s “validation 68 == 68 was a lie” footgun). Pass an explicit
since(an act/observe cursor) to widen or narrow the window deliberately. Element/text predicates query the live DOM and are unaffected bysince.
reticle_assert
Verify a predicate; optionally wait for it.
- args:
predicate,timeout_ms?(0 = evaluate once),since?,sessionId?. - Same
sincedefault asreticle_wait_for: scoped to your last act so a stale buffered event can’t fake a pass; override with an explicitsince. - returns:
{ verified, because, pass, evidence, contradictions?, coverage?, failureReason?, session, warning? }. On failure includes a near-miss (e.g. “found the dialog but not visible”, or “no button named ‘Submit’; saw: Cancel”). Thesessionblock{ lastSeenMs, throttled, focused }reports tab health on every assert; when throttled awarningis attached so you never assert against a tab that is silently no-oping. - Read
verified, notpass.passsays the predicate held;verifiedsays whether that means anything. It is"no"when a channel contradicts the assertion (a failed write under a green screen, a batch whose body reports per-item failures, a request still in flight), and"unknown"when the outcome could not be known yet — a202 Acceptedthat has not reconciled, or a write whose response body was never recorded.becausenames the deciding evidence in one sentence.
reticle_reconcile
Compare what the API returned against what the page renders.
- args:
since?,urlContains?,sessionId?. - returns:
{ mismatches, compared, note? }. - Catches the class no status code and no assertion can reach: a
USD 7997amount rendered as₹79.97, or a record the API callson_holddisplayed as"pending". Both sides agree on the digits; only the meaning differs, so every other channel reports success. - Needs response bodies —
connect({ captureNetworkBodies: true }). When nothing could be compared it says so innoterather than returning an empty, clean-looking result over data it never read.
reticle_network / reticle_console / reticle_animations
Fast targeted lookups without a full timeline.
reticle_network({ since?, method?, urlContains?, status? })→{ calls }reticle_console({ level?, since? })→{ logs }reticle_animations()→ running/recent animations.
reticle_capabilities
The app-advertised testable surface (registered via reticle.describe). Call this first to learn what to assert on without reading source.
reticle_capabilities({ sessionId? })→{ testids, signals, stores, flows }
reticle_sessions also surfaces a hasCapabilities flag per session so you know when it’s worth calling. Returns empty arrays (never errors) if the app advertised nothing.
reticle_domain
Read the app’s domain model before testing: a synthesis of every saved flow + the registered capabilities. Tells you what to test and where the real risk is without crawling the app. Reads .reticle/flows/ + .reticle/contract.json — no browser needed.
reticle_domain({})→{ flowCount, flows: [{ name, steps, grade, asserts, signals, testids, warning?, risk? }], declared: { testids, signals, stores }, coverage: { asserted, presenceOnly, assertionFree }, gaps: { unassertedFlows, declaredUntestedSignals, declaredUntestedTestids }, riskRanked, summary }gapsis the point:declaredUntestedSignalsare intents the app emits that no flow asserts (untested behavior);unassertedFlowsact but verify no consequence. Close them with a flow + a consequence assertion (reticle_annotate).riskRankedorders flow names worst-first by combining run history (.reticle/project.json: recently failed/drifted, or passed-with-errors) with assertion quality (a green assertion-free flow is still risky). Test these first. Each flow’sriskcarries{ level, reason, lastStatus? }.
reticle_state
Read live framework/store state directly instead of inferring it from the DOM — §17.
reticle_state({ store?, ref?, path?, depth?, sessionId? })→{ stores, component? }, or{ store, path, found, value, availableKeys?, storeNames }whenpath/depthis given.
ref component read is best-effort and bounded: when the component state can’t be read it returns component: { ok: false, reason: "component-state-unavailable" } rather than hanging.
Scope big stores so you don’t pay for them. A whole store can be tens of KB. Narrow the read:
pathextracts a dot-path sub-tree relative to the namedstore(numeric segments index arrays), e.g.reticle_state({ store:"workspace", path:"captionCache.v3.0.text" }).depthcollapses anything deeper than N levels to a compact size marker ({…7 keys},[Array(120)]) so you can skim a store’s shape before drilling in.- A wrong
pathreturns{ found:false, availableKeys:[...] }— the keys that were present where the walk stopped — so a mistyped path is self-correcting, not a barenull.
Detecting wasted re-renders (React)
A page can be thrashing — committing many React renders a second — while the DOM stays visually identical. The DOM/screenshot tools see an idle page; only a tool inside the runtime sees the commit rate. Reticle exposes it as a registered store you read withreticle_state:
reticle_session {action:"narrate"} / reticle_clock
Show the agent’s intent on the page, and control time (toasts/debounces/auto-dismiss) — §16.
reticle_baseline {action:"save"} / reticle_baseline {action:"list"} / reticle_baseline {action:"diff"}
Regression detection — §8.
reticle_record {action:"start"} / reticle_record {action:"stop"} / reticle_replay
Capture a flow’s reaction report and compile it into a replayable program — §9. reticle_record {action:"stop"} also returns a cost:{ events, bytes } hint alongside the reaction report so you can gauge the recording’s size.
reticle_explore
List interactive elements + console-error count for autonomous exploration — §10.
Flows, recorder & self-healing (.reticle/)
reticle_contract_save, reticle_flow_save / reticle_flow_save_recorded / reticle_flow {action:"list"} / reticle_flow {action:"load"} / reticle_flow_replay / reticle_flow_verify, reticle_flow_heal, reticle_annotate — record once, replay forever (anchored on testid/signal — or an auto-derived component/source anchor when there’s no testid), with legible drift + self-heal. Full guide: Flows, the recorder & self-healing.
reticle_flow_verify({ names?, sessionId? })— the regression-suite call: replays EVERY saved flow (or a subset) deterministically and returns one verdict{ status, passed, failed, failures: [{ flow, verdict, whatChanged, whereInSource, nextAction }] }. Passing flows are counted; only failures carry detail. Run it after any change — one call, no LLM per flow.- Decision envelope: on a drift/fail,
reticle_flow_replay(and eachreticle_flow_verifyfailure) returns the actionable fix —whatChanged,whereInSource(file:line), and a one-linenextAction(e.g. “rebind the anchor to ‘new-deploy’, or update the flow if intended”).
Human-in-the-loop control
reticle_session {action:"end"}, reticle_session {action:"resume"}, reticle_session {action:"messages"} — the human can pause the agent, send it a correction, or end the session from the floating panel; the agent receives guidance on its next tool call. Full guide: Human-in-the-loop control.
reticle_session {action:"review"} — drain the bugs the human flagged on the page
The dev clicks “Flag a bug” in the running app, points at the element that looks wrong, and types what’s wrong (⌘/Ctrl+Enter to send). Each flag becomes a mark the agent drains:
file:line (when the framework stamped one), and a ready-to-act fix hint. Open the file, apply the fix, then reticle_session {action:"review"}({ resolve: "m1" }) — the human watching the panel sees ”✓ fixed: …” land. Reading never consumes a mark, so you can list → fix → verify → resolve. reticle_sessions also reports pendingMarks so you notice flagged bugs during normal orientation.
reticle_network_mock — stub the network for error-state testing (driven mode)
On a page Reticle drives (reticle drive), make a request return a 500, force it offline, or delay it — so testing error/edge states is one declared rule, no backend changes:
urlContains + optional case-insensitive method). Needs a driven browser; without one it returns a recommendation pointing at reticle drive.
reticle_viewport — reproducible visual baselines (driven mode)
Pin the driven page to a fixed viewport so a screenshot baseline is reproducible across machines:
reticle_viewport({ width, height })— same dimensions on every machine.reticle_clock({ freeze: true })— kill animation/time jitter so the pixels are stable.reticle_visual_diff({ baseline, masks: [{ x, y, width, height }] })— neutralize volatile regions (clocks, avatars, ids) so only real changes fail.
4. The predicate DSL — full reference
A predicate declares what should be true.reticle_assert / reticle_wait_for evaluate it against the live DOM + the event buffer.
Leaf predicates
state assertion is graded as a consequence (a wrong element or stale render cannot fake it), and is usable the same three ways anywhere predicates flow: ad-hoc (reticle_assert / reticle_act_and_wait until), as a flow step invariant (reticle_annotate { kind: "assert-state", statePath, store?, equals? }), and as a flow’s golden end-condition (reticle_annotate { kind: "success-state", statePath, … }). On a miss it names the real store value and the keys that were available — legible, not a blind fail.
Combinators
Timing
timeout_ms(onassert/wait_for): wait up to N ms for it to become true.since(onnet/consoleleaves): only consider events after this cursor (fromact).
dataMatches uses shallow JSON matching; * means “present, any value”.
5. Actions — full list
reticle_act({ ref, action, args }):
6. Snapshot modes & scoping
reticle_snapshot has three modes — pick the cheapest that answers your question:
status(~30 tokens) — route, visible dialogs, counters. “Where am I, is a modal open?”interactive(~100 tokens) — only actionable elements (buttons, inputs, tabs…). “What can I click?” Non-interactive content (e.g. 1,000 list rows) is skipped.full— the whole semantic tree. Use only when you truly need everything.
scope narrows any snapshot or query to a subtree — a CSS selector (scope: "[data-testid=item-list]") or a ref. This is the main lever for keeping payloads small and queries unambiguous on big pages.
7. Cookbook: real situations
Each is phrased as the situation you’re in, then how the agent verifies it.”I told the AI to add an icon button that opens a modal"
"I changed an API call — did it fire correctly and update the UI?"
"I clicked a button and it should add an element on another page/section”
Act in section A, navigate to B, assert there:“Data shows up only after ~30s (eventual consistency) — how to refresh and see it"
"The list has 100s/1000s of rows — was my item actually added?”
Don’t scroll and eyeball — query finds it regardless of position:
Note: if your list is virtualized (react-window/virtuoso), off-screen rows aren’t in the DOM yet — scroll-to-find support is on the roadmap; for now scroll the container or assert against the data via an reticle.signal.
”Login form — does it actually authorize?"
"Make sure there are NO console errors"
"A real LLM call generates a script — is it happening and rendering?"
"Upload a file → it calls an LLM → a modal shows a score"
"A button’s color should change on hover”
Pure CSS:hoverstyling needs a real pointer; drive hover effects from JS state (or use a Playwright real-hover) if you need pixel-exact:hover. Reticle reads computed style after the JS state change.
”Something off-DOM happened — a webhook arrived, a store changed”
Surface it from your app, then assert on it:reticle_capabilities() — see §3.
Keeping signals from drifting (lint)
Signals only help if you actually emit one whenever user-visible state changes. The@reticlehq/eslint-plugin package ships one rule, reticle/require-signal-on-mutation, that flags any function which calls a configured store mutator but never fires the signal callee in the same body — so the signal map can’t silently fall behind the store.
mutators lists the callee names that change state; signalCallee (default ['reticleSignal', 'signal']) is the name that counts as firing a signal. See packages/eslint-plugin/README.md for scoping and matching details.
8. Regression: baselines & diff
The “did anything silently break/disappear?” workflow.diff ignores volatile ref ids and compares the semantic structure, so you get real ADDED/REMOVED elements plus the current console-error count. Great as a guardrail the agent runs after each edit: “diff against checkout-ok; fail if anything interactive was removed or console errors increased.”
Pixel-perfect visual regression that’s stable in CI (driven mode)
The semanticreticle_baseline {action:"diff"} above never flakes. For an actual pixel diff (reticle_screenshot + reticle_visual_diff, driven mode), three knobs make it CI-stable instead of flaky:
9. Recording a flow
Capture everything that happens across a span — useful for “run my whole checkout flow and tell me what happened,” or to keep a known-good trace.reticle_record {action:"stop"} returns a compiled, replayable program: the agent’s reticle_act / reticle_act_sequence invocations captured during the span, with each ref normalized to its element’s data-testid where resolvable. Re-run it later:
data-testid. A step whose element has none is stored in ref form (stable: false) and reticle_record {action:"stop"} returns a warning; replay best-effort re-uses the stored ref, which is only valid within the same live session and is not portable across reloads. Add data-testid to the elements you want replay-stable.
10. Autonomous exploration
Have the agent crawl and stress a screen without a script:11. Turning your test cases into agent checks
If you already have test cases — a QA checklist, acceptance criteria, a spreadsheet, manual steps — you can hand them to your agent and have it run + verify each against the live app. Each case becomes a predicate:
A practical workflow:
“Here are our 12 dashboard test cases. For each, drive the app with Reticle and tell me pass/fail with evidence. For any failure, show the source file to fix.”This is the sweet spot: the manual cases you never automated become things the agent runs in seconds, on every change. It complements your CI Playwright/Cypress suite (which gates releases) — Reticle is the in-loop checklist while you build.
12. Token discipline
Reticle is cheap by design (benchmark), but keep it that way:- Prefer
reticle_query+reticle_assert(~30 tokens each) over snapshots inside the loop. - Use
mode: "interactive"or"status", not"full". - Use
scopeto look at just the relevant subtree. - Reach for
mode: "full"only when you truly need the whole page.
13. Best practices & gotchas
- Accessibility = legibility. Real
roles, labels, anddata-testids make queries precise and stable. It’s also just good a11y. - Stable handles for controls. Prefer
data-testidover names that include dynamic counts (e.g. “Notifications (3)”) — the count changes the accessible name. - Always thread
since. Pass the cursor fromreticle_actintoobserve/assertso you only consider what happened after the action. - Use
timeout_msfor async. Don’t assert instantly on something that arrives over the network or after a re-render. - Watch
session.throttled(F2). Background tabs throttle timers/rAF/pointer gestures, so an act can silently no-op. Everyreticle_act/reticle_assert/reticle_act_and_waitresult carriessession: { lastSeenMs, throttled, focused }and, when throttled, awarning. Refocus the tab (or run it foregrounded) before driving; passrefuseWhenThrottled: trueto hard-fail instead. - Scope big pages. On dashboards with hundreds of elements, scope queries to the panel you care about.
- Never breaks your app. Observers are additive and reversible (
reticle.disconnect()restores patched globals). It won’t interfere with your app’s behavior.
14. FAQ
Does this run in production? No — keepreticle.connect() behind a dev guard. The SDK is side-effect-free and tree-shakes out of prod builds.
Do I have to change my components? No, for basic look/act/observe. You’ll get better results by adding data-testids and labels where the agent needs precision.
Does it work without React? The core (DOM/network/route/console/animation/snapshot/actions) is framework-agnostic and is gated against a vanilla-TS app. React, Next.js, Remix and Astro each have an app and a CI gate. SvelteKit is wired end-to-end — reticle init writes the client hook and the Vite plugin, and the plugin stamps data-reticle-source into .svelte components so verdicts carry file:line — but there is still no SvelteKit app in CI, so it is unverified rather than supported. Vue has a Pinia store adapter and nothing else: no detection, no .vue stamping, no gate. See what Svelte support is and is not.
Can it judge whether my UI looks good? No. Reticle verifies behavior, not aesthetics. Visual/pixel correctness and “does it feel right” remain human (or a visual-diff tool).
Does it replace Playwright/Cypress? No — those are your scripted CI suite. Reticle is for in-loop verification while the agent codes, and for the cases you never automated. They compose.
How does it compare to Playwright MCP / Chrome DevTools MCP? Those let an agent drive/ inspect a separate browser; Reticle verifies your own running app (real session/auth) with assertions + regression as first-class, far more cheaply. See the README comparison.
Multiple tabs/apps? Each is a session; pass sessionId to any tool when more than one is connected (reticle_sessions lists them).
15. Security & privacy
- Dev-only, localhost-only by default. The bridge binds
127.0.0.1; the SDK is meant for dev builds. - No app data leaves your machine. Baselines/recordings are local. The CLI sends anonymous, opt-out usage metrics only (random id + event names — no code, no PII; see telemetry); opt out with
reticle telemetry disable,RETICLE_TELEMETRY=0, orDO_NOT_TRACK=1. Feedback you or your agent deliberately send (reticle feedback/reticle_feedback) is the only free text that ever leaves the machine — never passive, redacted first, and separately disabled withRETICLE_FEEDBACK=0. - Network bodies aren’t captured by default — only method/url/status/timing. Body capture is opt-in and runs through a redactor (drop
password/token/secret/… + your patterns). - Additive & reversible. Reticle patches
fetch/History/console defensively and restores them on disconnect; it will not break the app under test.
Extending the redaction rules
The built-in rule catches the credential names that are common across apps. Yours has its own vocabulary in both directions — alicenceKey it has never heard of, and a designToken it redacts by mistake — so connect() takes a redact option:
keysadds to the rule. A string matches a key name exactly, case-insensitively —'code'does not redactcodeOwner. A RegExp is tested against the key.allowexempts a key from the default rule. It loses tokeys: an explicit redact instruction beats an exemption. Exempting a key the default rule considers a credential prints a one-time warning naming it — that value now reaches the agent transcript and the on-disk journal in cleartext.- There is no way to replace the default set. Both options are additive on purpose: a config that could turn the whole rule off would eventually ship in an app that leaks, and Reticle would be the thing that recorded it.
- With no
redactoption, behaviour is exactly what it was before this option existed — pinned by a test that walks every credential name and every known false positive.
reticle drive, or a CDP-attached browser) do not — the daemon reads them straight from the network stack. So the literal strings in keys are announced to the daemon when your app connects, and it redacts them there too. Two parts deliberately stay in the page:
A RegExp does not travel because compiling a pattern that arrived over a socket and running it against every key of every request body is a denial-of-service surface.
allow does not travel because it is the only part of the config that removes redaction, and the driven path keeps the built-in floor rather than letting a page lower it. Both exclusions fail in the safe direction: the driven path can over-redact relative to your config, never under. If a key must be redacted everywhere, name it as a plain string.
16. Presenter mode, narration & fake clock (watch + control)
Presenter mode — let a human watch the agent
Turn it on when connecting:- a glowing border while the agent is working,
- a synthetic cursor that flies to each target before acting,
- click ripples, hover rings, and a status HUD (“Clicking button “Save”… ✓ passed”),
- a per-action pacing delay (
pace, ms) so a human can follow.
data-reticle-* and is excluded from snapshots/observers, so it never pollutes what the agent sees. Use setIgnoreSelectors([...]) to also hide your own dev widgets.
Session liveness — the HUD never gets stuck “running”
A session starts on the agent’s first activity and must reliably end even when the agent misbehaves. Reticle is an MCP tool, so the agent (Claude) can crash, disconnect, or simply forget to callreticle_session {action:"end"} — and a backgrounded tab’s own timers are throttled by the browser. So the Node server owns liveness, not the browser tab:
- Agent goes idle / forgets to end → a server-side reaper (immune to tab throttling) ends the session after
idleEndMsof no agent commands and pushes the end to the browser. A backgrounded tab still receives that push, so you can switch windows and come back to a correctly-ended HUD. - Agent (MCP client) disconnects cleanly → every active session ends at once.
- Agent kills the Reticle server process (so no push can arrive) → the SDK self-ends the session after it can’t reach the bridge for
BRIDGE_LOST_MS(~15s), showing “lost connection to Reticle.” - Slow-but-alive agent → if it goes quiet long enough to auto-end and then acts again, the session revives automatically (an explicit
reticle_session {action:"end"}stays terminal).
reticle_session({ idleEndMs }) — it updates both the browser timer and the server reaper. The human keeps the panel (with Copy/Export of the run) after any end.
reticle_session {action:"narrate"} — show the agent’s intent
So the human sees what the agent is about to do and why:
reticle_clock — control time deterministically
Fast-forward toasts, debounces, auto-dismiss, and commit-on-blur without waiting:
requestAnimationFrame/microtasks (React’s scheduler keeps running), and Reticle’s own internal timers are insulated, so freezing never stalls the tools.
Action refinements (from real-app use)
blurnow fires a bubblingfocusout, so React’s commit-on-blur (onBlur) runs — inline editors and form fields commit.fill/typefocus first so a laterblurcommits.hoveraccepts{ holdMs }to dwell, so timer-gated reveals mount; thenwait_forthe revealed nodes.dragyields a frame between phases (React flushes between steps) and accepts{ data: { mime, value } }for customdataTransferpayloads.
Richer dataMatches (signals)
reticle_observe’s summary now includes domChanged (in-place text/attribute re-renders, not just added/removed nodes).
17. Evidence-of-effect, act+await, state, capabilities, replay
These close the “is the action trusted?” gap — so you can tell my action missed vs the app didn’t react vs the tool didn’t dispatch.reticle_act returns evidence-of-effect
Every reticle_act result now carries an effect:
settled:false, settleReason:"timeout" means the settle frame did not flush within the budget (a throttled/background tab) — this is not a failure: the dispatch landed and the tool resolved.
Read it to disambiguate failures instantly: targetMatched:false = your ref was stale; defaultPrevented:true = a handler cancelled it; domMutatedWithin:0 + valueChanged:false = the app didn’t react.
reticle_act_and_wait — one hop for act → observe → assert
until, and returns the action’s effect + the verdict + the full causal trace. Collapses four calls into one.
reticle_state — read live framework/store state
No need to broadcast a signal for every fact. Register stores in your app:
registerStore accepts anything shaped { getState, subscribe }, so zustand and Redux (and Redux Toolkit) need no adapter at all — pass the store. For everything else Reticle ships adapters, because the shape is the only thing missing:
{ subscribe } is the entire contract, no getState. svelteStore reads the current value by subscribing, catching the synchronous first callback the store contract guarantees, and unsubscribing immediately (the same thing svelte/store’s own get() does), so it holds no lasting subscription and needs no teardown. It also swallows that first callback on subscribe, because forwarding it would emit a state change at registration time for a change that never happened.
piniaStore subscribes with detached: true and flush: 'sync'. Without detached, a store registered from inside a component goes permanently silent after that component unmounts — still readable, but never emitting another state change, which reads exactly like an app that stopped changing. Without sync, the notification lands a Vue tick late, outside the window that links a state change to the click that caused it. Note that $state carries state, not getters: a Pinia getter is derived, so asserting on the state it derives from is the stronger assertion anyway.
Recoil has no enumerable registry of live atoms and no per-atom subscription outside React, so it takes an atom map (like Jotai) plus the transaction stream from a small bridge component:
{ status, value, error } rather than a bare value, because Recoil atoms can be async: calling getValue() on a pending selector throws the pending promise, which would lose the whole state read over one slow atom. A loading atom reports status: 'loading' instead of silently reading as empty.
TanStack Query is worth registering even if you register nothing else. Its cache holds the state most likely to be wrong in a way nothing else can observe: a stale value served as fresh, a mutation that never invalidated its query, an optimistic update never rolled back. None of those fire a network request, so a network log shows silence and the DOM shows a plausible number — the cache is the only witness. The adapter exposes status, fetchStatus, isStale and dataUpdatedAt per query key, so an agent can assert the stronger property: not “the number rendered is 42” but “the number rendered came from fresh data”.
React Context / useState / useReducer have no store object to adapt — the value lives in the fiber tree and the only subscription is a re-render. Invert it with the hook:
path (dot-path, numeric segments index arrays) and depth keep a 60KB store from becoming a token tax — and a wrong path returns the keys that were there, so it’s self-correcting.
Charts and dashboards — geometry faults report themselves
Every dashboard widget except one renders text a comparison can read: a KPI card renders a number, a table renders rows. A chart renders geometry — the data has been through a scale function into coordinates — and a perfectly correctseries in the store can still become a blank, flat, or NaN-filled path. Neither a state read nor a screenshot-vs-baseline catches that.
So any element descriptor containing faulty plot geometry carries a chart field. There is no extra tool call and no flag: query the chart the way you already would, and a broken one tells you.
kind is one of non-finite-coordinates (a zero-range scale divided by zero — always a bug), empty-geometry (the chart mounted but no data reached it), or degenerate-geometry (every point identical). A healthy chart adds no field at all, so this costs nothing on the common path. A genuinely flat line — constant data — is not flagged.
Canvas charts (Chart.js, ECharts) are pixels, not DOM, so nothing above applies. Read their data directly instead, which is the only route short of vision:
reticle_capabilities — the app’s testable surface
Declare it once so the agent learns the surface without reading source:
reticle_replay — recordings become re-runnable programs
reticle_record {action:"start"} → drive the flow → reticle_record {action:"stop"} returns a compiled program (steps bound to testids/signals, not volatile refs). reticle_replay({ recordingName }) re-executes it — your flow becomes a deterministic regression run, not a checklist.
18. Real input mode — native hover & drag
Reticle drives actions by dispatching JS events from inside the page. That covers click, fill, type, select, submit, press, and HTML5 drag — but it cannot trigger browser-native pointer behavior:onMouseEnter/onMouseLeave, hover-gated reveals, and pointer-library drags rely on the browser’s real hit-testing, which synthetic events don’t drive.
Clicks are synthetic by default — on purpose. Even with real input configured, click/dblclick run the occlusion-honest synthetic path (full pointerdown→…→click sequence + a occluded hit-test + off-viewport auto-scroll), reporting inputModeReason:"synthetic-click-preferred". There’s no coordinate gesture for the presenter HUD to intercept or to miss off-screen, and synthetic dispatch reaches the resolved element directly. Reserve native clicks for the rare isTrusted-gated case (native file picker, clipboard) with args:{ native:true }. Real input remains the path for hover/drag, which genuinely need the browser’s hit-testing. Every reticle_act result tells you which path ran:
inputMode is "synthetic" and the target has hover/enter handlers, the result carries a warning so you know a hover may be a no-op — you never have to reverse-engineer it.
inputModeReason — never a silent fallback. When real input is configured but a pointer act still ran synthetic, the result says why, so per-element inconsistency is diagnosable instead of mysterious:
(No
inputModeReason is set when real input simply isn’t configured — synthetic is the expected default there.)
Enable real input (optional, opt-in)
Point Reticle’s server at a Chrome DevTools (CDP) endpoint; it then drives real pointer input (via PlaywrightconnectOverCDP) at the element’s box for hover/drag (and for click/dblclick only when you pass args:{ native:true } — clicks default to synthetic), and reports inputMode: "real".
-
Launch your browser with remote debugging:
-
Tell the Reticle server where it is, via the MCP config
env:
RETICLE_CDP_URL set, Reticle stays in the synthetic (zero-dependency, in-page) mode — Playwright is an optional dependency loaded only when you opt in.
SPA navigation is handled. The URL correlation tracks client-side route changes (pushState/replaceState/popstate), so real input keeps working after your app navigates into a sub-route — e.g. the hover/quick-edit cluster on a/workspaceview stays drivable. (If you seeinputModeReason:"page-not-correlated-to-a-cdp-target", the reported session URL isn’t correlated to a CDP target and real input silently falls back to synthetic.)
Watching the agent (presenter). Withpresent: truethe activity border now glows once while the agent is busy and fades when idle (no per-action strobe); the HUD sits bottom-center, shows a READING vs ACTING chip so you can tell observation from action at a glance, andreticle_session {action:"narrate"}lines are queued with a minimum on-screen dwell so none flash by unread.
Limitation — un-scriptable tabs. Reticle observes/drives a tab through the in-page SDK + (optionally) CDP; it cannot bring to front or recover a browser tab the OS won’t let it script (e.g. a backgrounded or non-default-browser tab reportinghidden:true/throttled:true). When that happens,reticle_sessionsand every act/assert result carry asession.recommendationsaying so and pointing toreticle drive <url>for a guaranteed scriptable context — refocus the tab, or usereticle drive.