st_scribe

Record clicks and field changes in your Streamlit app and auto-generate a step-by-step how-to guide — like Scribe, but for Streamlit apps.

Great for internal tools: instead of writing a "how to use this dashboard" doc by hand, click Start Recording, use the app once, and export a shareable guide with screenshots, highlighted click points, and captions.

Install

pip install st-scribe

Usage

import streamlit as st
import st_scribe

# ... your normal app widgets ...

steps = st_scribe.recorder()

if steps:
    html_doc = st_scribe.to_html(steps, title="How to use this app")
    st.download_button("Download guide", html_doc, file_name="guide.html")

Click Start Recording, interact with your app as a user would, then Finish Recording. Each click and field change is captured as a screenshot with a red highlight ring on the clicked element, plus an auto-guessed caption (e.g. Enter "Priya Sharma" in "Employee name").

See demo.py for a complete example, including an editable review step before export.

streamlit run demo.py

How it works

st_scribe.recorder() is a Streamlit custom component. Its frontend JavaScript reaches into the parent app's DOM (same-origin, so this is allowed) to listen for clicks/changes anywhere in your app, and uses html2canvas to screenshot the page at each step. No screen-recording permissions or server-side rendering needed — it all happens in the browser.

Limitations

• Password field values are masked in captions, but the screenshot still shows whatever is visibly rendered on screen — don't record flows containing real secrets.
• Full-page screenshots can take ~1 second each on complex pages; the recorder shows a "Capturing..." status while this happens.
• Captions are heuristic guesses based on nearby labels/button text; review and edit them before exporting (the demo app shows how).