okf-generator: Instructions file for Claude Code

CLAUDE.md

okf-generator CLAUDE.md is an instructions file for Claude Code from UmairBaig8/okf-generator. It costs 983 tokens per session, scanned A, original, MIT.

Project instructions for OKF Generator, a tool that scans codebases and creates compact, searchable knowledge bundles. The instructions describe its commands, code layout, language parsers, and enrichment options.

In plain words
What is it for?
Use them when developing OKF Generator, working on its parsers or enrichers, running its command-line tools, or checking its test suite.
Why use it?
They give an assistant the project context needed to generate bundles, look up code concepts, enrich results, and run tests correctly.

Instructions file for Claude Code

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

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

Reuse

Borrowing it

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

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 okf-generator CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/umairbaig8/okf-generator/claude-md.svg)](https://agentmods.dev/instructions/umairbaig8/okf-generator/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/umairbaig8/okf-generator/claude-md"><img src="https://agentmods.dev/badge/instructions/umairbaig8/okf-generator/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 983 This file is loaded in full into every session.
When invoked 983 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.00983 $0.00983
Opus 5 $0.00491 $0.00491
Sonnet 5 $0.00197 $0.00197
Haiku 4.5 $0.00098 $0.00098

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

Security

Grade A, and why

okf-generator 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 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.

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 · 95 lines

How it starts

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

OKF Generator

Generates OKF v0.2 knowledge bundles from codebases. 18 languages, 20 manifest formats, ~100× fewer tokens than raw source.

Quick commands

pip install -e ".[dev]"       # editable install
pytest tests/ -q               # 415 tests
okf generate ./src ./bundle    # generate bundle
okf lookup <Name>              # look up concept
okf enrich --lsp               # LSP enrichment (needs pyright on $PATH)

Architecture

okf/
├── enrich/          # Enricher contract → LspEnricher + LlmEnricher
│   ├── base.py      # Enricher ABC (start/run/stop), EnrichResult
│   ├── lsp.py       # LspEnricher — hand-rolled LSP client over stdio
│   ├── llm.py       # LlmEnricher — base/deep/security LLM modes
│   ├── _lsp_map.py  # LSP server registry (pyright, gopls, rust-analyzer, typescript)
│   └── _llm_prompts.py
├── cli.py            # 19 commands
├── generator.py      # Core scanner + bundle writer
├── linker.py          # Cross-reference pass (deps + call graph)
├── parsers/           # 18 language parsers
│   ├── base.py       # Concept dataclass + TreeSitterParser ABC
│   └── python.js go java rust ruby c cpp csharp dart kotlin php scala julia swift sql yaml
├── domains/           # Domain classification engine
├── lsp.py             # `okf lsp status|resolve|map` CLI
├── mcp_server.py      # MCP server (stdio/HTTP)
├── visualize.py       # HTML graph explorer (Cytoscape.js + tree-sitter WASM)
├── config.py          # Config from .okfconfig + env
└── pairs.py           # JSONL training pair generator

Enricher contract

class Enricher(ABC):
    def start(self, bundle_dir, concepts) -> bool    # prepare; return False to skip
    def run(self, bundle_dir, concepts) -> EnrichResult  # execute; never raise on partial failure
    def stop(self) -> None                             # always safe to call

LspEnricher and LlmEnricher both implement this. Wrapped in try/finally by run_enrich().

LSP enrichment

okf enrich --lsp                # LSP only
okf enrich --full               # LSP + LLM deep (shortcut)
okf enrich --lsp --llm          # LSP + LLM base
okf lsp status                  # table: which servers installed
okf lsp resolve file.py:42:5    # one-shot definition lookup

Read the full file on GitHub · 95 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 First seen · 95 lines · 983 tokens per session scan A 8ac29b6563c4

Subscribe to this mod's changes

okf-generator CLAUDE.md is an instructions file published in the GitHub repository UmairBaig8/okf-generator (101 stars, last pushed 1mo ago), licensed MIT. It adds 983 tokens to every session, about $0.0049 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

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