mycroft

Use mycroft to ingest EPUBs and ebooks, build a local vector index, and ask questions about a book.

Setup (once)

• - INLINECODE1
• INLINECODE2
• INLINECODE3

Common commands

• - List books: INLINECODE4
• Ingest EPUB: INLINECODE5
• Ingest with summaries: INLINECODE6
• Ingest with batch embeddings (50% cheaper): INLINECODE7
• Ingest with batch summaries + embeddings: INLINECODE8
• Resume batch ingestion: INLINECODE9
• Check ingestion status: INLINECODE10
• Show metadata: INLINECODE11
• Ask a question: INLINECODE12
• Search passages: INLINECODE13
• Delete book: INLINECODE14
• Start chat: INLINECODE15
• Ask in session: INLINECODE16
• Continue chat: INLINECODE17

Notes

• - Use mycroft config path to find the config file location.
• INLINECODE19 and book search require embeddings and an OPENAI_API_KEY.
• Chat commands require embeddings and an OPENAI_API_KEY.
• Prefer book search and synthesize answers yourself before using book ask.
• Summaries increase ingestion time and cost significantly; enable --summary only when needed.
• Use --batch to run embeddings and summaries via the OpenAI Batch API at 50% cost; results may take up to 24 hours. When combined with --summary, summaries are batched first, then embeddings on resume.
• After --batch ingestion, use mycroft book ingest status <id> to check progress and mycroft book ingest resume <id> to complete indexing.
• If a non-batch ingest is interrupted, use mycroft book ingest resume <id> to continue from the last saved chunk.
• If a batch fails, resume automatically re-submits it.
• For scripted runs, avoid interactive flags like --manual or omit confirmations with --force.