qkb: Instructions file for Claude Code

CLAUDE.md

qkb CLAUDE.md is an instructions file for Claude Code from miguelarios/qkb. It costs 673 tokens per session, scanned A, original, MIT.

Project instructions for qkb, a TypeScript rewrite of a local search tool for Obsidian vaults. They define the project’s source of truth, development commands, architecture, and rules for matching the older Python version.

In plain words
What is it for?
Use them when developing, testing, or porting qkb features at the repository root.
Why use it?
They help contributors make changes in the planned order and preserve behavior while the project moves from Python to TypeScript.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md.

This is miguelarios/qkb's own configuration. It tells Claude Code how to work on qkb itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything qkb configures →

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is cd legacy/python && ../../.venv/bin/pytest -q -m "not integration".

Reuse

Borrowing it

Nothing to install: this file belongs to miguelarios/qkb. 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/miguelarios/qkb/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/miguelarios/qkb

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.

agentmods badge for qkb CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/miguelarios/qkb/claude-md/github.svg)](https://agentmods.dev/instructions/miguelarios/qkb/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/miguelarios/qkb/claude-md"><img src="https://agentmods.dev/badge/instructions/miguelarios/qkb/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.

agentmods 80×15 button for qkb CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/miguelarios/qkb/claude-md"><img src="https://agentmods.dev/badge/instructions/miguelarios/qkb/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 673 This file is loaded in full into every session.
When invoked 673 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00673 $0.00673
Opus 5 $0.00336 $0.00336
Sonnet 5 $0.00135 $0.00135
Haiku 4.5 $0.00067 $0.00067

Measured 8d ago against content hash f2e1ef416e0b, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

qkb 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 8d 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 · 37 lines

How it starts

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

qkb — Project Instructions

Hybrid BM25 + vector search for Obsidian vaults. The project is mid-rewrite from Python to TypeScript (Node ≥20, better-sqlite3 + sqlite-vec, commander CLI, @modelcontextprotocol/sdk stdio server) — see docs/plans/2026-07-20-typescript-rewrite.md. The TS project lives at the repo root; the original Python implementation (qkb-search, v0.3.0, published on PyPI) is preserved and still runnable under legacy/python/ and is the authoritative behavioral spec each port task matches against. Package @miguelarios/qkb, command qkb.

Source of truth

  • docs/plans/2026-07-20-typescript-rewrite.md — the TypeScript rewrite plan (18 tasks). Execute in order; each task ports the cited legacy/python/src/qkb/<module>.py + legacy/python/tests/test_<module>.py.
  • docs/plans/2026-07-06-phase1-mvp.md — the original Python implementation plan, kept for history.
  • docs/DESIGN.md — technical design. docs/adr/architecture-decisions.md — decision log; ADRs win over DESIGN.md on conflict.
  • docs/PRD.md — success criteria (unchanged by the rewrite). Primary: ≥8/10 golden queries return the target doc in the top 3.

Commands

# TypeScript (repo root)
npm test                                   # unit tests (vitest, no Ollama, FakeProvider)
npx biome check . && npx tsc --noEmit      # lint/format + typecheck
npm run build                              # tsc -> dist/

# Legacy Python (legacy/python/) — reference/spec only, not the shipping code
cd legacy/python && ../../.venv/bin/pytest -q -m "not integration"
../../.venv/bin/ruff check . && ../../.venv/bin/ruff format . && ../../.venv/bin/mypy src

Hard rules

  • This repo is public. No real names, personal contexts, private hostnames/IPs, or vault content in code, tests, fixtures, docs, or commit messages. Test data uses synthetic values (Alice Smith, example.com, homelab-traefik-style contexts). The gitleaks pre-commit hook enforces this — if it blocks a commit, fix the data; NEVER --no-verify.
  • The owner's real golden-query file lives at ~/.config/qkb/golden_queries.yaml — read/run it locally, never copy it (or its contents) into the repo.
  • The Obsidian vault is read-only. Never write into it.
  • Unit tests must pass offline (TS: no model download, no Ollama, no network — use the fake provider; Python: anything needing Ollama gets @pytest.mark.integration).
  • Don't tag releases (v*) — tagging triggers a publish (PyPI for legacy Python; npm for the TS package, Task 17) and is owner-only.

Read the full file on GitHub · 37 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.

  1. 8d ago First seen · 37 lines · 673 tokens per session scan A f2e1ef416e0b

Subscribe to this mod's changes

qkb CLAUDE.md is an instructions file published in the GitHub repository miguelarios/qkb (0 stars, last pushed 1mo ago), licensed MIT. It adds 673 tokens to every session, about $0.0034 per session on Opus 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-31.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens