Skip to content

westpoint-io/mimik

Repository files navigation

Mimik mascot

Mimik

English · Español · Português (BR) · Français

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. Edit, replay, or export.

License Manifest V3 100% Local No Account
Stars Contributors Last Commit Issues

Table of contents

TOC


📺 Demo

Mimik demo

👋 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.

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

Important

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

Star Mimik on GitHub

Back to top

✨ Features

🎬 Auto-capture

Click, type, navigate. Mimik watches it all. Every meaningful action becomes a step: clicks on buttons and links, form inputs, keyboard shortcuts, clipboard actions, drag events, and page navigations.

Smart event merging deduplicates rapid clicks on nearby elements, so your guides stay clean. Click interception fires before the page navigates away, so nothing gets lost during SPAs or full page loads.

Back to top

📸 Annotated screenshots

Every step gets a screenshot with the clicked element highlighted and zoomed in. No manual cropping, no annotation tools to learn. Mimik figures out the important part of the page and frames it for you.

Back to top

🔒 Smart Blur

Mimik automatically detects and blurs sensitive data in your screenshots: emails, phone numbers, SSNs, credit cards, IP addresses, MAC addresses. 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.

Back to top

🧠 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 Click button "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).

Back to top

▶️ 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.

Back to top

📤 Multi-format export

Share guides in whatever format fits your workflow:

  • HTML: self-contained, share anywhere, base64-embedded images
  • PDF: print-ready, A4 portrait with auto page breaks
  • Markdown: paste into Notion, GitHub, internal docs, wikis

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

Back to top

🌍 Multi-language

UI available in English, Spanish, Brazilian Portuguese, and French. The AI description language is configurable independently, so you can run Mimik in English but generate guides in Spanish, or any combination.

Back to top

💾 100% local 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 sent directly to the AI provider you chose.

Back to top

🤝 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.

Back to top

📜 License

MIT © Westpoint. See LICENSE for details.

Back to top

Releases

No releases published

Packages

 
 
 

Contributors

Languages