For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get Started
  • Overview
    • Welcome
    • How It Works
  • Getting Started
    • Installation
    • Configuration
  • Usage
    • CLI Reference
    • Summary Styles
    • Batch Processing
    • Config Management
    • Retry Behavior
    • Errors and Troubleshooting
  • Features
    • Visual Mode
    • Transcription
    • Webapp
    • Caching
  • Integrations
    • Share a Summary
    • Cobalt
    • Proxy
    • Agent Skill
Get Started
On this page
  • Download Pipeline
  • Key Files
  • Notes
Overview

How It Works

Was this page helpful?
Edit this page
Previous

Installation

Next
Built with

Download Pipeline

The app uses a fallback downloader chain:

  1. YouTube (pytubefix) — captions first, then audio download
  2. yt-dlp — Instagram, TikTok, Twitter/X, Reddit, Facebook
  3. Cobalt — fallback for other HTTP video URLs

If a downloader does not support a URL or fails, the next one is tried automatically.

Key Files

FilePurpose
summarizer.yamlProvider settings and defaults. Generate with python -m summarizer --init-config.
.envAPI keys matched by URL keyword or conventional env var names
summarizer/prompts.jsonSummary style templates

Notes

Tip: If YouTube captions are unavailable, the tool automatically falls back to audio download + Whisper transcription.

Tip: Transcripts are cached in memory by default. Re-summarizing the same source with a different style or provider skips transcription entirely. Disable with cache-transcript: false in summarizer.yaml.

  • Cloud Whisper uses Groq Cloud API and requires a Groq API key.
  • The Docker image does not include Local Whisper and is aimed at lightweight VPS deployment.