What is kb CLAUDE.md?

A project instruction document for compozy/kb, a Go command-line program that builds and maintains topic-based knowledge bases. It defines the project overview, source-of-truth files, rules, commands, and package layout.

Use it when working on the kb codebase, especially for locating specifications, following dependency rules, and running formatting, linting, tests, builds, and boundary checks.

It gives coding agents a shared description of the project and its required verification process before changing code.

kb CLAUDE.md — Instructions file by compozy

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add instructions/compozy/kb/claude-md

Clone the repo

git clone --depth 1 https://github.com/compozy/kb

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

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

Security scan A 0 findings. Scan, not verified.

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	$0.01899	$0.01899
Opus 5	$0.00949	$0.00949
Sonnet 5	$0.00380	$0.00380
Haiku 4.5	$0.00190	$0.00190

Measured 2d ago against content hash 26492af08a28, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

kb 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 2d 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 · 111 lines

How it starts

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

CLAUDE.md

Project Overview

kb is a single-binary Go CLI for building and maintaining topic-based knowledge bases in the Karpathy KB pattern. It handles the non-LLM workflow: topic scaffolding, multi-source ingestion, structural linting, codebase analysis, QMD indexing/search, and KB-oriented inspection commands.

Reference TypeScript source: ~/dev/projects/kodebase

Source of Truth

KB pivot tech spec: .compozy/tasks/kb-pivot/_techspec.md
KB pivot task tracker: .compozy/tasks/kb-pivot/_tasks.md
KB pivot workflow memory: .compozy/tasks/kb-pivot/memory/

Critical Rules

make verify is the non-negotiable completion gate: fmt -> lint -> test -> build -> boundaries.
make lint must report zero findings.
Use go get for dependency changes.
Never use destructive git restore/reset/checkout/clean/rm commands without explicit approval.
Prefer local repository inspection over web search for codebase questions.

Active Build Surface

make verify
make fmt
make lint
make test
make test-integration
make build
make deps
make help

make build compiles ./... and writes bin/kb from cmd/kb.

Active Package Layout

Path	Responsibility
`cmd/kb`	Program entrypoint for the `kb` binary
`internal/cli`	Cobra root, subcommands, flag resolution, and command I/O
`internal/topic`	Topic scaffolding, listing, and topic metadata lookup
`internal/ingest`	Ingest orchestration, frontmatter assembly, raw writes, and log entries
`internal/convert`	Converter registry and format-specific file converters
`internal/firecrawl`	Firecrawl REST client for `kb ingest url`
`internal/mediadl`	Shared `yt-dlp` + STT engine: audio/caption download, ffmpeg segmentation, and transcript extraction reused by `youtube` and `instagram`
`internal/youtube`	YouTube URL parsing, channel/bulk ingestion, and frontmatter over the `mediadl` core
`internal/instagram`	Instagram reel/video URL parsing and caption+transcript composition over the `mediadl` core
`internal/frontmatter`	Shared frontmatter parsing and generation helpers
`internal/lint`	KB structural lint engine and report rendering
`internal/generate`	Codebase-to-KB pipeline used by `kb ingest codebase` and the hidden legacy `generate` alias
`internal/scanner`	Source discovery and ignore handling for codebase ingest
`internal/adapter`	Tree-sitter parsing adapters
`internal/graph`	Graph normalization for codebase snapshots
`internal/metrics`	File, symbol, directory, and smell metrics
`internal/vault`	Topic path helpers, render/write logic, vault reads, and inspect snapshot loading
`internal/qmd`	QMD subprocess integration for index and search
`internal/output`	Table, JSON, and TSV formatting
`internal/models`	Shared domain models and interfaces
`internal/config`	TOML config plus env-backed runtime overrides
`internal/logger`	Slog logger setup
`internal/version`	Build metadata surfaced by `kb version`

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

2d ago First seen · 111 lines · 1,899 tokens per session scan A 26492af08a28

Subscribe to this mod's changes

kb CLAUDE.md is an instructions file published in the GitHub repository compozy/kb (102 stars, last pushed 12d ago), licensed MIT. It adds 1,899 tokens to every session, about $0.0095 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-30.

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

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

kb CLAUDE.md