# Mimik **English** · [Español](https://github.com/westpoint-io/mimik/blob/HEAD/.github/readme/README.es.md) · [Português (BR)](https://github.com/westpoint-io/mimik/blob/HEAD/.github/readme/README.pt-BR.md) · [Français](https://github.com/westpoint-io/mimik/blob/HEAD/.github/readme/README.fr.md) · [简体中文](https://github.com/westpoint-io/mimik/blob/HEAD/.github/readme/README.zh-CN.md) **Auto-capture any browser workflow into a step-by-step guide. No account, no cloud, no tracking.** Click record, do the thing, get a polished guide with annotated screenshots. Narrate it as you go, edit it after, then replay or export. [![License][license-shield]][license-link] [![Manifest V3][mv3-shield]][mv3-link] [![100% Local][local-shield]][local-link] [![No Account][no-account-shield]][no-account-link]
[![Stars][star-shield]][star-link] [![Contributors][contributors-shield]][contributors-link] ![Last Commit][last-commit-shield] [![Issues][issues-shield]][issues-link]

📺 Demo

https://github.com/user-attachments/assets/f71f5898-ee5e-4b22-b9fd-d5b45af73459

👋 Getting Started

Mimik turns any repetitive browser task into a documented, shareable guide in seconds. It runs entirely in your browser. No backend, no account, no telemetry, and nothing ever leaves your device.

Whether you're documenting internal tools, writing product tutorials, or onboarding a teammate, Mimik captures every click, keystroke, and navigation automatically so you can focus on the work.

Every meaningful action becomes a step: clicks on buttons and links, form inputs, keyboard shortcuts, clipboard actions, drag events, and page navigations. Rapid clicks on nearby elements are merged so guides stay clean, and clicks are intercepted before the page navigates away, so nothing is lost on SPAs or full page loads.

Each step gets a screenshot with the clicked element highlighted and zoomed in. No manual cropping, no annotation tools to learn.

Need the recording to look away for a moment? Pause stops capture without ending the recording, and Resume picks up where you left off. Entering Smart blur pauses it the same way.

Browser	Version	Install
Chrome		Chrome Web Store
Firefox		Firefox Add-ons
Edge		Microsoft Edge Add-ons

Available in English, Spanish, Brazilian Portuguese, French, German, and Simplified Chinese. The AI description language is set separately, so you can run Mimik in English and generate guides in Spanish, or any combination.

[!IMPORTANT]

⭐️ Star the repo if Mimik saves you time. It helps other people discover it!

✨ Features

🔒 Smart blur

Smart blur is a mode you enter while recording, not an always-on filter. Click Smart blur and capture pauses, Mimik detects and masks sensitive data on the page — emails, phone numbers, SSNs, credit cards, IP addresses, MAC addresses — and screenshots of that page keep it hidden once you click Done. Toggle each category independently.

Need to blur something custom? The manual blur picker lets you select any DOM element and mask it across every screenshot where it appears.

https://github.com/user-attachments/assets/f30fbcde-a705-45aa-b7bd-374e4762e6be

🧠 AI descriptions (optional)

Bring your own API key (OpenAI or Anthropic) and Mimik generates human-readable step descriptions like "Click the Submit button to save changes" instead of the rule-based Click Submit.

Descriptions are generated from a lightweight DOM context (~50-100 tokens), not screenshots. Roughly 15-30x cheaper than vision models. Choose the language you want descriptions in (English, Spanish, Portuguese, French, German, Chinese).

https://github.com/user-attachments/assets/ce797986-56d1-4f72-b149-17463684cdd7

▶️ Guide Me replay

Replay any guide live on a real page. Mimik highlights the next element to click, tracks your progress step by step, and advances automatically as you interact. Perfect for onboarding teammates or walking through a process yourself.

https://github.com/user-attachments/assets/8df5662f-e5e1-4a79-9c84-6f38becc4d03

🎙️ Voice narration (optional)

Talk through the workflow out loud while you record and Mimik turns what you said into the step descriptions. Audio is transcribed with your own key (OpenAI or Groq) and matched to the steps it belongs to, so you narrate once instead of writing every step by hand.

The full transcript is kept, not just the parts that made it into a step. Open Transcript on a guide to see everything you said, including the lines nothing was matched to, and add any of them to a step. Editing a step never destroys the spoken original either — the step editor can always put back what you actually said. The transcript stays on your device, is never part of an exported guide, and is deleted with the guide.

https://github.com/user-attachments/assets/41ef17fd-0d02-4e17-81c6-30ba2b7c47d0

✏️ Guide editor

Fix a guide after the fact without re-recording. Crop, annotate and redact any screenshot, rewrite a step with AI inline, drop headings and notes between steps, reorder or bulk-delete, and roll back through version history.

https://github.com/user-attachments/assets/b7eb0f6f-8957-4dbc-ab23-e23747719244

🔊 Video voice-over (optional)

Turn it on in the export panel and every step of a video export is read aloud, using your own OpenAI or ElevenLabs key. If you already set an OpenAI key for AI descriptions, Mimik reuses it (unless those point at a custom server, whose key stays there) — there is nothing else to sign up for. Narrated steps hold on screen until the voice finishes, so nothing gets cut off, and clips are cached locally so re-exporting the same guide costs nothing.

Off by default: holding a key never turns narration on, you do.

https://github.com/user-attachments/assets/e82132e4-caf1-49db-9077-d6eade210a89

📤 Multi-format export

Share guides in whatever format fits your workflow:

• Video: narrated walkthrough, mp4/H.264, with the cursor moving to each target — optionally with an OpenAI or ElevenLabs voice-over reading every step aloud, which also makes the export usable under Section 508
• GIF: short looping clip for a chat thread or an issue comment
• PDF: print-ready, A4 portrait with auto page breaks
• DOCX: open and keep editing in Word
• HTML: self-contained, share anywhere, base64-embedded images
• Markdown: paste into Notion, GitHub, internal docs, wikis
• Mimik file: the only format that imports back — see Share a guide below

All exports are generated client-side. Nothing touches a server.

https://github.com/user-attachments/assets/2a91221b-0f77-484d-9a47-74938a4ee585

📦 Share a guide

Export a guide as a .mimik file and someone else can import it into their own Mimik — same steps, same screenshots, still editable, and still replayable with Guide Me. It's a plain zip: a manifest, the screenshots, and a README.md so the file still reads as a document to anyone without the extension.

It travels as a file, so sharing works the same way anything else does — email it, drop it in Slack, commit it to a repo. There's no account and no server involved.

Because a guide can hold more than you meant to send, an export decides what leaves:

• Blurred areas are burnt into the pixels before the file is written, so the recipient has nothing to un-blur.
• Text you typed into fields is removed from the step text, title and links, not just from the stored value.
• Links are trimmed to the page address by default, dropping the query strings that carry session tokens.

Screenshots still show whatever was on screen when they were taken — use the blur tool for anything sensitive that the camera caught.

To import, open the dashboard and click Import, or drop a .mimik file onto your library. You'll see what the sender removed before anything is added.

🔐 Privacy & storage

Guides, steps, and screenshots live on your device. There's no backend, no account, no telemetry. Your API keys (if you bring one) never leave your browser — they're stored locally and used to call the provider you chose directly.

If you are masking personal data before sharing a guide, read what Smart blur does not cover first — it cannot reach iframes, shadow DOM, or text drawn into images.

Two things do leave the browser, both documented in the privacy policy: site icons are fetched from Google's favicon service, which sends that site's domain, and the optional AI, voice narration and video voice-over features send text or audio to the provider you configured — voice-over sends each step's text at export time, and only when you turn it on.

🤝 Contributing

Contributions of all kinds are welcome: bug reports, feature requests, PRs, and translations.

See CONTRIBUTING.md for development setup, project layout, and contributor guidelines.

⭐ Star History

📜 License

MIT © Westpoint. See LICENSE for details.