frappe-ui: Instructions file for GitHub Copilot

.github/copilot-instructions.md

frappe-ui copilot-instructions.md is an instructions file for GitHub Copilot from frappe/frappe-ui. It costs 653 tokens per session, scanned A, original, MIT.

Coding rules for frappe-ui, a Vue 3 component library used to build interfaces for Frappe applications. They explain which project documents to read and how to design components and their public interfaces.

In plain words
What is it for?
Use them when changing Vue components, public component properties or events, styling tokens, documentation-driven specifications, or release-related code in frappe-ui.
Why use it?
They help keep library changes compatible and consistent, instead of introducing undocumented APIs, fragile styling hooks, or broad rewrites.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: reads .claude/ paths.

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

About the project

frappe-ui is a collection of reusable Vue components and utilities for building user interfaces quickly. It is for developers creating interfaces with Frappe and Vue.

frappe/frappe-ui · 1,082 stars · on GitHub · ui.frappe.io

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/frappe/frappe-ui/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/frappe/frappe-ui/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 653 This file is loaded in full into every session.
When invoked 653 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.00653 $0.00653
Opus 5.5 $0.00261 $0.00261
Sonnet 5.5 $0.00131 $0.00131
Haiku 4.5 $0.00065 $0.00065

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

Security

Grade A, and why

frappe-ui 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 10d 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 · 56 lines

How it starts

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

frappe-ui Copilot instructions

frappe-ui is a Vue 3 component library and utilities package for Frappe-based apps. Treat it as a reusable library, not an app codebase.

Read order

  1. CONTEXT.md — repo map and shared vocabulary.
  2. PHILOSOPHY.md — API design rules.
  3. spec/README.md — current specs and ADR index.
  4. The relevant spec/*.md file before changing public component APIs.
  5. v1-release/README.md for release execution, migration, changelog, and research.

If docs conflict, prefer:

spec/*.md > accepted ADRs > PHILOSOPHY.md > CONTEXT.md > v1-release research/plan

Working rules

  • Preserve backwards compatibility unless a spec explicitly calls for a breaking v1 change or deprecation path.
  • Prefer small, focused changes over broad rewrites.
  • New or modernized Vue components should use TypeScript and <script setup lang="ts">.
  • Public component APIs need typed props/emits/slots/exposed surfaces and useful JSDoc.
  • Use semantic Tailwind tokens (surface-*, ink-*, outline-*) instead of hardcoded colors.
  • Prefer stable styling hooks (data-slot, data-state, data-size, data-variant, data-disabled) over DOM/class assumptions.
  • Accessibility, keyboard behavior, focus management, and ARIA semantics are part of done.
  • Update docs, stories, tests, and migration notes when public behavior changes. Add a changeset as described in .claude/skills/changeset/SKILL.md.

Component API rules

Follow PHILOSOPHY.md and the relevant spec.

Area-specific pointers

Read the full file on GitHub · 56 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. 10d ago Changed · +32 tokens per session cbc63b8b06f4
  2. 1mo ago First seen · 56 lines · 621 tokens per session scan A 091bf4fd7f38

Subscribe to this mod's changes

frappe-ui copilot-instructions.md is an instructions file published in the GitHub repository frappe/frappe-ui (1,082 stars, last pushed 2d ago), licensed MIT. It adds 653 tokens to every session, about $0.0026 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,649 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,384 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

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

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens