Summarize

https://github.com/steipete/summarize
Admin
Summarize is a fast command-line interface (CLI) tool designed to generate summaries from various...
Tokens:55,409
Snippets:796
Trust Score:10
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install and Run Summarize CLI

Source: https://github.com/steipete/summarize/blob/main/docs/index.html

Install the Summarize CLI globally using npm and run it with a URL. This is the basic setup for using the command-line interface.

```bash
npm i -g @steipete/summarize
summarize "https://example.com/article"
```

--------------------------------

### Install Summarize Daemon (with Token)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Install the Summarize daemon using the provided token. This command is typically pasted from the browser extension's setup screen.

```bash
summarize daemon install --token <TOKEN>
```

--------------------------------

### Daemon Management: Install and Manage

Source: https://context7.com/steipete/summarize/llms.txt

Install, configure, and manage the local Summarize daemon. Use a token for installation and specify development mode if needed.

```bash
# Install daemon with token (macOS: LaunchAgent, Linux: systemd, Windows: Scheduled Task)
summarize daemon install --token <TOKEN>
```

```bash
# Install in development mode
summarize daemon install --token <TOKEN> --dev
```

```bash
# Check status
summarize daemon status
```

```bash
# Restart daemon
summarize daemon restart
```

```bash
# Uninstall daemon
summarize daemon uninstall
```

```bash
# Run in foreground (used by autostart service)
summarize daemon run
```

--------------------------------

### Example JSON Configuration

Source: https://github.com/steipete/summarize/blob/main/README.md

This is a full example of a configuration file, showing various settings like model, environment variables, output length, and UI theme.

```json
{
  "model": { "id": "openai/gpt-5-mini" },
  "env": { "OPENAI_API_KEY": "sk-..." },
  "output": { "length": "long" },
  "ui": { "theme": "ember" }
}
```

--------------------------------

### Install Summarize CLI with npx

Source: https://github.com/steipete/summarize/blob/main/README.md

Use npx for a quick execution without global installation. Requires Node 22+.

```bash
npx -y @steipete/summarize "https://example.com"
```

--------------------------------

### Install Summarize Daemon

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

CLI command to install the Summarize daemon as a platform autostart service. Writes configuration to ~/.summarize/daemon.json and verifies the /health endpoint.

```bash
summarize daemon install --token <token> [--port 8787]
  Writes ~/.summarize/daemon.json
  Installs platform autostart service; verifies /health
```

--------------------------------

### Install Dependencies and Check Code

Source: https://github.com/steipete/summarize/blob/main/README.md

Installs project dependencies using pnpm and runs code checks. This is part of the development setup for the project.

```bash
pnpm install
```

```bash
pnpm check
```

--------------------------------

### Install Summarize Daemon (Homebrew)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Install the Summarize local daemon using Homebrew for macOS and Linux.

```bash
brew install summarize
```

--------------------------------

### Configure Docker Compose for Summarize Daemon

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

Example docker-compose.yml configuration to publish the Summarize daemon port and set the command to automatically install the daemon on container startup.

```yaml
ports:
  ['8787:8787']
command: ['cmd', '/c', 'summarize daemon install --token <TOKEN>']
```

--------------------------------

### Example JSON Configuration for Summarize

Source: https://github.com/steipete/summarize/blob/main/docs/config.md

This is a comprehensive example of a summarize configuration file. It demonstrates how to set the model, environment variables, output language and length, custom prompt, and UI theme.

```json
{
  "model": { "id": "google/gemini-3-flash" },
  "env": { "OPENAI_API_KEY": "sk-..." },
  "output": { "language": "auto", "length": "long" },
  "prompt": "Explain like I am five.",
  "ui": { "theme": "ember" }
}
```

--------------------------------

### Install Summarize CLI

Source: https://github.com/steipete/summarize/blob/main/docs/site/docs/chrome-extension.html

Install the Summarize command-line interface globally using npm or Homebrew.

```bash
npm i -g @steipete/summarize
```

```bash
brew install summarize
```

--------------------------------

### Install Summarize Daemon (Development)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Install the Summarize daemon for development purposes using pnpm and a token. This is for developers working with a local checkout of the repository.

```bash
pnpm summarize daemon install --token <TOKEN> --dev
```

--------------------------------

### Summarize Configuration File Example

Source: https://context7.com/steipete/summarize/llms.txt

An example JSON configuration file for the Summarize tool, showing settings for models, environment variables, output preferences, prompts, UI themes, caching, and CLI options.

```json
{
  "model": {
    "id": "openai/gpt-5-mini"
  },
  "env": {
    "OPENAI_API_KEY": "sk-வுகளை",
    "ANTHROPIC_API_KEY": "sk-ant-",
    "GROQ_API_KEY": "gsk-",
    "ASSEMBLYAI_API_KEY": "...",
    "OPENROUTER_API_KEY": "sk-or-"
  },
  "output": {
    "length": "long",
    "language": "auto"
  },
  "prompt": "Summarize concisely with bullet points.",
  "ui": {
    "theme": "aurora"
  },
  "cache": {
    "enabled": true,
    "maxMb": 512,
    "ttlDays": 30,
    "media": {
      "enabled": true,
      "maxMb": 2048,
      "ttlDays": 7
    }
  },
  "slides": {
    "enabled": false,
    "ocr": false,
    "max": 20,
    "sceneThreshold": 0.3
  },
  "cli": {
    "enabled": ["claude", "gemini", "codex"],
    "autoFallback": {
      "enabled": true,
      "onlyWhenNoApiKeys": true,
      "order": ["claude", "gemini", "codex", "agent", "openclaw", "opencode"]
    }
  },
  "openai": {
    "serviceTier": "fast",
    "thinking": "medium"
  }
}
```

--------------------------------

### Install Summarize Daemon (npm)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Install the Summarize local daemon globally using npm. Requires Node.js 22+.

```bash
npm i -g @steipete/summarize
```

--------------------------------

### Summarize CLI Model Selection Examples

Source: https://github.com/steipete/summarize/blob/main/README.md

Examples of specifying models using the `--model` flag. Supports provider/model format, automatic selection, and built-in presets.

```bash
--model <provider/model>
```

```bash
--model auto
```

```bash
--model <name>
```

--------------------------------

### Verifying Homebrew Installation

Source: https://github.com/steipete/summarize/blob/main/RELEASING.md

Uninstalls, taps, and installs the summarize package via Homebrew, then verifies the installed version. This is a crucial step to ensure the Homebrew tap is correctly updated.

```bash
brew uninstall summarize || true
brew tap steipete/tap || true
brew install steipete/tap/summarize
summarize --version
```

--------------------------------

### Install Summarize Core Library with npm

Source: https://github.com/steipete/summarize/blob/main/README.md

Install the core library for use as a dependency in your Node.js projects. This option has minimal dependencies.

```bash
npm i @steipete/summarize-core
```

```typescript
import { createLinkPreviewClient } from "@steipete/summarize-core/content";
```

--------------------------------

### Install Optional Local Dependencies

Source: https://github.com/steipete/summarize/blob/main/README.md

Install optional tools like ffmpeg and yt-dlp for enhanced media processing capabilities, such as slide extraction and local media flows. Tesseract is optional for OCR.

```bash
brew install ffmpeg yt-dlp
```

```bash
brew install tesseract # optional, for --slides-ocr
```

--------------------------------

### Build Firefox Extension (Development)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Run this command from the repo root to start a development server for the Firefox extension.

```bash
pnpm -C apps/chrome-extension dev:firefox
```

--------------------------------

### Check Summarize Version

Source: https://github.com/steipete/summarize/blob/main/docs/releasing.md

Verify that the installed summarize version matches the latest tag after installation.

```shell
summarize --version
```

--------------------------------

### Install Playwright Browsers

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

Install the necessary browsers for Playwright to run end-to-end tests. This is typically needed on the first run.

```bash
pnpm -C apps/chrome-extension exec playwright install chromium
```

--------------------------------

### Build Chrome Extension (Development)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Run this command from the repo root to start a development server for the Chrome extension.

```bash
pnpm -C apps/chrome-extension dev
```

--------------------------------

### Full CLI Configuration Example

Source: https://github.com/steipete/summarize/blob/main/docs/cli.md

A comprehensive configuration for CLI model providers, including enabling specific providers, setting default models, configuring fallback behavior, and specifying binary paths and extra arguments for each CLI.

```json
{
  "cli": {
    "enabled": ["claude", "gemini", "codex", "agent", "openclaw", "opencode"],
    "autoFallback": {
      "enabled": true,
      "onlyWhenNoApiKeys": true,
      "order": ["claude", "gemini", "codex", "agent", "openclaw", "opencode"]
    },
    "codex": { "model": "gpt-5.2" },
    "gemini": { "model": "flash", "extraArgs": ["--verbose"] },
    "claude": {
      "model": "sonnet",
      "binary": "/usr/local/bin/claude",
      "extraArgs": ["--verbose"]
    },
    "agent": {
      "model": "auto",
      "binary": "/usr/local/bin/agent"
    },
    "openclaw": {
      "model": "main",
      "binary": "/usr/local/bin/openclaw"
    },
    "opencode": {
      "binary": "/usr/local/bin/opencode"
    }
  }
}
```

--------------------------------

### Basic CLI Usage

Source: https://github.com/steipete/summarize/blob/main/README.md

Run the Summarize CLI with a URL to get a summary. This is the most straightforward way to use the tool.

```bash
summarize "https://example.com"
```

--------------------------------

### Environment Variables for API Keys

Source: https://context7.com/steipete/summarize/llms.txt

Example of setting API keys and configuration parameters using environment variables for various services.

```bash
# Example: Setting environment variables
# export OPENAI_API_KEY="sk-..."
# export ANTHROPIC_API_KEY="sk-ant-..."
# export GROQ_API_KEY="gsk-..."
# export ASSEMBLYAI_API_KEY="..."
# export OPENROUTER_API_KEY="sk-or-"
```

--------------------------------

### Test Release Feature

Source: https://github.com/steipete/summarize/blob/main/docs/releasing.md

Run a feature introduced in the new release, such as 'summarize daemon install', to ensure it functions correctly.

```shell
summarize daemon install
```

--------------------------------

### Summarize CLI Usage

Source: https://context7.com/steipete/summarize/llms.txt

Examples of using the summarize CLI with different model providers, presets, and backends.

```APIDOC
## Summarize CLI Usage

### OpenRouter Models
```bash
# Force via prefix
summarize "https://example.com" --model openrouter/meta-llama/llama-3.3-70b-instruct:free

# Free preset (OpenRouter :free models)
summarize "https://example.com" --model free

# Auto selection (default)
summarize "https://example.com" --model auto

# OpenAI fast mode with thinking
summarize "https://example.com" --model openai/gpt-5.5 --fast --thinking medium
summarize "https://example.com" --model openai/gpt-5.4 --service-tier fast --thinking low
```

### Coding CLI Backends
```bash
# Auto-detect available CLI
summarize "https://example.com" --cli

# Specific CLI provider
summarize "https://example.com" --cli codex
summarize "https://example.com" --cli claude
summarize "https://example.com" --cli gemini
summarize "https://example.com" --cli agent      # Cursor Agent
summarize "https://example.com" --cli openclaw
summarize "https://example.com" --cli openencode

