Skip to content

User Guide

Welcome to the Loups user guide! This section covers everything you need to know to use Loups effectively.

Installation

Get Loups installed on your system with Python 3.13+

Quick Start

Start scanning videos and generating chapters in minutes

CLI Reference

Complete command-line interface documentation

Custom Templates

Create templates for any video content

⚡ Quick Example

# Install
pip install loups

# Scan a video
loups game_video.mp4

# Save chapters to file
loups -o chapters.txt video.mp4

# Use custom template
loups -t my_template.png video.mp4

💡 Common Workflows

🎥 Creating YouTube Chapters

  1. Install Loups
  2. Create or use existing template
  3. Scan your video: loups -o chapters.txt video.mp4
  4. Copy chapters.txt content to YouTube description

🖼 Extracting Thumbnails

  1. Use thumbnail subcommand: loups video.mp4 thumbnail
  2. Or extract during scanning: loups --extract-thumbnail video.mp4
  3. Upload thumbnail to YouTube

⚙ Batch Processing

Use quiet mode for automation:

for video in *.mp4; do
  loups -q -o "${video%.mp4}_chapters.txt" "$video"
done

❓ Need Help?