@fs/mycroft 0.1.1 → 0.3.0

package/README.md

@@ -1,4 +1,4 @@
-# mycroft-cli
+# mycroft
 
 Command-line tool that ingests EPUB files, builds a local searchable index, and answers questions using a retrieval-augmented workflow.
 
@@ -16,17 +16,42 @@ Ensure `node` is on your PATH (the CLI uses Node.js as its runtime).
 
 ## Usage
 
-Run `mycroft config onboard` first to set everything up, then use the book commands.
+Run `mycroft config onboard` first to set everything up, then use the book and chat commands.
 
 ```bash
 mycroft book list
 mycroft book ingest /path/to/book.epub
+mycroft book ingest /path/to/book.epub --summary
+mycroft book ingest /path/to/book.epub --batch
+mycroft book ingest /path/to/book.epub --batch --summary
+mycroft book ingest status <id>
+mycroft book ingest resume <id>
 mycroft book ask <id> "What is the main conflict?"
+mycroft chat start <id>
+mycroft chat ask <session> "What does this foreshadow?"
+mycroft chat repl <session>
 mycroft config init
 mycroft config resolve
 mycroft config onboard
 ```
 
+## Cost estimates (approximate)
+
+These are rough, model-dependent estimates for embeddings + optional summaries. Costs vary by model pricing and book structure. Use this as a directional guide only. Summarization estimates assume `gpt-5-nano` and embeddings assume `text-embedding-3-small`.
+
+| Book size | Example | No summaries | With summaries | With summaries (batched) |
+| --- | --- | --- | --- | --- |
+| Small | 200-300 pages | ~$0.002-$0.004 | ~$0.04-$0.08 | ~$0.02-$0.04 |
+| Average novel | 350-450 pages | ~$0.004-$0.006 | ~$0.08-$0.15 | ~$0.04-$0.08 |
+| Large novel | 600-800 pages | ~$0.007-$0.01 | ~$0.15-$0.25 | ~$0.08-$0.13 |
+| Trilogy | 1,500-2,000 pages | ~$0.02-$0.03 | ~$0.30-$0.60 | ~$0.15-$0.30 |
+
+Reference point: a ~700 page book (~1,600 chunks) is about ~$0.008 for embeddings only, ~$0.20 with summaries, or ~$0.10 with summaries batched.
+
+Use `--summary` to generate per-chapter summaries during ingestion. Summaries improve retrieval quality but are significantly more expensive than embeddings alone (see cost table above). Without `--summary`, ingestion only generates embeddings, which is fast and cheap.
+
+Use `--batch` to cut costs by 50% via the OpenAI Batch API. This applies to both embeddings and summaries. Batch jobs may take up to 24 hours to complete. When using `--batch`, the command returns immediately after submitting the job. When combined with `--summary`, the summary batch runs first; once complete, run `resume` to submit the embedding batch. Use `mycroft book ingest status <id>` to check progress, and `mycroft book ingest resume <id>` to advance to the next phase. If a non-batch ingest is interrupted, use the same resume command to continue without re-embedding completed chunks.
+
 ## Local dev
 
 ```bash
@@ -71,5 +96,6 @@ CLI overrides:
 - `--max-chapter <n>`
 - `--top-k <n>`
 - `--manual` (interactive chapter selection)
+- `--batch`
 - `--summary`
 - `--force`

package/completions/mycroft.bash

@@ -3,10 +3,11 @@ _mycroft() {
   cur="${COMP_WORDS[COMP_CWORD]}"
   prev="${COMP_WORDS[COMP_CWORD-1]}"
 
-  local top_commands="book config"
+  local top_commands="book config chat"
   local global_flags="--help --version --data-dir"
   local book_commands="ingest list show ask search delete"
   local config_commands="path init resolve onboard"
+  local chat_commands="start ask list show repl"
 
   if [[ ${COMP_CWORD} -le 1 ]]; then
     COMPREPLY=( $(compgen -W "${top_commands} ${global_flags}" -- "${cur}") )
@@ -40,6 +41,26 @@ _mycroft() {
         return 0
       fi
       ;;
+    chat)
+      if [[ ${COMP_CWORD} -eq 2 ]]; then
+        COMPREPLY=( $(compgen -W "${chat_commands} ${global_flags}" -- "${cur}") )
+        return 0
+      fi
+      case "${COMP_WORDS[2]}" in
+        ask|repl)
+          COMPREPLY=( $(compgen -W "--top-k --max-chapter" -- "${cur}") )
+          return 0
+          ;;
+        show)
+          COMPREPLY=( $(compgen -W "--tail" -- "${cur}") )
+          return 0
+          ;;
+        start)
+          COMPREPLY=( $(compgen -W "--title" -- "${cur}") )
+          return 0
+          ;;
+      esac
+      ;;
   esac
 }
 

package/completions/mycroft.fish

@@ -17,6 +17,7 @@ end
 
 complete -c mycroft -n '__mycroft_needs_command' -a 'book' -d 'Manage books and queries'
 complete -c mycroft -n '__mycroft_needs_command' -a 'config' -d 'Manage configuration'
+complete -c mycroft -n '__mycroft_needs_command' -a 'chat' -d 'Run multi-turn chat sessions'
 complete -c mycroft -s h -l help -d 'Show help'
 complete -c mycroft -l version -d 'Show version'
 complete -c mycroft -l data-dir -r -d 'Override data directory'
@@ -38,3 +39,14 @@ complete -c mycroft -n '__mycroft_using_command config' -a 'path' -d 'Print conf
 complete -c mycroft -n '__mycroft_using_command config' -a 'init' -d 'Create default config file'
 complete -c mycroft -n '__mycroft_using_command config' -a 'resolve' -d 'Print resolved config values'
 complete -c mycroft -n '__mycroft_using_command config' -a 'onboard' -d 'Initialize config and show next step'
+
+complete -c mycroft -n '__mycroft_using_command chat' -a 'start' -d 'Start a chat session for a book'
+complete -c mycroft -n '__mycroft_using_command chat' -a 'ask' -d 'Ask a question in a chat session'
+complete -c mycroft -n '__mycroft_using_command chat' -a 'list' -d 'List chat sessions'
+complete -c mycroft -n '__mycroft_using_command chat' -a 'show' -d 'Show chat session details'
+complete -c mycroft -n '__mycroft_using_command chat' -a 'repl' -d 'Start interactive chat session'
+
+complete -c mycroft -n '__mycroft_using_command chat; and __fish_seen_subcommand_from ask repl' -l top-k -r -d 'Number of passages to retrieve'
+complete -c mycroft -n '__mycroft_using_command chat; and __fish_seen_subcommand_from ask repl' -l max-chapter -r -d 'Spoiler-free limit'
+complete -c mycroft -n '__mycroft_using_command chat; and __fish_seen_subcommand_from show' -l tail -r -d 'Show last N messages'
+complete -c mycroft -n '__mycroft_using_command chat; and __fish_seen_subcommand_from start' -l title -r -d 'Session title'

package/completions/mycroft.zsh

@@ -2,7 +2,7 @@
 
 _mycroft() {
   local -a top_commands
-  top_commands=(book config)
+  top_commands=(book config chat)
 
   local -a book_commands
   book_commands=(ingest list show ask search delete)
@@ -10,6 +10,9 @@ _mycroft() {
   local -a config_commands
   config_commands=(path init resolve onboard)
 
+  local -a chat_commands
+  chat_commands=(start ask list show repl)
+
   local -a global_flags
   global_flags=(--help --version --data-dir)
 
@@ -48,6 +51,27 @@ _mycroft() {
         return
       fi
       ;;
+    chat)
+      if (( CURRENT == 3 )); then
+        _describe -t commands "chat commands" chat_commands
+        _describe -t flags "global flags" global_flags
+        return
+      fi
+      case ${words[3]} in
+        ask|repl)
+          _arguments "--top-k[Number of passages to retrieve]:n" "--max-chapter[Spoiler-free limit]:n"
+          return
+          ;;
+        show)
+          _arguments "--tail[Show last N messages]:n"
+          return
+          ;;
+        start)
+          _arguments "--title[Session title]:text"
+          return
+          ;;
+      esac
+      ;;
   esac
 }
 

package/dist/batch-embedder-6IIWAZPW.js

@@ -0,0 +1,14 @@
+import {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+} from "./chunk-BR2PM6D3.js";
+import "./chunk-R3FOJK5A.js";
+export {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+};
+//# sourceMappingURL=batch-embedder-6IIWAZPW.js.map

package/dist/batch-embedder-6IIWAZPW.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-embedder-7DGZAQKL.js

@@ -0,0 +1,14 @@
+import {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+} from "./chunk-7CO4PMU5.js";
+import "./chunk-KGG7WEYE.js";
+export {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+};
+//# sourceMappingURL=batch-embedder-7DGZAQKL.js.map

package/dist/batch-embedder-7DGZAQKL.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-embedder-IZDBS3IL.js

@@ -0,0 +1,13 @@
+import {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+} from "./chunk-6DLQHHCC.js";
+export {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+};
+//# sourceMappingURL=batch-embedder-IZDBS3IL.js.map

package/dist/batch-embedder-IZDBS3IL.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-embedder-LYCZDYI4.js

@@ -0,0 +1,15 @@
+import {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+} from "./chunk-7NLMBXXY.js";
+import "./chunk-7IPX4MKA.js";
+import "./chunk-R3FOJK5A.js";
+export {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+};
+//# sourceMappingURL=batch-embedder-LYCZDYI4.js.map

package/dist/batch-embedder-LYCZDYI4.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-embedder-RHKD2OJD.js

@@ -0,0 +1,14 @@
+import {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+} from "./chunk-57ZGGKEF.js";
+import "./chunk-R3FOJK5A.js";
+export {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+};
+//# sourceMappingURL=batch-embedder-RHKD2OJD.js.map

package/dist/batch-embedder-RHKD2OJD.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-embedder-VQZUI7R6.js

@@ -0,0 +1,14 @@
+import {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+} from "./chunk-35EO53CC.js";
+import "./chunk-R3FOJK5A.js";
+export {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+};
+//# sourceMappingURL=batch-embedder-VQZUI7R6.js.map

package/dist/batch-embedder-VQZUI7R6.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-embedder-ZJZLNLOK.js

@@ -0,0 +1,14 @@
+import {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+} from "./chunk-XXO66RCF.js";
+import "./chunk-KGG7WEYE.js";
+export {
+  checkBatchStatus,
+  cleanupBatchFiles,
+  downloadBatchResults,
+  submitBatchEmbeddings
+};
+//# sourceMappingURL=batch-embedder-ZJZLNLOK.js.map

package/dist/batch-embedder-ZJZLNLOK.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-summarizer-7MCT4HJB.js

@@ -0,0 +1,14 @@
+import {
+  downloadBatchSummaryResults,
+  downloadMergeResults,
+  submitBatchSummaries,
+  submitMergePass
+} from "./chunk-QRDUQX63.js";
+import "./chunk-KGG7WEYE.js";
+export {
+  downloadBatchSummaryResults,
+  downloadMergeResults,
+  submitBatchSummaries,
+  submitMergePass
+};
+//# sourceMappingURL=batch-summarizer-7MCT4HJB.js.map

package/dist/batch-summarizer-7MCT4HJB.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/batch-summarizer-BMIBVFAE.js

@@ -0,0 +1,14 @@
+import {
+  downloadBatchSummaryResults,
+  downloadMergeResults,
+  submitBatchSummaries,
+  submitMergePass
+} from "./chunk-7DUQNGEK.js";
+import "./chunk-KGG7WEYE.js";
+export {
+  downloadBatchSummaryResults,
+  downloadMergeResults,
+  submitBatchSummaries,
+  submitMergePass
+};
+//# sourceMappingURL=batch-summarizer-BMIBVFAE.js.map

package/dist/batch-summarizer-BMIBVFAE.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}