# With specific model
summarize "https://example.com" --model cli/codex/gpt-5.2
summarize "https://example.com" --model cli/claude/sonnet
summarize "https://example.com" --model cli/gemini/flash

# Codex fast preset
summarize "https://example.com" --model codex-fast

# Smoke test all providers
printf "Test input.\n" > /tmp/test.txt
summarize --cli codex --plain --timeout 2m /tmp/test.txt
summarize --cli claude --plain --timeout 2m /tmp/test.txt
summarize --cli gemini --plain --timeout 2m /tmp/test.txt
```
```

--------------------------------

### Install Signed Firefox Extension XPI

Source: https://github.com/steipete/summarize/blob/main/RELEASING.md

Provides multiple methods for installing the signed Firefox extension XPI file into the browser. This is typically done after signing the extension via AMO for self-distribution.

```bash
# Method 1: Drag & drop XPI into Firefox
# Method 2: File → Open File (Cmd+O) → select XPI
# Method 3: Open in Firefox: file:///path/to/summarize-<ver>.xpi
```

--------------------------------

### Basic URL Summarization with Summarize CLI

Source: https://context7.com/steipete/summarize/llms.txt

Summarize any URL with automatic model selection and streaming markdown output. Use the `--model` flag for specific providers and `--length` for output size. Install via npm or use npx.

```bash
summarize "https://example.com"
```

```bash
summarize "https://example.com" --model openai/gpt-5-mini
```

```bash
summarize "https://example.com" --length long
```

```bash
summarize "https://example.com" --language de
```

```bash
npx -y @steipete/summarize "https://example.com"
```

--------------------------------

### Firefox CI Configuration (Disabled)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/tests/README-firefox.md

Example GitHub Actions workflow for Firefox E2E tests, currently disabled due to Playwright limitations. It includes steps for installing Playwright for Firefox.

```yaml
extension-e2e-firefox:
  runs-on: ubuntu-latest
  steps:
    - Install Playwright (Firefox)
    - Run: playwright test --project=firefox
    # Expected to fail until Playwright improves Firefox support
```

--------------------------------

### Ask User Which Element Parameters

Source: https://github.com/steipete/summarize/blob/main/docs/agent.md

Optional message to guide the user when selecting an element.

```json
{ "message": "Optional guidance" }
```

--------------------------------

### Setting UI Theme via Environment Variable

Source: https://github.com/steipete/summarize/blob/main/README.md

Example of setting the UI theme using an environment variable. This allows overriding the theme defined in the configuration file.

```bash
export SUMMARIZE_THEME=aurora
```

--------------------------------

### Daemon Management API

Source: https://context7.com/steipete/summarize/llms.txt

Commands for installing, managing, and running the local daemon for browser extension integration.

```APIDOC
## Daemon API

### Daemon Management

Install and manage the local daemon for browser extension integration.

```bash
# Install daemon with token (macOS: LaunchAgent, Linux: systemd, Windows: Scheduled Task)
summarize daemon install --token <TOKEN>

# Install in development mode
summarize daemon install --token <TOKEN> --dev

# Check status
summarize daemon status

# Restart daemon
summarize daemon restart

# Uninstall daemon
summarize daemon uninstall

# Run in foreground (used by autostart service)
summarize daemon run
```
```

--------------------------------

### Ask User Which Element Result

Source: https://github.com/steipete/summarize/blob/main/docs/agent.md

Example result from `ask_user_which_element`, providing metadata about the selected element.

```json
{ "selector": "#submit", "xpath": "//button[1]", "text": "Send", "tagName": "button", "attributes": { "type": "submit" }, "html": "<button ...>", "boundingBox": { "x": 20, "y": 120, "width": 180, "height": 40 } }
```

--------------------------------

### Run Firefox Extension with web-ext

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/tests/README-firefox.md

Install and use `web-ext` to run Firefox extensions. This is an alternative to Playwright for testing, especially when Playwright's limitations are a blocker.

```bash
pnpm add -D web-ext
web-ext run --source-dir=.output/firefox-mv3
```

--------------------------------

### Setting OpenAI API Key via Environment Variable

Source: https://github.com/steipete/summarize/blob/main/README.md

Example of how to set the OpenAI API key using an environment variable. This is a common method for providing credentials.

```bash
export OPENAI_API_KEY=sk-...
```

--------------------------------

### Summarize CLI Preprocessing Control

Source: https://github.com/steipete/summarize/blob/main/README.md

Control the usage of `uvx markitdown` for preprocessing content. Requires `uvx` to be installed.

```bash
--preprocess off|auto|always
```

--------------------------------

### Summarize with NVIDIA API

Source: https://github.com/steipete/summarize/blob/main/README.md

Summarizes a URL using a model from the NVIDIA API Catalog. Set your `NVIDIA_API_KEY` and optionally `NVIDIA_BASE_URL`. The example uses a fast model.

```bash
export NVIDIA_API_KEY="nvapi-..."
summarize "https://example.com" --model nvidia/stepfun-ai/step-3.5-flash
```

--------------------------------

### Chrome Manifest Example

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/docs/firefox.md

This is the current manifest configuration for Chrome, which includes 'sidePanel' permissions and configuration.

```json
{
  "permissions": ["sidePanel", ...],
  "side_panel": {
    "default_path": "sidepanel/index.html"
  }
}
```

--------------------------------

### Chromium CI Configuration

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/tests/README-firefox.md

Example GitHub Actions workflow for running Chromium E2E tests. This configuration is stable and works with Playwright.

```yaml
extension-e2e:
  runs-on: ubuntu-latest
  steps:
    - Install Playwright (Chromium)
    - Run: playwright test --project=chromium
```

--------------------------------

### Control Output Length with --length

Source: https://github.com/steipete/summarize/blob/main/README.md

Use the `--length` flag to guide the desired output summary length. Presets like 'short', 'medium', 'long', 'xl', 'xxl' are available, as well as character targets like '20k'.

```bash
summarize "https://example.com" --length long
```

```bash
summarize "https://example.com" --length 20k
```

--------------------------------

### Model Selection in Summarize CLI

Source: https://context7.com/steipete/summarize/llms.txt

Select specific LLM providers using gateway-style model IDs. The tool supports automatic fallback chains for robustness. Examples include OpenAI, Anthropic, Google, and xAI.

```bash
summarize "https://example.com" --model openai/gpt-5-mini
```

```bash
summarize "https://example.com" --model anthropic/claude-sonnet-4-5
```

```bash
summarize "https://example.com" --model google/gemini-3-flash
```

```bash
summarize "https://example.com" --model xai/grok-4-fast-non-reasoning
```

--------------------------------

### Summarize with Specific OpenRouter Model

Source: https://github.com/steipete/summarize/blob/main/README.md

Summarizes a URL using a specific model from OpenRouter. Ensure your `OPENROUTER_API_KEY` is set. The example shows a free model, but any valid OpenRouter model can be used.

```bash
OPENROUTER_API_KEY=sk-or-... summarize "https://example.com" --model openrouter/meta-llama/llama-3.1-8b-instruct:free
```

```bash
OPENROUTER_API_KEY=sk-or-... summarize "https://example.com" --model openrouter/minimax/minimax-m2.5
```

--------------------------------

### Debug Windows Daemon Launcher

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

If the Summarize daemon installation completes but the health endpoint is unreachable, use this command to run the daemon launcher script directly. This can surface errors from the VBScript launcher.

```batch
cscript //nologo %USERPROFILE%\.summarize\daemon-launch.vbs
```

--------------------------------

### Configure Chrome Site Access for Extension

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

Guides users to grant the Summarize extension 'Site access' on 'All sites' within Chrome's extension settings. This is necessary if the content script is not injected or if Chrome blocks site access, leading to connection errors.

```bash
curl http://127.0.0.1:8787/health
```

--------------------------------

### Get Chat History API Request

Source: https://context7.com/steipete/summarize/llms.txt

Example of how to make a POST request to the /v1/agent/history endpoint to retrieve chat history. Requires authentication and a JSON payload with URL and page content.

```bash
curl -X POST http://127.0.0.1:8787/v1/agent/history \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "pageContent": "Page content for cache key..."
  }'
```

--------------------------------

### Initialize Link Preview Client

Source: https://context7.com/steipete/summarize/llms.txt

Demonstrates how to create an instance of the Link Preview Client from the @steipete/summarize-core/content library. Requires various API keys and configuration options.

```typescript
import { createLinkPreviewClient } from "@steipete/summarize-core/content";

// Create client with dependencies
const client = createLinkPreviewClient({
  fetch: globalThis.fetch,
  env: process.env,
  groqApiKey: process.env.GROQ_API_KEY,
  assemblyaiApiKey: process.env.ASSEMBLYAI_API_KEY,
  geminiApiKey: process.env.GEMINI_API_KEY,
  openaiApiKey: process.env.OPENAI_API_KEY,
  falApiKey: process.env.FAL_KEY,
  apifyApiToken: process.env.APIFY_API_TOKEN,
  ytDlpPath: "/usr/local/bin/yt-dlp",
  onProgress: (event) => {
    console.log(`[${event.kind}] ${event.message}`);
  },
});
```

--------------------------------

### Build Firefox Extension (Production)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Run this command from the repo root to create a production build for the Firefox extension.

```bash
pnpm -C apps/chrome-extension build:firefox
```

--------------------------------

### Summarize CLI: Model Selection

Source: https://context7.com/steipete/summarize/llms.txt

Specify models using prefixes like 'openrouter/' or presets like 'free'. 'auto' selects the best available model.

```bash
summarize "https://example.com" --model openrouter/meta-llama/llama-3.3-70b-instruct:free
```

```bash
summarize "https://example.com" --model free
```

```bash
summarize "https://example.com" --model auto
```

```bash
summarize "https://example.com" --model openai/gpt-5.5 --fast --thinking medium
```

```bash
summarize "https://example.com" --model openai/gpt-5.4 --service-tier fast --thinking low
```

--------------------------------

### Get Summary Slides Events

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

Streams slide updates for a given summarization ID.

```APIDOC
## GET /v1/summarize/<id>/slides/events

### Description
Streams slide updates for a given summarization ID. This is a Server-Sent Events (SSE) stream.

### Method
GET

### Endpoint
/v1/summarize/<id>/slides/events

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the summarization job.

### Response
#### SSE Events
- **event: slides** - Data related to slide updates.
- **event: status** - Status messages regarding the slide generation.
- **event: done** - Indicates that all slide updates are complete.
- **event: error** - Contains error information if an error occurred.
```

--------------------------------

### Run Summarize Daemon (Foreground)

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

CLI command to run the Summarize daemon in the foreground. Typically used by the autostart service.

```bash
summarize daemon run (foreground; used by autostart service)
```

--------------------------------

### Build Chrome Extension (Production)

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Run this command from the repo root to create a production build for the Chrome extension.

```bash
pnpm -C apps/chrome-extension build
```

--------------------------------

### Run Release Script

Source: https://github.com/steipete/summarize/blob/main/docs/releasing.md

Execute the main release script which automates build, verification, publishing, and tagging.

```shell
scripts/release.sh all
```

--------------------------------

### Get Summarization Events

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

Streams events related to a summarization job, including progress, metadata, and results.

```APIDOC
## GET /v1/summarize/:id/events

### Description
Streams events related to a summarization job using Server-Sent Events (SSE). This includes progress updates, metadata, and final results.

### Method
GET

### Endpoint
/v1/summarize/:id/events

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the summarization job.

### Response
#### SSE Events
- **event: chunk** `data: { text }` - A chunk of the generated summary text.
- **event: meta** `data: { model }` - Metadata about the summarization, such as the model used.
- **event: status** `data: { text }` - Progress messages displayed before the summary output begins.
- **event: metrics** `data: { elapsedMs, summary, details, summaryDetailed, detailsDetailed }` - Performance metrics for the summarization job.
- **event: done** `data: {}` - Indicates that the summarization job is complete.
- **event: error** `data: { message }` - Contains error information if the summarization failed.
```

--------------------------------

### Build Both Chrome and Firefox Extensions

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/README.md

Run this command from the repo root to create production builds for both Chrome and Firefox extensions.

```bash
pnpm -C apps/chrome-extension build:all
```

--------------------------------

### Summarize Local Files and URLs with Specific Models

Source: https://github.com/steipete/summarize/blob/main/README.md

Provide local file paths or URLs to Summarize. Use the `--model` flag to specify a particular LLM, such as Google's Gemini.

```bash
summarize "/path/to/file.pdf" --model google/gemini-3-flash
```

```bash
summarize "https://example.com/report.pdf" --model google/gemini-3-flash
```

```bash
summarize "/path/to/audio.mp3"
```

```bash
summarize "/path/to/video.mp4"
```

--------------------------------

### UI Theme Configuration

Source: https://github.com/steipete/summarize/blob/main/docs/config.md

Sets a default theme for the command-line interface.

```json
{
  "ui": { "theme": "moss" }
}
```

--------------------------------

### Run End-to-End Tests

Source: https://github.com/steipete/summarize/blob/main/docs/chrome-extension.md

Execute the end-to-end tests for the Chrome extension using Playwright. Ensure Playwright browsers are installed first.

```bash
pnpm -C apps/chrome-extension test:e2e
```

--------------------------------

### OpenAI Configuration in JSON

Source: https://github.com/steipete/summarize/blob/main/docs/openai.md

Shows how to configure OpenAI service tier and thinking parameters within a JSON configuration file. This allows for persistent settings across multiple runs.

```json
{
  "openai": {
    "serviceTier": "fast",
    "thinking": "medium"
  }
}
```

--------------------------------

### Configure Summarization Model and Theme

Source: https://context7.com/steipete/summarize/llms.txt

Set the environment variable for the default summarization model and the UI theme. Options for theme include aurora, ember, moss, and mono.

```bash
export SUMMARIZE_MODEL="openai/gpt-5-mini"
export SUMMARIZE_THEME="aurora"
```

--------------------------------

### Skill Tool

Source: https://github.com/steipete/summarize/blob/main/docs/agent.md

Manages domain-specific libraries (skills) stored in `chrome.storage.local`. Supports listing, getting, creating, updating, and deleting skills.

```APIDOC
## Skill Tool

### Description
Manages domain-specific libraries (skills) stored in `chrome.storage.local`. Supports listing, getting, creating, updating, and deleting skills.

### Method
N/A (Tool Function)

### Endpoint
N/A (Tool Function)

### Parameters
#### Request Body
- **action** (string) - Required - The action to perform: `list`, `get`, `create`, `rewrite`, `update`, `delete`.
- **name** (string) - Required for `get`, `create`, `rewrite`, `update`, `delete` - The name of the skill.
- **code** (string) - Required for `create`, `rewrite` - The code of the skill.
- **url** (string) - Optional - Filter for `list` action.
- **filter** (string) - Optional - Filter for `list` action.

### Request Example
```json
{
  "action": "list",
  "url": "github.com"
}
```

### Response
#### Success Response (200)
- **skills** (array) - List of skills (when action is `list`).
- **skill** (object) - Details of a specific skill (when action is `get`).

#### Response Example
```json
{
  "skills": [
    {
      "name": "example-skill",
      "domainPatterns": ["example.com"]
    }
  ]
}
```

### Notes
- Skills are matched against domain patterns (glob-like).
- `update` is for string replacement; `rewrite` is for renaming or full replacement.
- Skills run inside `browserjs()` and must avoid navigation.
```

--------------------------------

### Define Transcript Segment Type

Source: https://github.com/steipete/summarize/blob/main/docs/timestamps.md

Defines the structure for a segment of a transcript, including start time in milliseconds and optional end time.

```typescript
type TranscriptSegment = { startMs: number; endMs?: number | null; text: string };
```

--------------------------------

### Summarize CLI with Long Output

Source: https://github.com/steipete/summarize/blob/main/docs/index.html

Use the Summarize CLI to get a long-form summary of a given URL. This command specifies the desired output length.

```bash
summarize "https://example.com" --length long
```

--------------------------------

### Summarize with OpenAI Models and Flags

Source: https://github.com/steipete/summarize/blob/main/docs/openai.md

Demonstrates how to use the summarize command with specific OpenAI models and flags for controlling performance and thinking depth. Use `--fast` for the fast service tier and `--thinking` to adjust reasoning effort.

```sh
summarize URL --model openai/gpt-5.5 --fast --thinking medium
```

```sh
summarize URL --model openai/gpt-5.4 --service-tier fast --thinking low
```

--------------------------------

### Load Unpacked Extension

Source: https://github.com/steipete/summarize/blob/main/docs/site/docs/chrome-extension.html

Load the built extension into Chrome by pointing to the output directory.

