@fs/mycroft 0.1.0

package/README.md

@@ -0,0 +1,73 @@
+# mycroft-cli
+
+Command-line tool that ingests EPUB files, builds a local searchable index, and answers questions using a retrieval-augmented workflow.
+
+## Requirements
+
+- Node.js >= 18
+
+## Install
+
+```bash
+npm install -g @fs/mycroft
+```
+
+Ensure `node` is on your PATH (the CLI uses Node.js as its runtime).
+
+## Usage
+
+```bash
+mycroft book list
+mycroft book ingest /path/to/book.epub
+mycroft book ask <id> "What is the main conflict?"
+mycroft config init
+mycroft config resolve
+mycroft config onboard
+```
+
+## Local dev
+
+```bash
+npm install
+npm run build
+node dist/cli.js --help
+```
+
+## Config
+
+Default config path:
+
+```
+~/.config/mycroft/config.json
+```
+
+Default config:
+
+```json
+{
+  "dataDir": "~/.local/share/mycroft",
+  "askEnabled": true,
+  "models": {
+    "embedding": "text-embedding-3-small",
+    "summary": "gpt-5-nano",
+    "chat": "gpt-5.1"
+  }
+}
+```
+
+Environment overrides:
+
+- `MYCROFT_DATA_DIR`
+- `MYCROFT_CONFIG`
+- `OPENAI_API_KEY`
+
+`OPENAI_API_KEY` is required for embeddings, search, and Q&A (and for summaries if enabled).
+
+CLI overrides:
+
+- `--data-dir <path>` (global)
+- `--max-chapter <n>`
+- `--top-k <n>`
+- `--manual` (interactive chapter selection)
+- `--summary`
+- `--force`

package/bin/mycroft.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "../dist/cli.js";

package/completions/mycroft.bash

@@ -0,0 +1,46 @@
+_mycroft() {
+  local cur prev
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+
+  local top_commands="book config"
+  local global_flags="--help --version --data-dir"
+  local book_commands="ingest list show ask search delete"
+  local config_commands="path init resolve onboard"
+
+  if [[ ${COMP_CWORD} -le 1 ]]; then
+    COMPREPLY=( $(compgen -W "${top_commands} ${global_flags}" -- "${cur}") )
+    return 0
+  fi
+
+  case "${COMP_WORDS[1]}" in
+    book)
+      if [[ ${COMP_CWORD} -eq 2 ]]; then
+        COMPREPLY=( $(compgen -W "${book_commands} ${global_flags}" -- "${cur}") )
+        return 0
+      fi
+      case "${COMP_WORDS[2]}" in
+        ingest)
+          COMPREPLY=( $(compgen -W "--manual --no-summary" -- "${cur}") )
+          return 0
+          ;;
+        ask|search)
+          COMPREPLY=( $(compgen -W "--top-k --max-chapter" -- "${cur}") )
+          return 0
+          ;;
+        delete)
+          COMPREPLY=( $(compgen -W "--force" -- "${cur}") )
+          return 0
+          ;;
+      esac
+      ;;
+    config)
+      if [[ ${COMP_CWORD} -eq 2 ]]; then
+        COMPREPLY=( $(compgen -W "${config_commands} ${global_flags}" -- "${cur}") )
+        return 0
+      fi
+      ;;
+  esac
+}
+
+complete -F _mycroft mycroft

package/completions/mycroft.fish

@@ -0,0 +1,40 @@
+function __mycroft_needs_command
+  set -l cmd (commandline -opc)
+  if test (count $cmd) -le 1
+    return 0
+  end
+  return 1
+end
+
+function __mycroft_using_command
+  set -l cmd (commandline -opc)
+  set -l sub $argv[1]
+  if test (count $cmd) -ge 2; and test $cmd[2] = $sub
+    return 0
+  end
+  return 1
+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 -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'
+
+complete -c mycroft -n '__mycroft_using_command book' -a 'ingest' -d 'Ingest an EPUB file'
+complete -c mycroft -n '__mycroft_using_command book' -a 'list' -d 'List indexed books'
+complete -c mycroft -n '__mycroft_using_command book' -a 'show' -d 'Show full book metadata'
+complete -c mycroft -n '__mycroft_using_command book' -a 'ask' -d 'Ask a question about a book'
+complete -c mycroft -n '__mycroft_using_command book' -a 'search' -d 'Vector search without LLM'
+complete -c mycroft -n '__mycroft_using_command book' -a 'delete' -d 'Remove book, EPUB, and vectors'
+
+complete -c mycroft -n '__mycroft_using_command book; and __fish_seen_subcommand_from ingest' -l manual -d 'Interactive chapter selection'
+complete -c mycroft -n '__mycroft_using_command book; and __fish_seen_subcommand_from ingest' -l no-summary -d 'Skip AI chapter summaries'
+complete -c mycroft -n '__mycroft_using_command book; and __fish_seen_subcommand_from ask search' -l top-k -r -d 'Number of passages to retrieve'
+complete -c mycroft -n '__mycroft_using_command book; and __fish_seen_subcommand_from ask search' -l max-chapter -r -d 'Spoiler-free limit'
+complete -c mycroft -n '__mycroft_using_command book; and __fish_seen_subcommand_from delete' -l force -d 'Skip confirmation'
+
+complete -c mycroft -n '__mycroft_using_command config' -a 'path' -d 'Print config path'
+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'

package/completions/mycroft.zsh

@@ -0,0 +1,54 @@
+#compdef mycroft
+
+_mycroft() {
+  local -a top_commands
+  top_commands=(book config)
+
+  local -a book_commands
+  book_commands=(ingest list show ask search delete)
+
+  local -a config_commands
+  config_commands=(path init resolve onboard)
+
+  local -a global_flags
+  global_flags=(--help --version --data-dir)
+
+  if (( CURRENT == 2 )); then
+    _describe -t commands "mycroft commands" top_commands
+    _describe -t flags "global flags" global_flags
+    return
+  fi
+
+  case ${words[2]} in
+    book)
+      if (( CURRENT == 3 )); then
+        _describe -t commands "book commands" book_commands
+        _describe -t flags "global flags" global_flags
+        return
+      fi
+      case ${words[3]} in
+        ingest)
+          _arguments "--manual[Interactive chapter selection]" "--no-summary[Skip AI chapter summaries]"
+          return
+          ;;
+        ask|search)
+          _arguments "--top-k[Number of passages to retrieve]:n" "--max-chapter[Spoiler-free limit]:n"
+          return
+          ;;
+        delete)
+          _arguments "--force[Skip confirmation]"
+          return
+          ;;
+      esac
+      ;;
+    config)
+      if (( CURRENT == 3 )); then
+        _describe -t commands "config commands" config_commands
+        _describe -t flags "global flags" global_flags
+        return
+      fi
+      ;;
+  esac
+}
+
+_mycroft