# ScreenCI

> Automated product video generation and maintenance platform

## Overview

ScreenCI is a platform that treats product videos like code. Instead of manual video editing, you write scripts that automate browser interactions, add narration, and generate videos programmatically. When your product changes, simply update the script and regenerate the video.

## Key Concepts

### Script-Based Videos

- Videos are defined by TypeScript/JavaScript scripts using Playwright
- Scripts automate browser interactions to capture product workflows
- AI-generated narration syncs automatically with visual actions
- Changes to scripts instantly regenerate videos

### Edit by Typing

- Update video content by editing text, not re-recording
- Change narration without video editing software
- Modify UI interactions by updating script selectors
- Version control for videos using Git

### Deployment Automation

- Videos rebuild automatically when your product UI changes
- CI/CD integration for continuous video updates
- Preview deployments for testing video changes
- Roll back to previous versions instantly

## Documentation

### Getting Started

- Introduction: /intro
- Recording Flows: /guides/recording
- Editing by Typing: /guides/editing
- AI-Supported Editing: /guides/ai-editing

### Key Features

- Deployment Automation: /guides/automation
- Localization & Voiceovers: /guides/localization

## AI Integration

### Markdown Access

All documentation pages are available as raw markdown by appending `.md`:
- HTML: /guides/editing/
- Markdown: /guides/editing.md

### MCP Server

ScreenCI provides a Model Context Protocol server for AI assistant integration:
- Package: @screenci/mcp-server
- Features: Project access, video management, workflow automation
- Installation: npm install -g @screenci/mcp-server

## Common Use Cases

### Product Demos

Create automated product demos that update when features change:
- Record user flow once
- Script regenerates video with latest UI
- Narration updates automatically

### Onboarding Videos

Maintain up-to-date onboarding content:
- Tutorial videos stay current with product
- No manual re-recording needed
- Multi-language support built-in

### Feature Announcements

Generate videos for new feature launches:
- Script the feature workflow
- Add marketing narration
- Deploy to multiple channels

### Documentation Videos

Embed always-current videos in documentation:
- Videos update with product changes
- Maintain consistency across docs
- Version alongside code

## Technical Details

### Video Generation

- Browser automation via Playwright
- AI narration with voice cloning
- Automatic timing synchronization
- Multiple export formats

### Integration

- API for programmatic access
- Webhook notifications
- CI/CD pipeline integration
- Git-based workflow

### Localization

- Multi-language narration
- Regional UI variants
- Voice customization
- Translation workflow

## Getting Help

- Documentation: https://docs.screenci.com
- GitHub: https://github.com/screenci
- Support: support@screenci.com

---

This file follows the llms.txt specification for AI-readable documentation.
Learn more at: https://llmstxt.org/
Last updated: 2024-12-22