okf-generator AGENTS.md

okf-generator AGENTS.md is an instructions file for Codex, OpenCode from UmairBaig8/okf-generator. It costs 713 tokens per session, scanned A, original, MIT.

A project guide for OKF Generator, a tool that scans code and builds a searchable bundle of concepts, signatures, dependencies, and callers.

In plain words
What is it for?
It helps look up code concepts, inspect their relationships, generate or update bundles, detect changes, watch files, and run the project’s test suite.
Why use it?
It directs the assistant to use the generated lookup data first, reducing the time and effort needed to understand unfamiliar source code.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

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/umairbaig8/okf-generator/agents-md
Clone the repo
git clone --depth 1 https://github.com/UmairBaig8/okf-generator

Made for: Codex, OpenCode.

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

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

Measured 6d ago against content hash 8711bbb043a3, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

okf-generator 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 6d 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 · 91 lines

How it starts

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

OKF Generator — Agent Instructions

CRITICAL RULE: Never grep source files first

BEFORE reading any source file, ALWAYS run:

okf lookup --bundle ./okf_bundle <ConceptName>

okf lookup returns the exact signature, parameters, docstring, dependencies, and callers in milliseconds. Grepping or reading source files directly is slower and gives you less information.

Quick Start

pip install -e ".[dev]"   # editable install
pytest tests/ -q           # 415 tests

Key Files

File Purpose
okf/generator.py Core scanner & bundle writer
okf/manifest.py SHA256 manifest model, change detection, rename handling
okf/update.py Incremental update pipeline
okf/watcher.py Watchdog file watcher for --watch mode
okf/manifest_scanner.py Dependency/manifest parsers (20 formats)
okf/lookup.py Concept search
okf/diff.py Bundle comparison
okf/pairs.py Training data generation
okf/cli.py CLI entry point
tests/ 415 unit tests
tests/fixtures/complex/ Multi-language test data (7 langs, 12 manifests)

Lookup patterns

# Single concept (full detail: signature, params, docstring, calls, called-by)
okf lookup --bundle ./okf_bundle ClassName

# Filter by type
okf lookup --bundle ./okf_bundle --type Class
okf lookup --bundle ./okf_bundle --type Function
okf lookup --bundle ./okf_bundle --type Dependency

# Filter by language / ecosystem
okf lookup --bundle ./okf_bundle --tag lang:python
okf lookup --bundle ./okf_bundle --tag ecosystem:npm

# All concepts from one source file
okf lookup --bundle ./okf_bundle --file path/to/file.py

# Dependencies
okf lookup --bundle ./okf_bundle --type Dependency
okf lookup --bundle ./okf_bundle --type Dependency --tag ecosystem:pip

# JSON for programmatic use
okf lookup --bundle ./okf_bundle --json <Name>

Custom Commands

  • /lookup NAME=<name>RUN okf lookup --bundle ./okf_bundle $NAME
  • /testRUN pytest tests/ -q
  • /test-mdRUN TEST.md and produce OKF_TEST_REPORT.md

Read the full file on GitHub · 91 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. 6d ago First seen · 91 lines · 713 tokens per session scan A 8711bbb043a3

Subscribe to this mod's changes

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

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

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

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

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

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

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