🔗 Obsidian Vault Indexer

SLM PKB Agent

Local knowledge management assistant. Builds, links, and tags markdown documents in Obsidian, Notion, or Logseq vaults offline.

🚀 Overview & Capabilities

Local knowledge management assistant. Builds, links, and tags markdown documents in Obsidian, Notion, or Logseq vaults offline.

Key Features

Auto-scans directories of markdown notes to map semantic clusters
Suggests links between notes based on context similarity
Auto-generates summaries, tags, and indexing logs for vault folders
Integrates directly with local Obsidian vaults

💻 Installation

Install the local CPU-optimized package using pip:

Terminal

              # Install local CPU-optimized package
pip install slm-pkb
            

🐙 Checkout from GitHub

Clone only this agent's folder from the monorepo using Git sparse-checkout — no need to download the full repository:

Option 1 — Sparse Checkout (Recommended)

Terminal — Git Sparse Checkout

              # 1. Create and enter a new directory
$ mkdir slm_pkb && cd slm_pkb

# 2. Initialise empty git repo and add remote
$ git init
$ git remote add origin https://github.com/t00114218-stack/SLMAgents.git

# 3. Enable sparse-checkout and set target folder
$ git sparse-checkout init --cone
$ git sparse-checkout set slm_pkb

# 4. Pull only that agent's source
$ git pull origin main
            

Option 2 — Full Repository Clone

Terminal — Full Clone

              $ git clone https://github.com/t00114218-stack/SLMAgents.git
$ cd SLMAgents/slm_pkb
            

💡 Tip: After checkout, install the package locally with pip install -e ./slm_pkb to run in editable mode without publishing to PyPI.

⚙️ Configuration API

Constructor Parameters

Instantiate SLMPKBAgent with performance options:

Parameter	Type / Default	Description
model_path	str \| None	Explicit path to ONNX model weights. If omitted, downloads standard checkpoints.
cache_dir	str \| None	Directory to store model weights offline. Defaults to `~/.cache/slm-pkb/`. Also settable via SLM_PKB_AGENT_CACHE_DIR.
n_threads	int \| 4	CPU thread count for ONNX inference. Optimize for CPU core count. Also settable via SLM_PKB_AGENT_N_THREADS.

Methods

Method Signature	Return Type	Description
`index_vault(vault_path, system_prompt=None, user_input=None)`	`dict`	Indexes all markdown note structures and establishes cross-linked reference indices.

Method Parameters (Execution Customization)

All main execution methods accept optional system routing parameters:

Parameter	Type / Default	Description
system_prompt	str \| None	Optional custom system prompt instruction to override the default system template response parameters.
user_input	str \| None	Optional additional user-supplied target text variables or contextual keys.

Quick Start

from slm_pkb import SLMPKBAgent

agent = SLMPKBAgent()
print(agent.index_vault(
    "~/Obsidian/MyVault",
    system_prompt="Strict directory mapping structure",
    user_input="Scan sub-directories recursively"
))

Environment Variables

Configure agent parameters globally using environment values:

Environment Variable	Default	Purpose
SLM_PKB_AGENT_N_THREADS	4	Sets CPU inference execution threads.
SLM_PKB_AGENT_CACHE_DIR	~/.cache/slm-pkb/	Default directory to store downloaded ONNX weights.

CPU Performance Tuning

To run the SLMPKBAgent engine efficiently on CPU under 1.5 GB memory footprint:

Match Threads to Core Count: Set n_threads or SLM_PKB_AGENT_N_THREADS to match the physical CPU core count.
Sequential Processing: Avoid concurrent processing when batch files are large.
Garbage Collection: Clear variables and run gc.collect() to release model RAM blocks after execution.

Verified Input & Output Logs

Diagnostic execution console response running locally on CPU:

→ INPUT (Vault Path):
"~/MyObsidianVault"

← OUTPUT:
{
  'notes_indexed': 0,
  'suggested_links': []
}