quail-ui: Instructions file for Codex

AGENTS.md

quail-ui AGENTS.md is an instructions file for Codex, OpenCode from quailyquaily/quail-ui. It costs 661 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for quail-ui, a Vue 3 user-interface component library. They describe its folders, commands, coding style, and testing rules.

In plain words
What is it for?
Use them when adding or changing components, icons, styles, demo pages, or build and test setup in quail-ui.
Why use it?
They give coding agents a shared set of project rules, reducing guesswork and preventing changes that conflict with the repository’s structure or checks.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is quailyquaily/quail-ui's own configuration. It tells Codex and OpenCode how to work on quail-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 quail-ui configures →

Reuse

Borrowing it

Nothing to install: this file belongs to quailyquaily/quail-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/quailyquaily/quail-ui/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/quailyquaily/quail-ui

Made for: Codex, OpenCode.

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 quail-ui AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/quailyquaily/quail-ui/agents-md"><img src="https://agentmods.dev/badge/instructions/quailyquaily/quail-ui/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 661 This file is loaded in full into every session.
When invoked 661 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.00661 $0.00661
Opus 5 $0.00331 $0.00331
Sonnet 5 $0.00132 $0.00132
Haiku 4.5 $0.00066 $0.00066

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

Security

Grade A, and why

quail-ui AGENTS.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.

AGENTS.md · 44 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

  • src/components/common: Reusable UI components, re‑exported via src/components/common/index.ts (components prefixed Q...).
  • src/components/icons: Icon components, re‑exported via src/components/icons/index.ts (prefixed QIcon...).
  • src/styles: SCSS sources; global entry src/style.scss builds to quail-ui.css.
  • src/app: Demo routes used for local/dev previews.
  • public/: Static assets for the dev server; dist/: build output (git‑ignored).
  • Config: vite.config.ts, tsconfig.json, eslintrc.cjs.

Build, Test, and Development Commands

  • pnpm install — install dependencies (Node 18+, pnpm 8 recommended).
  • pnpm dev — run Vite dev server with demo app.
  • pnpm build — type‑check (vue-tsc) and build the library to dist/.
  • pnpm build:demo — build the demo site (used by GitHub Pages).
  • pnpm preview — preview a production build locally.
  • ./build.sh — build and print SRI tags for CDN usage (uses latest git tag).

Coding Style & Naming Conventions

  • Language: TypeScript + Vue 3 SFCs; prefer <script setup lang="ts">.
  • Indentation: 2 spaces; keep lines focused and readable.
  • Components: PascalCase; UI components start with Q..., icons with QIcon....
  • Exports: Add new components/icons to their index.ts re‑exports.
  • Styles: SCSS; keep shared tokens/mixins in src/styles/; import via src/style.scss.
  • Imports: Use the @ alias for src when helpful.

Testing Guidelines

  • No formal unit test suite yet. Validate changes by adding/adjusting examples under src/app and verify with pnpm dev and pnpm preview.
  • Cover edge cases (states, sizes, accessibility) and both light/dark themes.

Commit & Pull Request Guidelines

  • Commits: Clear, scoped messages (e.g., feat: add QTextarea).
  • PRs: Include a summary, linked issues, before/after screenshots or GIFs for visual changes, and usage notes.
  • Keep PRs small and focused. Do not commit dist/; CI builds artifacts.
  • When adding components/icons, remember to update the corresponding index.ts.

Read the full file on GitHub · 44 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 First seen · 44 lines · 661 tokens per session scan A 3e67f3b765f9

Subscribe to this mod's changes

quail-ui AGENTS.md is an instructions file published in the GitHub repository quailyquaily/quail-ui (49 stars, last pushed 4mo ago), licensed Apache-2.0. It adds 661 tokens to every session, about $0.0033 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-30.

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

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

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