```bash
apps/chrome-extension/.output/chrome-mv3
```

--------------------------------

### Firefox Manifest Override Example

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/docs/firefox.md

This is the required manifest override for Firefox, utilizing 'sidebar_action' instead of 'side_panel'. Ensure 'tabs', 'activeTab', and 'storage' permissions are included.

```json
{
  "permissions": ["tabs", "activeTab", "storage", ...],
  "sidebar_action": {
    "default_panel": "sidepanel/index.html",
    "default_title": "Summarize"
  }
}
```

--------------------------------

### Summarize CLI Output Formatting and Styling

Source: https://github.com/steipete/summarize/blob/main/README.md

Options to control raw output, disable ANSI colors, and apply different CLI themes for enhanced readability.

```bash
--plain
```

```bash
--no-color
```

```bash
--theme <name>
```

--------------------------------

### Custom Prompt Configuration

Source: https://github.com/steipete/summarize/blob/main/docs/config.md

Sets a custom prompt to be used for generating summaries, overriding the built-in instructions.

```json
{
  "prompt": "Explain for a kid. Short sentences. Simple words."
}
```

--------------------------------

### Summarize CLI: Coding CLI Backends

Source: https://context7.com/steipete/summarize/llms.txt

Utilize local coding CLIs as model backends. Auto-detect or specify providers like 'codex', 'claude', 'gemini', or 'agent'.

```bash
# Auto-detect available CLI
summarize "https://example.com" --cli
```

```bash
# Specific CLI provider
summarize "https://example.com" --cli codex
```

```bash
summarize "https://example.com" --cli claude
```

```bash
summarize "https://example.com" --cli gemini
```

```bash
summarize "https://example.com" --cli agent      # Cursor Agent
```

```bash
summarize "https://example.com" --cli openclaw
```

```bash
summarize "https://example.com" --cli opencode
```

```bash
# With specific model
summarize "https://example.com" --model cli/codex/gpt-5.2
```

```bash
summarize "https://example.com" --model cli/claude/sonnet
```

```bash
summarize "https://example.com" --model cli/gemini/flash
```

```bash
# Codex fast preset
summarize "https://example.com" --model codex-fast
```

```bash
# Smoke test all providers
printf "Test input.\n" > /tmp/test.txt
summarize --cli codex --plain --timeout 2m /tmp/test.txt
```

```bash
summarize --cli claude --plain --timeout 2m /tmp/test.txt
```

```bash
summarize --cli gemini --plain --timeout 2m /tmp/test.txt
```

--------------------------------

### Website Summary Test

Source: https://github.com/steipete/summarize/blob/main/docs/manual-tests.md

Test website summarization with a specified maximum output token count. Ensure a model is auto-selected and displayed.

```bash
summarize --max-output-tokens 200 https://example.com
```

--------------------------------

### Extract Mode and Formatting Options in Summarize CLI

Source: https://context7.com/steipete/summarize/llms.txt

Use the `--extract` flag to get raw content without summarization. Supports markdown formatting and timestamps for media. The `--json` flag provides diagnostic output.

```bash
summarize "https://example.com" --extract
```

```bash
summarize "https://example.com" --extract --format md
```

```bash
summarize "https://youtu.be/..." --extract --timestamps
```

```bash
summarize "https://youtu.be/..." --extract --slides
```

```bash
summarize "https://example.com" --json
```

--------------------------------

### Configure CLI Allowlist and Order

Source: https://github.com/steipete/summarize/blob/main/README.md

This JSON configuration sets an explicit allowlist and order for the coding CLIs that Summarize can use. Only the CLIs listed will be considered, in the specified order.

```json
{
  "cli": { "enabled": ["codex", "claude", "gemini", "agent", "openclaw", "opencode"] }
}
```

--------------------------------

### Configure Canary ONNX CLI Command (JSON Array)

Source: https://github.com/steipete/summarize/blob/main/docs/nvidia-onnx-transcription.md

Use this format to provide the command and arguments for the Canary ONNX transcriber as a JSON array. Placeholders like {model_dir} and {input} will be substituted.

```bash
SUMMARIZE_ONNX_CANARY_CMD='["my-canary-wrapper", "{model_dir}", "{input}"]'
```

--------------------------------

### Building Chrome Extension

Source: https://github.com/steipete/summarize/blob/main/RELEASING.md

Builds the Chrome extension and zips the output for distribution. Ensure the output directory `dist-chrome` exists.

```bash
pnpm -C apps/chrome-extension build
mkdir -p dist-chrome
zip -r dist-chrome/summarize-chrome-extension-v<ver>.zip apps/chrome-extension/.output/chrome-mv3
```

--------------------------------

### Summarize CLI Basic Usage

Source: https://github.com/steipete/summarize/blob/main/README.md

Basic command structure for the Summarize CLI, showing input and optional flags. Use `summarize --help` for a complete list of options.

```bash
summarize <input> [flags]
```

--------------------------------

### YouTube Summary

Source: https://github.com/steipete/summarize/blob/main/docs/manual-tests.md

Summarize a YouTube video. Ensure the `--max-output-tokens` is set appropriately.

```bash
summarize https://www.youtube.com/watch?v=dQw4w9WgXcQ --max-output-tokens 200
```

--------------------------------

### Building Firefox Extension

Source: https://github.com/steipete/summarize/blob/main/RELEASING.md

Builds the Firefox extension, zips the output, and verifies the contents. The command changes directory to handle zipping correctly.

```bash
pnpm -C apps/chrome-extension build:firefox
mkdir -p dist-firefox
cd apps/chrome-extension/.output/firefox-mv3 && zip -r -FS ../../../../dist-firefox/summarize-firefox-extension-v<ver>.zip . && cd - 
Verify: unzip -l dist-firefox/summarize-firefox-extension-v<ver>.zip | head -20
```

--------------------------------

### Preset Model Usage

Source: https://github.com/steipete/summarize/blob/main/docs/manual-tests.md

Use a predefined model preset for summarization. Ensure `OPENROUTER_API_KEY` is set if the preset uses OpenRouter models.

```bash
summarize --model <preset> --max-output-tokens 200 https://example.com
```

--------------------------------

### Using OpenRouter Free Models Preset

Source: https://github.com/steipete/summarize/blob/main/README.md

Command-line argument to use a preset of free models available through OpenRouter. This simplifies selecting a common set of models.

```bash
--model free
```

--------------------------------

### Build and Load Extension for Chrome (Dev)

Source: https://github.com/steipete/summarize/blob/main/README.md

Build the Chrome extension in development mode and load it unpacked into Chrome. This is for developers who want to test the extension locally.

```bash
pnpm -C apps/chrome-extension build
```

```bash
chrome://extensions
     Developer mode → Load unpacked
     Pick: apps/chrome-extension/.output/chrome-mv3
```

--------------------------------

### Build Firefox Extension

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/tests/README-firefox.md

Build the Firefox extension using the provided script. This command is used for manual testing and loading the extension into Firefox.

```bash
cd apps/chrome-extension
BROWSER=firefox pnpm build:firefox
# Load .output/firefox-mv3 in about:debugging
```

--------------------------------

### Configure Parakeet ONNX CLI Command (JSON Array)

Source: https://github.com/steipete/summarize/blob/main/docs/nvidia-onnx-transcription.md

Use this format to provide the command and arguments for the Parakeet ONNX transcriber as a JSON array. Placeholders like {vocab}, {model}, and {input} will be substituted.

```bash
SUMMARIZE_ONNX_PARAKEET_CMD='["sherpa-onnx", "...", "--tokens", "{vocab}", "--offline-ctc-model", "{model}", "--input-wav", "{input}"]'
```

--------------------------------

### File Summarization with Summarize CLI

Source: https://context7.com/steipete/summarize/llms.txt

Process local files like PDFs, images, audio, and video. Automatic format detection is used. Specify models for optimal results, especially for PDFs. Supports piping content via stdin.

```bash
summarize "/path/to/document.pdf" --model google/gemini-3-flash
```

```bash
summarize "/path/to/image.png" --model openai/gpt-5-mini
```

```bash
summarize "/path/to/podcast.mp3"
```

```bash
summarize "/path/to/video.mp4" --slides
```

```bash
echo "Content to summarize" | summarize -
```

```bash
cat /path/to/file.pdf | summarize -
```

```bash
pbpaste | summarize -
```

--------------------------------

### Return File in REPL

Source: https://github.com/steipete/summarize/blob/main/docs/agent.md

How to return files from the REPL tool using `returnFile`.

```javascript
returnFile("name", "content", "mimeType")
returnFile({ fileName: "name", content: "content", mimeType: "mimeType" })
```

--------------------------------

### Fetch Link Content with Link Preview Client

Source: https://context7.com/steipete/summarize/llms.txt

Shows how to use the fetchLinkContent method of the Link Preview Client to extract text, title, and metadata from a given URL. Supports various options like timeout and format.

```typescript
// Fetch link content
const result = await client.fetchLinkContent("https://example.com", {
  timeout: 60000,
  maxCharacters: 50000,
  cacheMode: "prefer-cache",
  format: "text",
  youtubeMode: "auto",
});

console.log(result.content);      // Extracted text
console.log(result.title);        // Page title
console.log(result.wordCount);    // Word count
console.log(result.truncated);    // Whether content was truncated
console.log(result.transcriptSource); // "youtubei" | "captionTracks" | "whisper" | etc.
```

--------------------------------

### Build and Load Extension for Firefox (Dev)

Source: https://github.com/steipete/summarize/blob/main/README.md

Build the Firefox extension in development mode and load it as a temporary add-on in Firefox. This is for developers testing the extension locally.

```bash
pnpm -C apps/chrome-extension build:firefox
```

```bash
about:debugging#/runtime/this-firefox
     Load Temporary Add-on
     Pick: apps/chrome-extension/.output/firefox-mv3/manifest.json
```

--------------------------------

### Shorthand Model Configuration

Source: https://github.com/steipete/summarize/blob/main/docs/config.md

A simplified way to specify the model in the configuration file.

```json
{
  "model": "google/gemini-3-flash"
}
```

--------------------------------

### Run CLI Smoke Test with Multiple Providers

Source: https://github.com/steipete/summarize/blob/main/docs/cli.md

Execute a smoke test using a local text file against multiple CLI providers. Adjust timeout for slower providers like Gemini. Ensure Agent has authentication configured if needed.

```bash
printf "Summarize CLI smoke input.\nOne short paragraph. Reply can be brief.\n" >/tmp/summarize-cli-smoke.txt

summarize --cli codex --plain --timeout 2m /tmp/summarize-cli-smoke.txt
summarize --cli claude --plain --timeout 2m /tmp/summarize-cli-smoke.txt
summarize --cli gemini --plain --timeout 2m /tmp/summarize-cli-smoke.txt
summarize --cli agent --plain --timeout 2m /tmp/summarize-cli-smoke.txt
summarize --cli openclaw --plain --timeout 2m /tmp/summarize-cli-smoke.txt
summarize --cli opencode --plain --timeout 2m /tmp/summarize-cli-smoke.txt
```

--------------------------------

### Build Bun Artifact for Homebrew

Source: https://github.com/steipete/summarize/blob/main/RELEASING.md

