Skip to content

Latest commit

 

History

History
139 lines (104 loc) · 4.12 KB

File metadata and controls

139 lines (104 loc) · 4.12 KB

Auto Clipper Documentation 📚

Welcome to the comprehensive documentation for Auto Clipper - an intelligent video clipper powered by Gemini AI.

📖 Table of Contents

🎯 Quick Navigation

For Users

For Developers

🚀 What is Auto Clipper?

Auto Clipper is a powerful Rust-based tool that automatically creates viral-worthy video clips from YouTube videos using AI analysis. It combines:

  • Gemini AI for intelligent content analysis
  • FFmpeg for high-performance video processing
  • yt-dlp for seamless YouTube integration
  • Rust for maximum performance and reliability

✨ Key Features

🤖 AI-Powered Analysis

  • Automatically identifies viral-worthy moments
  • Suggests optimal clip durations (10-30 seconds)
  • Analyzes content for social media engagement

📺 YouTube Integration

  • Direct URL processing
  • Automatic video download
  • Quality optimization

⚡ High Performance

  • Built with Rust for speed
  • Stream copying for fast processing
  • Parallel clip generation

🎯 Smart Configuration

  • JSON-based configuration
  • Environment variable support
  • Flexible timestamp formats

🎬 How It Works

graph LR
    A[YouTube URL] --> B[Download Video]
    B --> C[AI Analysis]
    C --> D[Generate Clips]
    D --> E[Viral Content]
Loading
  1. Input: Provide YouTube URL or manual configuration
  2. Analysis: Gemini AI analyzes video content
  3. Processing: FFmpeg creates optimized clips
  4. Output: Ready-to-share viral clips

🛠️ System Requirements

Minimum Requirements

  • OS: Linux, macOS, or Windows
  • Rust: 1.75.0 or higher
  • Memory: 2GB RAM
  • Storage: 1GB free space

Recommended Requirements

  • OS: Ubuntu 20.04+ or equivalent
  • Rust: Latest stable version
  • Memory: 4GB RAM
  • Storage: 5GB free space
  • Network: Stable internet connection

🔧 Dependencies

Core Dependencies

  • FFmpeg: Video processing engine
  • yt-dlp: YouTube download utility
  • curl: HTTP client for API calls

Rust Dependencies

  • serde: JSON serialization
  • tokio: Async runtime
  • dotenv: Environment variables

📊 Performance Metrics

Operation Typical Time Notes
Video Download 10-30s Depends on video size
AI Analysis 3-5s Gemini API response
Clip Generation 1-3s per clip Stream copy mode
Total Process 20-60s For 3-5 minute video

🌟 Use Cases

Content Creators

  • Extract highlights from long-form content
  • Create social media teasers
  • Generate promotional clips

Marketers

  • Create engaging video ads
  • Extract key moments from presentations
  • Generate social media content

Educators

  • Create lesson highlights
  • Extract key concepts
  • Generate study materials

🔗 External Resources

🆘 Getting Help


Next Steps: Start with the Installation Guide to get Auto Clipper running on your system.