avvarre: Instructions file for GitHub Copilot

.github/copilot-instructions.md

avvarre copilot-instructions.md is an instructions file for GitHub Copilot from PralhadYadawad/avvarre. It costs 687 tokens per session, scanned A, original, MIT.

Repository instructions for Avvarre, an MCP server and editor plugin that checks code against Google Style Guide rules across many languages and formats.

In plain words
What is it for?
Use them when modifying Avvarre's TypeScript and Node.js code, analyzer rules, AI clients, MCP server, plugin files, or project-memory directory.
Why use it?
They provide the project's build commands, source locations, available analysis tools, and conventions so changes fit the existing structure.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is PralhadYadawad/avvarre's own configuration. It tells GitHub Copilot how to work on avvarre 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 avvarre configures →

Reuse

Borrowing it

Nothing to install: this file belongs to PralhadYadawad/avvarre. 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/PralhadYadawad/avvarre/master/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/PralhadYadawad/avvarre

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/pralhadyadawad/avvarre/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/pralhadyadawad/avvarre/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 687 This file is loaded in full into every session.
When invoked 687 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.00687 $0.00687
Opus 5 $0.00344 $0.00344
Sonnet 5 $0.00137 $0.00137
Haiku 4.5 $0.00069 $0.00069

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

Security

Grade A, and why

avvarre 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 8d 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 · 45 lines

How it starts

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

avvarre — Copilot Instructions

Project

avvarre is an MCP server + VS Code agent plugin enforcing Google Style Guides across 21 languages/formats (Python, JS, TS, Java, Go, C++, Kotlin, Dart, Swift, ObjC, C#, Shell, R, HTML, CSS, Markdown, JSON, XML, Vimscript, Lisp, Angular). 650+ regex rules + optional AI deep review.

TypeScript, Node.js, ES modules. Build: npm run build. Run: npm start.

Key Paths

  • Rules: src/analyzer/rules/ | Engine: src/analyzer/engine.ts | Scorer: src/analyzer/scorer.ts
  • AI clients: src/ai/ | MCP server: src/server.ts | Entry: src/index.ts
  • Project memory: .avvarre/ (context.md, tasks.md, conventions.md, session-log.md)
  • Plugin: plugin/ (hooks.json, SKILL.md, agent.md, commands/)

MCP Tools

Tool Purpose
avvarre_file Full AI + regex review with fixes (regex-only fallback if no API key)
avvarre_workspace Scan directory → heatmap, trends, optional badge
list_rules Browse all 650+ rules by language
scaffold_avvarre Create .avvarre/ ecosystem
avvarre_pr PR quality gate on git diff

No API key = regex-only mode. Never crashes from missing config.

Conventions

  • Read .avvarre/conventions.md before writing code
  • Rule IDs: LANG-CATEGORY-NN (e.g., PY-EXC-01)
  • Imports use .js extensions. Max 1500 lines per file.

On Every Session End

  1. Session log — Append to .avvarre/session-log.md: ## YYYY-MM-DD with bullet changes, files modified, next steps.
  2. Task sync — Update .avvarre/tasks.md using compressed format: [x] Summary (steps: a→b→c→d) for done, [/] Summary (done: a→b | next: c→d) for partial. Never expand subtasks in the .md — the step chain IS the expansion key.
  3. Quality nudge — If source code was written or changed, end with: "Run /avvarre on changed files?"

Before Building a Feature

  • Check .avvarre/skills/ for a matching skill file (e.g., react_ui_guidelines.md, authentication_flow.md)
  • If one exists, read ONLY that skill — don't load all skills at once
  • Follow the architectural rules in that skill file while coding

Read the full file on GitHub · 45 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. 8d ago First seen · 45 lines · 687 tokens per session scan A 771856df8ea6

Subscribe to this mod's changes

avvarre copilot-instructions.md is an instructions file published in the GitHub repository PralhadYadawad/avvarre (4 stars, last pushed 12d ago), licensed MIT. It adds 687 tokens to every session, about $0.0034 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-31.

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