Compiles the Bun application into a macOS arm64 binary with bytecode. This command is part of the process to create a distributable artifact for Homebrew.

```bash
pnpm build:bun
```

--------------------------------

### Set Provider API Keys

Source: https://context7.com/steipete/summarize/llms.txt

Set environment variables for API keys for various AI providers like OpenAI, Anthropic, Gemini, and others. Ensure these are set before running the summarization tools.

```bash
export OPENAI_API_KEY="sk-..."
export ANTHROPIC_API_KEY="sk-ant-..."
export GEMINI_API_KEY="..."
export XAI_API_KEY="..."
export Z_AI_API_KEY="..."
export OPENROUTER_API_KEY="sk-or-..."
export NVIDIA_API_KEY="nvapi-..."
```

```bash
export GROQ_API_KEY="gsk-..."
export ASSEMBLYAI_API_KEY="..."
export FAL_KEY="..."
```

```bash
export FIRECRAWL_API_KEY="..."
export APIFY_API_TOKEN="..."
```

--------------------------------

### Navigate Tab Parameters

Source: https://github.com/steipete/summarize/blob/main/docs/agent.md

Use this to navigate the active tab to a specified URL. Set `newTab` to true to open in a new tab.

```json
{ "url": "https://...", "newTab": false }
```

--------------------------------

### Firefox Development Build Commands

Source: https://github.com/steipete/summarize/blob/main/apps/chrome-extension/docs/firefox.md

Commands for building the extension for Firefox. 'pnpm dev:firefox' is for development with watch mode, and 'pnpm build:firefox' is for a production build. The output is located in '.output/firefox-mv3/'.

```bash
# Development mode (watch)
pnpm dev:firefox

# Production build
pnpm build:firefox

# Output location
.output/firefox-mv3/
```

--------------------------------

### Daemon API: Summarize Endpoint

Source: https://context7.com/steipete/summarize/llms.txt

Initiate summarization requests via POST to the /v1/summarize endpoint. Requires authentication and JSON payload. Returns an ID for SSE streaming.

```bash
# Start summarization
curl -X POST http://127.0.0.1:8787/v1/summarize \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "title": "Example Page",
    "model": "auto",
    "length": "long",
    "language": "auto",
    "mode": "auto"
  }'
```

```json
{
  "ok": true,
  "id": "abc123-uuid"
}
```

```bash
# With page content (for "page" mode)
curl -X POST http://127.0.0.1:8787/v1/summarize \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "title": "Example Page",
    "text": "Extracted page content here...",
    "truncated": false,
    "mode": "page",
    "length": "medium"
  }'
```

```bash
# Extract only (no summarization)
curl -X POST http://127.0.0.1:8787/v1/summarize \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "extractOnly": true,
    "mode": "url",
    "format": "markdown"
  }'
```

--------------------------------

### Slides Defaults Configuration

Source: https://github.com/steipete/summarize/blob/main/docs/config.md

Enables slides generation by default and configures parameters like OCR, directory, scene threshold, and maximum/minimum duration.

```json
{
  "slides": {
    "enabled": true,
    "ocr": false,
    "dir": "slides",
    "sceneThreshold": 0.3,
    "max": 20,
    "minDuration": 2
  }
}
```

--------------------------------

### Publishing to npm (Legacy Auth)

Source: https://github.com/steipete/summarize/blob/main/RELEASING.md

Publishes the package to npm using legacy authentication, which is recommended for scripted or automated publishes, especially when an OTP is required.

```bash
npm_config_auth_type=legacy pnpm publish --tag latest --access public --otp <otp>
```

--------------------------------

### OpenAI Fast Mode and Thinking Configuration

Source: https://github.com/steipete/summarize/blob/main/README.md

Configure OpenAI's service tier and reasoning effort using command-line flags or equivalent JSON configuration. The `--fast` flag is a shorthand for `--service-tier fast`, which maps to OpenAI's `service_tier="priority"`. Reasoning effort is controlled by the `--thinking` flag with various levels.

```bash
summarize "https://example.com" --model openai/gpt-5.5 --fast --thinking medium
```

```bash
summarize "https://example.com" --model openai/gpt-5.4 --service-tier fast --thinking low
```

--------------------------------

### Creating a GitHub Release

Source: https://github.com/steipete/summarize/blob/main/RELEASING.md

Creates a new GitHub release with specified version, assets, and release notes generated from the CHANGELOG.md. Ensure the `prev` variable is set to the last released version if skipping releases.

```bash
ver="$(node -p 'require("./package.json").version')"

# Notes = full changelog section(s), but without a duplicated version header.
# If you skipped GitHub Releases for some versions, set prev to the last released version
# and include all sections since then.
prev="0.6.1"

awk -v start="$ver" -v stop="$prev" ' 
  BEGIN { p=0 }
  $0 ~ ("^## " start " ") { p=1; next }
  $0 ~ ("^## " stop " ") { p=0 }
  p { print }
' CHANGELOG.md >"/tmp/summarize-v${ver}-notes.md"

gh release create "v${ver}" \
  "dist-bun/summarize-macos-arm64-v${ver}.tar.gz" \
  "dist-chrome/summarize-chrome-extension-v${ver}.zip" \
  "dist-firefox/summarize-firefox-extension-v${ver}.zip" \
  --title "v${ver}" \
  --notes-file "/tmp/summarize-v${ver}-notes.md"
```

--------------------------------

### Generate Free Preset with OpenRouter

Source: https://github.com/steipete/summarize/blob/main/docs/cli.md

Regenerate the candidate list for the built-in 'free' preset, which uses OpenRouter models. This command persists the updated list to your configuration file.

```bash
summarize refresh-free
```
Tokens:
Raw