Skip to main content

Installation

Prerequisites

  • Node.js >= 22 (required by Ink 6)
  • yt-dlp (optional, for video transcript ingestion): brew install yt-dlp

Platform Notes

PlatformNotes
macOSKeychain-backed secret storage is available by default
LinuxSecret storage depends on keyring/libsecret availability
CI/containersPrefer environment variables and set LORE_DISABLE_KEYTAR=true

Install

npm install -g @telepat/lore

Verify

lore --version
lore --help

First-Time Setup Checklist

# initialize repository metadata
lore init

# configure required OpenRouter key
lore settings set openrouterApiKey <value> --scope global

# verify effective settings
lore settings list --scope all

Optional Dependencies

FeatureDependencyRequired?
Video subtitle ingestyt-dlpOptional
PDF/DOCX/PPTX/XLSX/EPUB ingestReplicate tokenOptional
Image OCR ingestReplicate tokenOptional

Troubleshooting

SymptomLikely causeFix
command not found: loreGlobal npm bin not on PATHEnsure npm global bin is in shell PATH
Secret set fails in headless environmentKeychain unavailableUse env vars + LORE_DISABLE_KEYTAR=true
Video URL ingests no transcriptyt-dlp missing or no subtitlesInstall yt-dlp or rely on URL fallback