Privacy-focused, local-only screen recording tool for creating step-by-step tutorials

TutorialMaker automatically captures your screen interactions and creates professional tutorials. Record once, export to multiple formats, edit with ease - all while keeping your data completely private and local.

• 🎬 Automatic Recording - Captures mouse clicks, keystrokes, and screenshots
• 🧠 Smart OCR - Recognizes text in buttons, fields, and UI elements
• 🌐 Web Editor - Browser-based editing for easy customization
• 📄 Multiple Exports - HTML, Word, PDF, and Markdown formats
• 🔒 100% Local - No cloud dependencies, complete privacy
• 🖥️ Cross-Platform - Windows, macOS, and Linux support
• ⚡ No Setup - Self-contained executables, no Python installation needed

1. Download the latest release for your platform:

   • Windows - tutorialmaker-windows-amd64.zip
   • macOS - tutorialmaker-macos-amd64.tar.gz
   • Linux - tutorialmaker-linux-amd64.tar.gz

2. Extract and run the executable - no installation required!

3. Create your first tutorial:

   • Web Interface (Default): Double-click executable → Browser opens → Click "Create New Recording"
   • CLI Mode: ./tutorialmaker --cli then use commands like new "My Tutorial"

git clone https://github.com/YOUR_USERNAME/tutorialmaker.git
cd tutorialmaker
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
python main.py

python main.py [OPTIONS]

Options:
  --debug           Enable debug mode with precise click markers
  --log-level LEVEL Set logging level (DEBUG, INFO, WARNING, ERROR)
  --cli             Use command-line interface
  --web             Force web interface (default is desktop GUI)
  --gui             Force desktop GUI interface (default)
  --port PORT       Web server port (default: 5001)
  --no-browser      Don't open browser automatically
  --help            Show help message

• Structured Logging: All application events are logged with appropriate levels
• Log Files: Daily log files saved to logs/tutorialmaker_YYYYMMDD.log
• Debug Mode: --debug enables detailed logging and visual click markers
• Log Levels: Control verbosity with --log-level DEBUG/INFO/WARNING/ERROR

1. Record - Capture your screen interactions automatically
2. Process - AI-powered OCR extracts text from UI elements
3. Edit - Use the web interface to refine your tutorial
4. Export - Generate professional documentation in multiple formats

• Software Documentation - Create user guides and help docs
• Training Materials - Onboard new team members
• Bug Reports - Show developers exactly what happened
• Process Documentation - Capture workflows and procedures
• Educational Content - Create step-by-step learning materials

• Windows 10 or later
• macOS 10.14 (Mojave) or later
• Linux with glibc 2.17+
• Memory: 4GB RAM (8GB recommended)
• Display: Any resolution (higher = better OCR)

• User Guide - Complete usage instructions
• Build Instructions - Building from source
• Contributing Guide - Development workflow
• Changelog - Release history

• Python Core - Screen capture, OCR, and session management
• Flask Web Server - Local editing interface
• PyInstaller - Self-contained executable builds
• Cross-Platform APIs - Native integration on each OS

• Smart OCR - Dual-engine text recognition (Tesseract + EasyOCR)
• Event Monitoring - Cross-platform input capture
• Export Engine - Multi-format document generation
• Web Interface - Browser-based tutorial editing

We welcome contributions! Please see CONTRIBUTING.md for:

• Development setup
• Code style guidelines
• Testing procedures
• Pull request process

• Local Processing - Everything runs on your computer
• No Data Upload - Screenshots and text never leave your device
• No Telemetry - No usage tracking or analytics
• Open Source - Transparent, auditable code

MIT License - see LICENSE for details.

• Tesseract OCR - Optical character recognition engine
• EasyOCR - Neural network-based OCR
• PyInstaller - Python executable packaging
• Flask - Web framework for the editing interface

• 🐛 Bug Reports - Create an issue
• 💡 Feature Requests - Suggest a feature
• 💬 Discussions - Join the discussion
• 📖 Documentation - Check the User Guide

Create tutorials effortlessly. Keep your data private. Share knowledge freely.

Download Latest Release | View Documentation | Report Issues