Skip to content

User Guide

Complete documentation for all Inkwell features.

Core Features

Managing Feeds

Add, list, and remove podcast feeds. Includes support for private/paid feeds with authentication.

Processing Episodes

Fetch and process episodes from your feeds. Understand the transcription and extraction pipeline.

Content Extraction

Configure templates, choose providers (Claude vs Gemini), manage costs, and understand caching.

Interview Mode

Capture your personal insights with guided Q&A. Turn passive listening into active learning.

Obsidian Integration

Wikilinks, tags, frontmatter, and Dataview queries. Make the most of your notes in Obsidian.

Configuration

All configuration options, file locations, and environment variables.

Extensibility

Plugin Development

Extend Inkwell with custom plugins for extraction, transcription, and output formats. Create and publish your own plugins.

Local Codex Extraction

Explicitly delegate local extraction to a user-installed Codex CLI without copying credentials or changing automatic provider routing.

Local Claude Extraction

Use your local Claude CLI for explicit extraction while keeping authentication owned by Claude Code.

Quick Reference

Common Commands

# Add a feed
inkwell add <url> --feed-name <name>

# List feeds
inkwell list

# Process latest episode
inkwell fetch <feed-name> --latest

# Process local media
inkwell fetch ~/Downloads/interview.mp3

# Process local text or stdin
inkwell fetch ./notes.md
pbpaste | inkwell fetch -

# Process a PDF, image, or readable article
inkwell fetch ./paper.pdf
inkwell fetch ./whiteboard.png
inkwell fetch https://example.com/article

# Transcript only
inkwell fetch <url> --extract

# Process with interview
inkwell fetch <feed-name> --latest --interview

# Check costs
inkwell costs

Output Structure

~/inkwell-notes/
└── podcast-2025-01-15-episode-title/
    ├── .metadata.yaml
    ├── summary.md
    ├── quotes.md
    ├── key-concepts.md
    ├── tools-mentioned.md
    └── my-notes.md

Configuration Files

~/.config/inkwell/
├── config.yaml    # Global settings
├── feeds.yaml     # Feed definitions
└── .keyfile       # Encryption key

Need Help?