What is qmd CLAUDE.md?

A set of instructions for using QMD, a tool that indexes and searches local Markdown documents. It covers running QMD with Bun and managing document collections.

Use it to add folders to named collections, list or remove collections, add document context, retrieve one or more files, check index status, and re-index documents.

It gives the coding agent a consistent way to create, inspect, update, and diagnose local document indexes instead of relying on unfamiliar commands.

How tobi/qmd configures Claude Code

About the project

QMD is a local search engine for Markdown notes, meeting transcripts, documentation, and knowledge bases. It combines keyword search, semantic vector search, and language-model reranking on the device for use in command-line or agent workflows. The catalogue add-ons connect agents to QMD and guide its use.

tobi/qmd · 30,907 stars · on GitHub

Reuse

Borrowing it

Nothing to install: this file belongs to tobi/qmd. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/tobi/qmd/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/tobi/qmd

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/tobi/qmd/claude-md/github.svg)](https://agentmods.dev/instructions/tobi/qmd/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/tobi/qmd/claude-md"><img src="https://agentmods.dev/badge/instructions/tobi/qmd/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/tobi/qmd/claude-md"><img src="https://agentmods.dev/badge/instructions/tobi/qmd/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,887 This file is loaded in full into every session.

When invoked 1,887 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.01887	$0.01887
Opus 5.5	$0.00755	$0.00755
Sonnet 5.5	$0.00377	$0.00377
Haiku 4.5	$0.00189	$0.00189

Measured 1mo ago against content hash e32a1e9fb3c0, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

qmd CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 194 lines

How it starts

The opening of the file, as written. The whole thing — 194 lines — stays where its author put it; the contents beside it link to each section on GitHub.

QMD - Query Markup Documents

Use Bun instead of Node.js (bun not node, bun install not npm install).

Commands

qmd collection add . --name <n>   # Create/index collection
qmd collection list               # List all collections with details
qmd collection remove <name>      # Remove a collection by name
qmd collection rename <old> <new> # Rename a collection
qmd collection metadata [name...] # Discover metadata keys, types, and value counts (--match, --filter, --key-limit, --value-limit)
qmd init                          # Create a project-local .qmd index
qmd ls [collection[/path]]        # List collections or files in a collection
qmd context add [path] "text"     # Add context for path (defaults to current dir)
qmd context list                  # List all contexts
qmd context check                 # Check for collections/paths missing context
qmd context rm <path>             # Remove context
qmd get <file>[:from[:count]]     # Get by path or docid (#abc123); optional line range
qmd multi-get <pattern>           # Get multiple docs by glob or comma-separated list
qmd status                        # Show index status and collections
qmd doctor                        # Diagnose config, index, model, and device issues
qmd update                        # Re-index collections; configured update hooks run first
qmd trust [list|revoke]           # Approve a checked-in .qmd config's hooks/paths/models
qmd embed                         # Generate vector embeddings (uses node-llama-cpp)
qmd query <query>                 # Search with query expansion + reranking (recommended)
qmd search <query>                # Full-text keyword search (BM25, no LLM)
qmd vsearch <query>               # Vector similarity search (no reranking)
qmd bench <fixture.json>          # Run search-quality benchmarks
qmd mcp                           # Start MCP server (stdio transport)
qmd mcp --http [--port N]         # Start MCP server (HTTP, default port 8181)
qmd mcp --http --daemon           # Start as background daemon
qmd mcp stop                      # Stop background MCP daemon

Read the full file on GitHub · 194 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

1mo ago Changed · +8 lines · +160 tokens per session e32a1e9fb3c0
2mo ago First seen · 186 lines · 1,727 tokens per session scan A 578a832b0b17

Subscribe to this mod's changes

qmd CLAUDE.md is an instructions file published in the GitHub repository tobi/qmd (30,907 stars, last pushed 22d ago), licensed MIT. It adds 1,887 tokens to every session, about $0.0075 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

qmd CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
qmd CLAUDE.mdtobi/qmd	Instructions file	31k	22d ago	MIT	A	1,887	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,516	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

qmd: Instructions file for Claude Code