1
0
Fork
You've already forked LocalResearch
0
No description
  • JavaScript 78.9%
  • Python 20.9%
  • HTML 0.1%
  • CSS 0.1%
2026年03月25日 11:43:52 +01:00
.vscode garbage removal 2026年01月19日 09:41:55 +01:00
Attic cln 2025年11月22日 08:41:57 +01:00
tty_cl Fix cur flicker 2026年01月20日 20:15:42 +01:00
web_research_server garbage removal 2026年01月19日 09:41:55 +01:00
.gitignore Timeline extraction with backends pytorch, llama.cpp, and mlx 2025年12月24日 18:19:54 +01:00
.python-version py3.14 2026年02月10日 10:40:50 +01:00
audiobook_handler.py Pydantic removal (>2x slowdown), another AI induced mess undone 2025年11月25日 13:56:28 +01:00
calibre_handler.py Pydantic removal (>2x slowdown), another AI induced mess undone 2025年11月25日 13:56:28 +01:00
document_store.py ongoing fixes 2026年03月23日 09:30:27 +01:00
IndraTimeFormat.md IndraTime doc 2025年12月24日 08:36:01 +01:00
markdown_handler.py ong md fixes 2026年03月23日 10:20:04 +01:00
orgmode_handler.py ongoing fixes 2026年03月23日 09:30:27 +01:00
perf_stats.py Record based perf measurement 2025年12月31日 16:12:39 +01:00
pyproject.toml test stuff 2026年01月20日 16:44:23 +01:00
README.md Upd doc 2025年12月13日 16:25:45 +01:00
research_console.py ongoing fixes 2026年03月23日 09:30:27 +01:00
research_defs.py first minimal suc roundtrip org md 2026年03月22日 17:26:29 +01:00
research_server.py garbage removal 2026年01月19日 09:41:55 +01:00
research_tools.py Fix antigravity colleteral damage on type system 2025年11月25日 11:06:49 +01:00
search_tools.py cln antigrav typing mess 2025年12月28日 11:10:13 +01:00
sync_tools.py rfctr 2025年11月17日 10:03:51 +01:00
text_format.py Pydantic removal (>2x slowdown), another AI induced mess undone 2025年11月25日 13:56:28 +01:00
time_lines.py Pydantic removal (>2x slowdown), another AI induced mess undone 2025年11月25日 13:56:28 +01:00
timeline_handler.py Record based perf measurement 2025年12月31日 16:12:39 +01:00
uv.lock torch 2.11 2026年03月25日 11:43:52 +01:00
vector_store.py upd, log spam removed, granite models data type changes tamed 2026年02月17日 17:00:18 +01:00

LocalResearch

WARNING: This is incomplete work in progress. It is not ready for use.

LocalResearch is a command-line tool designed for managing, indexing, and semantically searching a local library of documents. It provides a powerful interface to organize your personal knowledge base, supporting various formats like Markdown and PDF.

Key Features

  • Document Management: Syncs with local data sources, tracks changes, and manages document metadata (authors, tags, dates).
  • Semantic Search: Generates vector embeddings for your documents to enable semantic search capabilities. Find relevant information based on meaning, not just keywords.
  • Multi-Model Support: Supports multiple embedding models. You can list, enable, disable, and select the active model for indexing and searching.
  • Timeline Generation: Extracts events from your documents to compile interactive timelines, filterable by date, domain, and keywords.
  • Data Integrity: Includes tools to check and clean caches (PDF, SHA256) and verify index consistency.
  • Interactive CLI: A robust REPL (Read-Eval-Print Loop) interface with command history and auto-completion.

Infrastructure

LocalResearch is designed to run on a distributed network of workstations (macOS and Linux) within a local LAN.

  • Heterogeneous Hardware: High-performance nodes (CUDA/MPS/XPU) handle resource-intensive vector indexing, while low-power, always-on machines serve queries and small updates.
  • Data Synchronization: Nodes share data stored in ~/.local/share/local_research/ via a synchronized file system path ~/LocalResearch.
    • publish: Copies local data to the shared ~/LocalResearch folder.
    • import: Updates the local data from the shared ~/LocalResearch folder.

Usage

Run the main console application:

python research_console.py

Or start the web server:

python web_server.py

Common Commands

  • help: Show an overview of available commands.
  • sync: Sync data sources and check for new or changed documents.
  • index: Generate vector indices for new content.
  • search <query>: Perform a semantic search.
  • text: Display the full text of the last search result.
  • timeline: Generate a timeline of events (e.g., timeline time=2023 domains=work).
  • list models: List available embedding models.
  • check: Verify data structures and caches.

Supported Formats

  • Markdown: Native support for markdown files.
  • PDF: Extracts text from PDF documents (via Calibre/other handlers).
  • OrgMode: Support for Emacs Org-mode files.
  • Web Interface: A 3D interactive web client for visual exploration and search (see web_client/README.md).

Configuration

Configuration and history are stored in ~/.config/local_research. The tool allows runtime configuration of variables and processing devices (CPU/CUDA/MPS/XPU).