What is awesome-copilot-index copilot-instructions.md?

Project instructions for Awesome Copilot Index, a pipeline that collects GitHub repository content and publishes it as searchable website data. It also covers the project's editor integration and development workflow.

Use it when changing the build pipeline, Markdown parsing, generated JSON or EDN indexes, Jekyll site, or ClojureScript editor integration.

It gives an agent the project's architecture and the expected steps for downloading, parsing, indexing, and publishing content, reducing mistakes during development.

How PEZ/awesome-copilot-index configures GitHub Copilot

Reuse

Borrowing it

Nothing to install: this file belongs to PEZ/awesome-copilot-index. 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/PEZ/awesome-copilot-index/master/.github/copilot-instructions.md

Clone the repo

git clone --depth 1 https://github.com/PEZ/awesome-copilot-index

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/pez/awesome-copilot-index/copilot-instructions/github.svg)](https://agentmods.dev/instructions/pez/awesome-copilot-index/copilot-instructions)

Your own site

<a href="https://agentmods.dev/instructions/pez/awesome-copilot-index/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/pez/awesome-copilot-index/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/pez/awesome-copilot-index/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/pez/awesome-copilot-index/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,119 This file is loaded in full into every session.

When invoked 2,119 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.

Model	Per session	Once invoked
Fable 5.1	$0.02119	$0.02119
Opus 5.5	$0.00848	$0.00848
Sonnet 5.5	$0.00424	$0.00424
Haiku 4.5	$0.00212	$0.00212

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

Security

Grade A, and why

awesome-copilot-index 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 2mo 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 · 169 lines

How it starts

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

Copilot Instructions for Awesome Copilot Index

Project Architecture

This project is a multi-stage content indexing pipeline that downloads, parses, and publishes GitHub repository content. The architecture consists of:

Content Extraction: Downloads GitHub repos as ZIP files (not git clones) to avoid history
Markdown Parsing: Parses frontmatter and content using custom trimming logic for edge cases
Index Generation: Transforms raw markdown into structured JSON/EDN for consumption
Jekyll Publishing: Renders a searchable web interface with responsive CSS
VS Code Integration: Provides ClojureScript-based Joyride script for in-editor access

Key Data Flow: GitHub ZIP → Babashka Parser → JSON/EDN Index → Jekyll Site → Joyride Menu

Always show what you evaluate in the repl to the user, using a codeblock that starts with the namespace in a (in-ns ...) form.

Critical Workflows

Main Build Pipeline

bb download-awesome        # Downloads awesome-copilot repo as ZIP
bb generate-index         # Parses markdown, generates site/awesome-copilot.{json,edn}
bb download-cursorrules   # Downloads awesome-cursorrules repo
bb generate-cursorrules-index  # Generates cursor rules index

Development REPL Workflow

(in-ns 'pez.index)
(require 'pez.index :reload)
;; Test parsing with problematic content
(def test-content "---\ntitle: test\n---  \n\n# Content")
(parse-markdown-file test-content)

Jekyll Site Generation

Templates use Selmer syntax: {{instruction-count}}, {{formatted-date}}
Site builds from site/ directory with generated JSON/EDN indices
CSS supports both ul (bullet) and ol (numbered) lists with blue styling

Development Template Workflow

When editing site/index-template.md during development:

Edit the template file: Make changes to site/index-template.md
Regenerate index: Run bb generate-index to process template with real data
Jekyll auto-reload: Jekyll's live reload automatically picks up the generated index.md changes

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

2mo ago First seen · 169 lines · 2,119 tokens per session scan A af5b199e1aef

Subscribe to this mod's changes

awesome-copilot-index copilot-instructions.md is an instructions file published in the GitHub repository PEZ/awesome-copilot-index (4 stars, last pushed 8mo ago), licensed MIT. It adds 2,119 tokens to every session, about $0.0085 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-31.

copilot vscode

awesome-copilot-index copilot-instructions.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
awesome-copilot-index copilot-instructions.mdPEZ/awesome-copilot-index	Instructions file	4	8mo ago	MIT	A	2,119	GitHub Copilot
plan-forge dapr.instructions.mdsrnichols/plan-forge	Instructions file	6	2d ago	MIT	A	4,975	GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot

awesome-copilot-index: Instructions file for GitHub Copilot