kindex: Instructions file for Claude Code

CLAUDE.md

kindex CLAUDE.md is an instructions file for Claude Code from jmcentire/kindex. It costs 3,212 tokens per session, scanned A, original, MIT.

Repository guidance for Kindex, a command-line knowledge graph that stores and searches conversations, projects, and other intellectual work. It lists the main commands, tests, and source files.

In plain words
What is it for?
Use it when modifying Kindex, running its full or targeted pytest test suites, checking coverage, or locating features such as search, storage, graph analysis, and snapshots.
Why use it?
It gives coding agents a reliable map of the project and repeatable commands for checking changes.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions Claude Code.

This is jmcentire/kindex's own configuration. It tells Claude Code how to work on kindex 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 kindex configures →

Reuse

Borrowing it

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

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 kindex CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/jmcentire/kindex/claude-md"><img src="https://agentmods.dev/badge/instructions/jmcentire/kindex/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,212 This file is loaded in full into every session.
When invoked 3,212 The same file — it is already loaded in full.
Security scan A 1 finding. 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.03212 $0.03212
Opus 5.5 $0.01285 $0.01285
Sonnet 5.5 $0.00642 $0.00642
Haiku 4.5 $0.00321 $0.00321

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

Security

Grade A, and why

kindex CLAUDE.md scanned grade A with 1 finding 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 9d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -s "https://registry.modelcontextprotocol.io/v0/servers?search=io.github.wandercom/kindex&version=latest" \
CLAUDE.md · 157 lines

How it starts

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

Kindex — Knowledge Graph for AI-Assisted Workflows

Kindex is a persistent knowledge graph that indexes conversations, projects, and intellectual work so that Claude Code never starts a session blind. The CLI is kin.

Running Tests

Install Python test dependencies (pip install -e ".[dev,mcp]") and Node.js 24 or newer. Node executes the modern Claude adapter contract tests; it is not a Kindex package dependency.

# All tests
pytest tests/ -v

# Specific module
pytest tests/test_cli.py -v
pytest tests/test_hooks.py -v
pytest tests/test_store.py -v

# With coverage
pytest tests/ --cov=kindex --cov-report=term-missing

The CI workflow runs full pytest with Python 3.12, Node.js 24, and .[dev,mcp] on pull requests and pushes to main. It also supports manual dispatch and reusable workflow calls. Publish to PyPI runs only on v* tag pushes and invokes CI before building and publishing. The test check must be required in branch protection to prevent merging a failing suite.

Key File Locations

Path Purpose
src/kindex/cli.py CLI entry point and all kin subcommands
src/kindex/dream.py Dream cycle: fuzzy dedup, suggestion auto-apply, domain edges
src/kindex/referent.py R0 referent binding: digest validation, staleness sweep, rebind
src/kindex/snapshots.py Pre-merge SQLite snapshots (rotating, fail-closed) to XDG state dir
src/kindex/dream_deep.py LLM-powered cluster consolidation (--deep mode only)
src/kindex/store.py SQLite + FTS5 storage layer
src/kindex/config.py Configuration loading and Config model
src/kindex/graph.py Graph analytics (centrality, communities, bridges)
src/kindex/retrieve.py Hybrid search (FTS5 + graph BFS + RRF merge)
src/kindex/extract.py Knowledge extraction from text and sessions
src/kindex/ingest.py Project and session ingestion pipeline
src/kindex/sessions.py Session tag lifecycle (start, update, segment, resume)
src/kindex/coordination.py Collab conversations (members, cursors, inject messages, resources)
src/kindex/locks.py Advisory node locks (acquire, release, expiry sweep)
src/kindex/hooks.py Claude Code hook handlers (prime, compact)
src/kindex/setup.py System setup (Claude hooks, launchd, crontab, .kin git merge driver)
src/kindex/kin_merge.py Structured 3-way union merge for .kin/index.json + .kin/code-map.json (kin merge-kin git driver)
src/kindex/daemon.py Background daemon and cron cycle
src/kindex/budget.py LLM spend tracking and budget enforcement
src/kindex/vectors.py Vector embedding, contextual chunk indexing, reindex maintenance, and similarity search
src/kindex/vault.py Markdown vault import/export
src/kindex/models.py Core data models
src/kindex/schema.py Database schema and migrations
src/kindex/llm.py LLM provider abstraction
tests/ All tests (pytest)
~/.kindex/ Default data directory (SQLite DB, logs)
~/.config/kindex/kin.yaml User config
.kin/config Git-tracked project context and optional work policy
.kin/index.json Git-tracked project graph snapshot generated by kin index
.kin/code-map.json Git-tracked repo code map generated by kin export code-map
.gitattributes Points .kin/index.json + .kin/code-map.json at the merge=kindex driver (auto-written by kin index)

Read the full file on GitHub · 157 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. 9d ago Changed · +38 lines · +832 tokens per session c76febf6c2d2
  2. 2mo ago First seen · 119 lines · 2,380 tokens per session scan A d483dee7a9fe

Subscribe to this mod's changes

kindex CLAUDE.md is an instructions file published in the GitHub repository jmcentire/kindex (1 stars, last pushed 9d ago), licensed MIT. It adds 3,212 tokens to every session, about $0.0128 per session on Opus 5.5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

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 · 9,715 tokens

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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens