summarize README

The project's README from github.com/steipete/summarize. As one markdown file: README.md.

Summarize 📝 — Link in, signal out.

CI npm Node License

Summarize extracts clean text and produces summaries from web pages, files, YouTube videos, podcasts, and other audio or video. Use it from the Node.js CLI or from the Chrome Side Panel and Firefox Sidebar.

Summarize extension screenshot

$ summarize "https://example.com" --extract --plain
This domain is for use in documentation examples without needing permission. Avoid use in operations.
[Learn more](https://iana.org/domains/example)

Install

Run it once without installing:

npx -y @steipete/summarize --version

Or install the CLI with npm or Homebrew:

npm install --global @steipete/summarize

brew install summarize

The npm package requires Node.js 24 or newer. Homebrew/core and the macOS archives on GitHub Releases provide standalone builds. See the installation guide for optional media tools and platform notes.

Quick start

Extract readable content without an API key:

summarize "https://example.com" --extract --plain

For a model-generated summary, configure a supported provider or use an authenticated coding CLI:

summarize "https://example.com" --cli codex

The default auto model chooses among configured providers. The five-minute quickstart covers API keys, local models, files, YouTube, podcasts, and JSON output.

What it handles

Input Processing path
Web pages Readability extraction, with optional Markdown and Firecrawl fallbacks
PDFs, images, and text files File-aware extraction and model attachments where supported
YouTube and podcasts Published transcripts first, then configured transcription fallbacks
Audio and video Local or cloud transcription, with optional speaker labels
Video slides Scene-based frames, optional OCR, and timestamped output

Use --extract when you only need clean content, --json for a stable automation envelope, and --slides for video frames. The command reference documents every flag.

Summarize CLI screenshot

Browser extension

Install Summarize Side Panel from the Chrome Web Store to summarize the active tab, chat with its content, and work with video transcripts and slides.

Direct mode runs without a companion service. Browser media uses Chrome capabilities for local transcription and slide extraction; the optional daemon adds CLI model backends, native media tools, OCR, shared caches, and Firefox media support.

To pair the installed CLI, copy the token shown by the extension and run:

summarize daemon install --token <TOKEN>

See the extension setup and architecture and troubleshooting guide.

Media and slides

Summarize prefers existing captions and podcast transcripts before it transcribes media. Native ffmpeg, yt-dlp, and tesseract extend codec, YouTube slide, and OCR support; a bundled WebAssembly FFmpeg path covers common media without a native install.

YouTube slide screenshots

The focused guides describe YouTube extraction, media routing, slides, and local ONNX transcription.

Models and configuration

Model IDs use provider/model names. Summarize works with configured API providers, OpenAI-compatible endpoints, Ollama, OpenRouter free models, and authenticated coding CLIs such as Codex, Claude, Gemini, OpenClaw, and GitHub Copilot.

Configuration lives at ~/.summarize/config.json; command-line flags take precedence. Inspect the effective setup without exposing keys:

summarize status

Read the model guide, automatic selection rules, CLI provider guide, and configuration reference for the full setup.

Library

For programmatic extraction without the CLI dependency surface, install @steipete/summarize-core:

npm install @steipete/summarize-core

The package exports focused content and prompt entry points. See the core package README for usage.

Documentation

Start with the documentation index, then follow the guide for your task:

Development

Requires Node.js 24 and pnpm 11.25.0.

pnpm install --frozen-lockfile
pnpm build
pnpm check

See CONTRIBUTING.md for repository layout and extension workflows.

License

MIT. See LICENSE.

summarize (steipete/summarize)

Searching Database…

6.7K ·GitHub
Summarize
Что это такое?Summarize — это утилита командной строки и расширение для браузера, которые извлекают чистый текст и создают краткое изложение веб-страниц, файлов, видео на YouTube, подкастов и другого аудио или видео.
Это утилита командной строки (CLI), расширение для браузера или и то, и другое?И то, и другое: CLI на Node.js и расширение для боковой панели Chrome, также поддерживается боковая панель Firefox.
Как установить и начать пользоваться?Запустите один раз без установки через npx или установите CLI через npm или Homebrew; отдельные архивы для macOS также доступны в разделе GitHub Releases.
Что мне нужно перед запуском?Для пакета npm нужен Node.js версии 24 или новее; для простого извлечения содержимого ключ API не нужен, но для краткого изложения на основе модели требуется настроенный провайдер (ключ API, Ollama, OpenRouter или утилита командной строки для программирования с выполненной авторизацией, например Codex, Claude или Gemini).
Нужны ли дополнительные инструменты для работы с медиа, чтобы всё работало полностью?Встроенный путь на основе WebAssembly FFmpeg обрабатывает распространённые медиафайлы без установки чего-либо, но нативные ffmpeg, yt-dlp и tesseract расширяют поддержку кодеков, слайдов YouTube и OCR.
Работает ли расширение вне Chrome?Расширение из Chrome Web Store выполняет локальную транскрибацию и обработку слайдов прямо в браузере; необязательный вспомогательный демон добавляет модели для CLI, нативные медиаинструменты, OCR, общие кэши и поддержку медиа в Firefox.
Где хранятся мои настройки и ключи?Настройки, включая параметры провайдера, хранятся локально в файле ~/.summarize/config.json; флаги командной строки имеют приоритет.
Как программа выбирает, какую расшифровку или субтитры использовать для YouTube и подкастов?Сначала она использует уже опубликованные расшифровки и субтитры подкастов, а настроенную транскрибацию применяет, только если их нет.
Можно ли использовать это в своём коде вместо CLI?Да, пакет @steipete/summarize-core открывает логику извлечения содержимого и промптов для программного использования без зависимостей от CLI.
Может ли оно делать краткое изложение слайдов видео, а не только расшифровок?Да, флаг --slides создаёт кадры видео по сценам с необязательным OCR и выводом с временными метками.
Как связать расширение для браузера с CLI?Скопируйте токен сопряжения, который показывает расширение, и выполните соответствующую команду CLI, чтобы подключить установленный CLI к вспомогательному демону.
What are similar projects?open-codesign, opencodex, repomix, qiaomu-clipper, autoclip, karakeep, aichat, chubbyskills
Which topics is it in?podcast, transcription, firefox-extension, openrouter, github-copilot, youtube, chrome-extension, ocr, openai-compatible, ollama, pdf, gemini
Creator
steipete
Size
56.9 MB
Stars
6.7K
Updated
CommitOct 19Releasev0.25.2Oct 11
Age
10mo
Commits · 90 Days