RendemoDocs
DocsOverview
Documentation

Rendemo developer documentation

How to build with Rendemo: the demo-versus-tour distinction, the <rendemo-demo> embed element, the marker contract for tours, the CLI, and the MCP server agents drive it all with.

Two things, not variations

Rendemo ships exactly two user-facing concepts, and almost every question about the product resolves once you know which one you are holding.

Watched

A demo

A recorded replay a visitor watches in an iframe on your site. Nobody touches your real app. Installed with <rendemo-demo demo="…">, inline or as a modal.
Performed

A tour

Step-by-step guidance on your own live product, which the person performs for real. Cards anchor to data-rendemo markers in your source and advance when they do the thing. Installed with <rendemo-demo demo="…" mode="tour">.

Watching versus doing is the whole distinction. A demo goes on a marketing page for someone who has not signed up; a tour goes inside the app for someone who has. Demos and tours is the page that settles it.

How the pieces fit

There are four surfaces, and they are the four pages after this one. Both concepts install with the same two lines — one script tag and one element:

html
<script src="https://www.rendemo.com/embed.js" async></script>
<rendemo-demo demo="acme/onboarding"></rendemo-demo>
  • The embed element — <rendemo-demo>. No package, no build step, no version to pin. Attributes, events and limits.
  • The marker contract — what a tour anchors to in your own source, plus the generated lockfile that fails your build when somebody deletes the element a step points at. Tours.
  • The CLI — rendemo: sign in, check the setup, and verify a tour against source offline. Commands and exit codes.
  • The MCP server — 65 tools an agent drives to produce, improve and ship demos. Endpoint and tool reference.
Recording is out of scope for the API by design: captures come from the browser extension. Agents improve and ship demos; humans (or the recorder) originate them.

Where to start

  • Using Claude Code? Getting started — install the plugin, sign in, state an intent.
  • Just need a demo on a page? The embed element is the whole surface.
  • Guiding people through your own product? Tours, and read what tours do not do before you roll one out.
  • Wiring up a different agent? The MCP server — endpoint, token, every tool.