kb AGENTS.md

A repository guide for kb, a Go command-line program that builds and maintains topic-based knowledge bases. A knowledge base here is an organized collection of notes gathered from sources and indexed for search.

In plain words
What is it for?
Use it to understand kb's workflow, locate its specifications and reference code, and run the required verification commands before finishing work.
Why use it?
It explains the project's source of truth and the checks required to confirm that a change is formatted, linted, tested, built, and within its intended boundaries.

Instructions file for CodexOpenCode

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/agents-md
Clone the repo
git clone --depth 1 https://github.com/compozy/kb

Made for: Codex, OpenCode.

Per session 2,163 This file is loaded in full into every session.
When invoked 2,163 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.

ModelPer sessionOnce invoked
Fable 5 $0.02163 $0.02163
Opus 5 $0.01081 $0.01081
Sonnet 5 $0.00433 $0.00433
Haiku 4.5 $0.00216 $0.00216

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

Security

Grade A, and why

kb AGENTS.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.

AGENTS.md · 135 lines

How it starts

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

AGENTS.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.

Build Commands

make verify              # fmt -> lint -> test -> build -> boundaries
make fmt                 # gofmt over repository Go files
make lint                # golangci-lint v2
make test                # unit tests with -race via gotestsum
make test-integration    # unit + integration tests with -race and -tags integration
make build               # build ./... and bin/kb with ldflags
make deps                # go mod tidy
make help                # mage target list

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/youtube YouTube caption extraction through yt-dlp and STT providers
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 · 135 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. 2d ago First seen · 135 lines · 2,163 tokens per session scan A 66bc029a4fda

Subscribe to this mod's changes

kb AGENTS.md is an instructions file published in the GitHub repository compozy/kb (101 stars, last pushed 12d ago), licensed MIT. It adds 2,163 tokens to every session, about $0.0108 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.

Related

Other instructions, from other repositories

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,182 tokens

buildNext

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

next.js 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

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

spec-kit 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,040 tokens

langchain 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,345 tokens