Codevid

Turn your automated tests into professional video tutorials.

Codevid is a CLI tool that uses AI to convert your existing Python Playwright tests into narrated, captioned video tutorials. It analyzes your test code, generates a natural language script, records the execution, and automatically edits everything into a polished video.

🎬 How It Works

demo2.webm

Generated Tutorial

Here's the result - a fully narrated video tutorial generated from the test above:

https://github.com/user-attachments/assets/de1d647b-527b-4c66-a46b-7b86247c345c

🚀 Features

• Automated Scriptwriting: Uses LLMs (OpenAI/Anthropic) to explain why an action is happening, not just what is happening.
• Real Execution: Records your actual app in a browser to ensure the video matches reality.
• AI Voiceovers: Integrated Text-to-Speech (OpenAI/Edge TTS) for professional narration.
• Smart Editing: Automatically synchronizes video speed with audio narration and adds captions.
• Stable Sync: Keeps narration aligned even when multiple narration segments map to one test step.

📋 Prerequisites

• Python 3.11+
• OpenAI API Key: Codevid requires access to an LLM to generate the narration script.

🛠️ Installation

1. Install Codevid (assuming it is available via pip or from source):

   pip install codevid
   

   For local development with uv (from source):

   uv sync --extra dev
   

2. Install Playwright Browsers:

   playwright install chromium
   

   If you used uv, run:

   uv run playwright install chromium
   

🔑 Configuration

You must provide your OpenAI API key for the tool to function.

export OPENAI_API_KEY="sk-..."

(Alternatively, you can configure Anthropic/Claude keys if you prefer that provider in the config).

⚡ Quick Start

1. Initialize a project (optional, creates a codevid.yaml config file):

   codevid init
   

2. Generate a video: Pass your Playwright test file to the generate command.

   codevid generate examples/test_login.py -o login_tutorial.mp4
   

📖 Usage Examples

Basic Generation

Uses default settings (Anthropic/Edge TTS if not configured otherwise) to generate a video.

codevid generate tests/my_test.py

Using OpenAI for Everything

Specify the LLM and TTS provider explicitly via CLI flags.

codevid generate tests/my_test.py \
    --llm openai \
    --tts openai \
    --voice alloy \
    --output tutorial.mp4

Preview Script Only

Want to see what the AI will say before recording? Use preview mode.

codevid preview tests/my_test.py

List Available Voices

See which voices are available for your chosen provider.

codevid list-voices openai

⚠️ Current Limitations

• Framework Support: Currently, Codevid only supports Python Playwright tests.
• Structure: Tests must be written as standard functions or Pytest functions (e.g., def test_example(page):).

📄 License

MIT