okf-generator: Instructions file for GitHub Copilot

.github/copilot-instructions.md

okf-generator copilot-instructions.md is an instructions file for GitHub Copilot from UmairBaig8/okf-generator. It costs 481 tokens per session, scanned A, original, MIT.

Project instructions for using an OKF knowledge bundle, a generated set of documentation files describing code concepts and their relationships.

In plain words
What is it for?
They help retrieve details for one concept, a whole source file, or code filtered by type, programming language, or package ecosystem.
Why use it?
They require looking up documented functions, classes, and dependencies before reading source files, which gives agents structured context for the codebase.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is UmairBaig8/okf-generator's own configuration. It tells GitHub Copilot 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/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/UmairBaig8/okf-generator

Made for: GitHub Copilot.

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 copilot-instructions.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/umairbaig8/okf-generator/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/umairbaig8/okf-generator/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 481 This file is loaded in full into every session.
When invoked 481 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.00481 $0.00481
Opus 5.5 $0.00192 $0.00192
Sonnet 5.5 $0.00096 $0.00096
Haiku 4.5 $0.00048 $0.00048

Measured 1mo ago against content hash 5af289a9f016, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

okf-generator copilot-instructions.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 1mo 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.

.github/copilot-instructions.md · 59 lines

What it actually says

OKF Knowledge Bundle — Copilot Instructions

CRITICAL RULE: Never read source files directly for context

This project uses okf-generator to produce an OKF v0.2 knowledge bundle at ./okf_bundle/. The bundle contains structured markdown files — one per function, class, module, and dependency.

BEFORE reading or editing any source file, you MUST run:

okf lookup --bundle ./okf_bundle <ConceptName>

This returns signature, parameters, docstring, dependencies, callers, and callees in milliseconds — faster and more accurate than reading the source file.

Common lookups

# Single concept full detail
okf lookup --bundle ./okf_bundle ClassName

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

# 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
okf lookup --bundle ./okf_bundle --tag lang:python
okf lookup --bundle ./okf_bundle --tag lang:typescript
okf lookup --bundle ./okf_bundle --tag lang:go

# Filter by ecosystem
okf lookup --bundle ./okf_bundle --tag ecosystem:pip
okf lookup --bundle ./okf_bundle --tag ecosystem:npm
okf lookup --bundle ./okf_bundle --tag ecosystem:cargo

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

# Dependencies (all or by ecosystem)
okf lookup --bundle ./okf_bundle --type Dependency
okf lookup --bundle ./okf_bundle --type Dependency --tag ecosystem:pip --compact

Seeing what changed between bundles

okf diff ./okf_bundle.bak ./okf_bundle --compact
okf diff ./okf_bundle.bak ./okf_bundle --json

Bundle location

  • Default: ./okf_bundle/
  • Also checked: ./Knowlege/okf_bundle/, ./knowledge/okf_bundle/
  • okf-generator README
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. 1mo ago First seen · 59 lines · 481 tokens per session scan A 5af289a9f016

Subscribe to this mod's changes

okf-generator copilot-instructions.md is an instructions file published in the GitHub repository UmairBaig8/okf-generator (110 stars, last pushed 2mo ago), licensed MIT. It adds 481 tokens to every session, about $0.0019 per session on Opus 5.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 · 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,581 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

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 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,731 tokens