Semantic search over your markdown vault -- lightweight, local, zero-config
Project description
markseek
Semantic search over your markdown vault. Built on Obsidian. Lightweight, local, zero-config.
Query by meaning, not keywords. Works offline. No API keys.
Why
You want semantic search over your Obsidian vault, your notes, or any folder of markdown files. Everything else that does this is either a heavy web app (PrivateGPT, AnythingLLM — full Docker containers, web UIs, hundreds of MB of RAM) or only works while the desktop app is open.
markseek is one package, no web server, no Docker, no cloud:
$ markseek "what did Frankl say about the bird"
Search results for: "what did Frankl say about the bird"
─── Result 1 (relevance: 0.91) ───
File: letters/Pen Pal.md
Snippet:
And then a bird lands on the dirt he just dug up and looks at him.
That's it. That's the whole philosophy. A man who has lost literally
everything and a bird lands and looks at him and the world is still,
for one second, looking back.
Install
pip install markseek
Quick Start
- Configure your vault:
markseek --configure
Or point it directly via environment variable:
export MARKSEEK_VAULT_PATH="~/Documents/Obsidian Vault"
- Search:
markseek "what does Frankl say about meaning and suffering" -n 5
- Watch for changes (background index):
markseek --watch
Run this in a terminal, or as a systemd/launchd service. Whenever you
modify a .md file in the vault, it gets re-indexed automatically
within 2 seconds.
Commands
| Command | Description |
|---|---|
markseek "your query" |
Semantic search (auto-indexes on first run) |
markseek -n 10 "query" |
Top 10 results |
markseek --watch |
Start auto-indexing watcher (background) |
markseek --index |
Manually update the index |
markseek --index --rebuild |
Force full reindex |
markseek --status |
Show index stats (files, chunks, model) |
markseek --configure |
Interactive config wizard |
How It Works
- Markdown files in your vault are chunked by paragraphs (~500 chars).
- Local embeddings --
all-MiniLM-L6-v2(~80MB, CPU, no GPU needed) converts each chunk to a vector. - ChromaDB stores the vectors locally for fast similarity search.
- Auto-indexing -- a file watcher detects changes and re-indexes only the changed file.
- Semantic queries -- your question gets embedded and matched against all chunks, ranked by cosine similarity.
No files are uploaded anywhere. Everything runs on your machine.
Configuration
Config file: ~/.config/markseek/config.yaml
vault_path: ~/Documents/Obsidian Vault
index_path: ~/.cache/markseek/index
model_name: all-MiniLM-L6-v2
max_chunk_size: 500
debounce_seconds: 2.0
log_level: INFO
extensions: [".md"]
Environment variables take priority:
MARKSEEK_VAULT_PATH-- override vault pathMARKSEEK_INDEX_PATH-- override index location
As a Library
from markseek.config import Config
from markseek.core import Index
cfg = Config.load()
index = Index(cfg)
results = index.search("meaning through encountering someone")
License
MIT. See LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markseek-0.1.1.tar.gz.
File metadata
- Download URL: markseek-0.1.1.tar.gz
- Upload date:
- Size: 13.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
74649615468195ab9f8dc4627d49e5309b0a54e6a034ae53e8a1988048e35896
|
|
| MD5 |
48989e24132bebdad70e2d91e2460269
|
|
| BLAKE2b-256 |
b9932a7454e75de1da2766ddc28369239004fc03ce4fff5b41c51226233be818
|
File details
Details for the file markseek-0.1.1-py3-none-any.whl.
File metadata
- Download URL: markseek-0.1.1-py3-none-any.whl
- Upload date:
- Size: 13.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ff928ab740461a6ff1e376a903964047331ef7e456b942e5df5af63a9037b1c7
|
|
| MD5 |
47efadb57d16f82801d51e48a6712a98
|
|
| BLAKE2b-256 |
3b5e18a2be460465cf9646dc9ee1ba4bb6e6dca3e82776fbac555c70b8e29ef4
|