Lychee: Instructions file for GitHub Copilot

.github/copilot-instructions.md

Lychee copilot-instructions.md is an instructions file for GitHub Copilot from LycheeOrg/Lychee. It costs 493 tokens per session, scanned A, original, MIT.

A set of coding rules for LycheeOrg/Lychee, a web application built with PHP and Vue 3. It covers PHP, application structure, user-interface code, and documentation.

In plain words
What is it for?
Use it when writing or reviewing PHP, TypeScript, Vue 3, application, or documentation code in Lychee. It provides rules for naming, files, components, requests, and related project conventions.
Why use it?
It helps an agent produce changes that match the project's existing style and avoid common mistakes, such as unsafe comparisons, incorrect file structure, or using the wrong UI conventions.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is The single source of truth is [docs/specs/3-reference/coding-conventions.md](../docs/specs/3-reference/coding-conventions.md). This file only holds the one-line.

About the project

Lychee is a self-hosted web application for uploading, organizing, managing, and sharing photographs. It is for people who want to run their own photo gallery and management system on a server or web space.

LycheeOrg/Lychee · 4,330 stars · on GitHub · lycheeorg.dev

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/lycheeorg/lychee/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/lycheeorg/lychee/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 493 This file is loaded in full into every session.
When invoked 493 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.00493 $0.00493
Opus 5.5 $0.00197 $0.00197
Sonnet 5.5 $0.00099 $0.00099
Haiku 4.5 $0.00049 $0.00049

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

Security

Grade A, and why

Lychee 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 · 31 lines

What it actually says

Quick Reference for GitHub Copilot

The single source of truth is docs/specs/3-reference/coding-conventions.md. This file only holds the one-line hints Copilot needs during inline completion; do not add rules here that are not in the conventions file.

PHP

  • New files start with the license header, followed by a single blank line after the opening PHP tag.
  • Variables are snake_case; PSR-4 autoloading.
  • Strict comparison (===), in_array() with true as third parameter, no empty(), only booleans in if conditions.
  • Do not duplicate code across if and else branches; extract the common part.
  • In Requests, $this->user is the requesting user; a user given by the query goes in $this->user2.
  • Resource classes extend Spatie Data, not JsonResource. No Blade views.
  • Money: moneyphp/money, stored as integers in the smallest currency unit; never floats.
  • Translations: edit only lang/<locale>/*.php. Never touch the generated lang/<locale>.json or lang/php_*.json.

Vue3 / TypeScript

  • TypeScript + Composition API; <template> first, then <script lang="ts">, then <style>.
  • axios calls live in a services/ directory and use ${Constants.getApiUrl()} as base URL.
  • v8 (resources/js/v8/): Nuxt UI components; async/await and arrow functions allowed.
  • v7 (everything else under resources/js/): PrimeVue components; .then() instead of await; function name() {} instead of const name = () => {}.

Tests

  • tests/Unit extends AbstractTestCase; tests/Feature_v2 and tests/Feature_v3 extend their own Base\BaseApiWithDataTest.
  • Do not mock the database: tests use the SQLite file database/database.sqlite and roll back via DatabaseTransactions.

Docs

  • Files under docs/ end with an hr line and *Last updated: <date>*, except version.md and files created from docs/specs/templates/.
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 Changed · -28 lines · -170 tokens per session 88c707cf4e33
  2. 1mo ago Changed · +1 lines · +13 tokens per session 0e07327bb246
  3. 2mo ago First seen · 58 lines · 650 tokens per session scan A c874f30d9dcc

Subscribe to this mod's changes

Lychee copilot-instructions.md is an instructions file published in the GitHub repository LycheeOrg/Lychee (4,330 stars, last pushed yesterday), licensed MIT. It adds 493 tokens to every session, about $0.0020 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

Lychee copilot-instructions.md compared with instructions from other repositories

Lychee copilot-instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
Lychee copilot-instructions.mdLycheeOrg/LycheeInstructions file4.3kyesterdayMITA493GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode