agentleFS

AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Best matches · from page 17Worked for most · soon
liguobaoReads credentialsAGENTS.md

ds-harness-remote

liguobao/ds-harness-remote/AGENTS.md

## RC.3 local plugin upgrade eligibility (Issue #321, 2026-11-15) 官方 `dsh-plugin-manager

3k7d agoReviewMountCreate a free account to mount
edrlabDeletes or force-pushesAGENTS.md

thorium-reader

edrlab/thorium-reader/AGENTS.md

point file `./src/renderer/library/index_reader.ts`, but also the `./src/renderer/common` and `./src/renderer/asset` folders which are shared). - RENDERER PDF: The shell command `./node_modules/.bin/webpack-cli --config webpack.config.pdf.js` can be used to check the compilation of **only

2.9k20d agoReviewMountCreate a free account to mount
wquguruAGENTS.md

harness-books

wquguru/harness-books/AGENTS.md

committed rendered images (`.png`) - `styles/`: Honkit and print styling - `exported/`: final deliverables such as `*.pdf` and `*-print.html` - `tools/book-kit/`: shared Python build/export tooling for both books Do not treat `_book/`, `_debug

2.9k7mo agoReviewMountCreate a free account to mount
BigDawnGhostAGENTS.md

wenyi

BigDawnGhost/wenyi/AGENTS.md

test_bilingual.py` | | EPUB/HTML 注释与 DOCX 样式 | `markup/` 共享标记处理;`pipeline/annotate/` 对齐;`document_styles/docx.py` 纯样式策略 | `test_annotation_aligner.py`、`test_docx.py` | | PDF | `ingest/`、`assemble/` 的 PDF 路径;`pdf_bridge/` | `test_pdf_support.py`、`test_babeldoc_bridge_client.py` | | 术语 | `glossary/` SQLite、抽取与冲突裁定 | `test_glossary

2.9k8d agoReviewMountCreate a free account to mount
crbnosAGENTS.md

carbon

crbnos/carbon/AGENTS.md

option) | | Risk register | `.claude/rules/risk-register-module.md` | | **Infrastructure** | | | File uploads, images, HEIC, MIME types, CAD formats | `packages/files/AGENTS.md` | | PDF generation | `.claude/rules/pdf-generation-patterns.md` + `packages/documents/AGENTS.md` | | Email templates (notification / transactional / broadcast design) | `.claude/rules/email-design.md` + `packages/documents/AGENTS.md` | | Printing system | `.claude/rules/printing-system.md` + `packages/printing/AGENTS.md

2.8ktodayReviewMountCreate a free account to mount
SupabaseAGENTS.md

agent-skills

supabase/agent-skills/AGENTS.md

Must not contain consecutive hyphens (`--`) - Must match the parent directory name ```yaml # Valid name: pdf-processing name: data-analysis # Invalid name: PDF-Processing # uppercase not allowed name: -pdf # cannot start

Steady2 mentions in 2 weeks

No other project uses it yet

2.8k6mo agoReviewMountCreate a free account to mount
johnfercherAGENTS.md

maroto

johnfercher/maroto/AGENTS.md

facing change. | Skill | Use when | |-------|----------| | [skills/maroto-pdf/generation.md](skills/maroto-pdf/generation.md) | Writing any Go code that generates a PDF with maroto — install, program skeleton, output, errors, checklist | | [skills/maroto-pdf/config.md](skills/maroto-pdf/config.md) | Choosing `config.NewBuilder()` options: page size

Steady14 mentions in 2 weeks

No other project uses it yet

2.8k7y agoReviewMountCreate a free account to mount
icereedAGENTS.md

paperless-gpt

icereed/paperless-gpt/AGENTS.md

Documentation ├── .github/workflows/ # CI/CD pipelines └── Dockerfile # Multi-stage Docker build ``` ## Setup and build No system PDF library is needed: PDF pages are rendered with PDFium through go-pdfium's WebAssembly runtime

2.8k52d agoReviewMountCreate a free account to mount
echonoshyAGENTS.md

cgft-llm

echonoshy/cgft-llm/AGENTS.md

extras/`:番外篇(如 B站抽奖脚本等杂项) - `assets/`:存放静态资源(如 Logo 图片等) **注意**:请勿在根目录下随意平铺新建文件夹。所有的配套代码和说明文档(`.md` 或 `.pdf`)都应归入上述对应的系列文件夹中。 ## 📄 2. README 排版规范 主页 `README.md` 的设计目标是:**极简、清晰、专业**。 ### 2.1 克制使用 Emoji - 拒绝花里胡哨,**不要使用

2.7k6mo agoReviewMountCreate a free account to mount
VercelAGENTS.md

vgpu

vercel-labs/vgpu/AGENTS.md

visual-explainer](.claude/skills/visual-explainer/SKILL.md). It defines the shared narrative and visual style for personal PDF explanations and PR descriptions composed of Markdown and small SVGs. The PR writer also reads this

Steady4 mentions in 2 weeks

No other project uses it yet

2.6k30d agoReviewMountCreate a free account to mount
K-Dense-AIReads credentialsAGENTS.md

claude-scientific-writer

K-Dense-AI/claude-scientific-writer/AGENTS.md

verifiable citations. **Default Format:** LaTeX with BibTeX citations unless otherwise requested. **Quality Assurance:** Every PDF is automatically reviewed for formatting issues and iteratively improved until visually clean and professional. **CRITICAL

Steady3 mentions in 2 weeks

No other project uses it yet

2.6k8d agoReviewMountCreate a free account to mount
poco-aiAGENTS.md

Agentero

poco-ai/Agentero/AGENTS.md

低耦合。如果系统有额外冗余可以提示用户进行重构 - 只加必要的影响性能和功能的测试代码,不加没有实际意义的测试用例。 - 尽可能能复用能力,避免重复造轮子。 - UI 优先使用上游现成组件及公开组合接口。`src/components/ui/` 的上游基础组件保持通用、可升级,不混入 ACP、Vault、PDF、业务 store、IPC 或项目专用文案;业务状态、数据转换和科研渲染放在对应业务目录,通过 props、children、hook 或 renderer 组合。升级前对比上游源码,优先删除已被上游覆盖的补丁

2.5k3d agoReviewMountCreate a free account to mount
VercelReads credentialsAGENTS.md

chat / adapter-instagram

vercel/chat/packages/adapter-instagram/AGENTS.md

most 1000 UTF-8 bytes. - Images are at most 8 MB; audio, video, and PDF files are at most 25 MB. ## Testing Mock `fetch`; unit tests must not call Meta

Steady2 mentions in 2 weeks

No other project uses it yet

2.5k34d agoReviewMountCreate a free account to mount
SConsAGENTS.md

scons

SCons/scons/AGENTS.md

from `pyproject.toml` is useful. ```bash python bin/docs-validate.py python scripts/scons.py doc SKIP_DOC=pdf,api ``` | Type | Location | Pattern | |------|----------|---------| | E2E | `test/**/*.py` | Custom `TestSCons` (subclass of `TestCmd`) with `test.run()` / `test.pass_test()` | | Unit

Steady2 mentions in 2 weeks

No other project uses it yet

2.4k5y agoReviewMountCreate a free account to mount
imfingAGENTS.md

hextra

imfing/hextra/AGENTS.md

Content Features - **Shortcodes**: `callout`, `card`, `cards`, `tabs`, `tab`, `details`, `steps`, `filetree`, `jupyter`, `badge`, `icon`, `pdf`, `include`, `asciinema`, `term` - **Code Features**: Syntax highlighting (Chroma), copy buttons, line numbers via render hooks

Steady10 mentions in 2 weeks

No other project uses it yet

2.4k2y agoReviewMountCreate a free account to mount
FrancyJGLisboaAGENTS.md

agent-skill-creator

FrancyJGLisboa/agent-skill-creator/AGENTS.md

user describes what they do — in plain English, or by handing over a PDF, a link, a script, a transcript — and this skill builds a complete, validated, security-scanned agent

2.4k2mo agoReviewMountCreate a free account to mount
deusyuAGENTS.md

translate-book

deusyu/translate-book/AGENTS.md

Calibre 7.6.0 package has an EPUB generation bug (bytes/str mismatch in `container.py`). DOCX and PDF generation work fine. This is a distro packaging issue, not a codebase bug. - `pypandoc` installs

2.4k2mo agoReviewMountCreate a free account to mount
zakirkunAGENTS.md

deep-eye

zakirkun/deep-eye/AGENTS.md

vulnerability_scanner.py` + `enabled_checks`. - Extra engine modules (dirb/port/…): `_init_extra_module_testers`. - Paths: `pathlib.Path`. PDF: ReportLab. Venv: `.deep-venv/`. ## ANTI-PATTERNS - Unauthorized targets. - Full async rewrite without dedicated Group I branch

2.3k3mo agoReviewMountCreate a free account to mount
webrtc-for-the-curiousAGENTS.md

webrtc-for-the-curious

webrtc-for-the-curious/webrtc-for-the-curious/AGENTS.md

Builds the site to `public/` directory. ### Generate PDF/EPUB Outputs The book is converted to PDF and EPUB using Pandoc. This happens automatically in CI, but for local generation: ```bash # Generate

2.3k5mo agoReviewMountCreate a free account to mount
ginlix-aiReads credentialsAGENTS.md

LangAlpha / desktop

ginlix-ai/LangAlpha/desktop/AGENTS.md

Linux autostart entry | | `src/pdf.js` | renders the calling window to a PDF the user picks a home for; allowlists the options the page may set | | `src/downloads.js` | gives a download a visible

2.3k5d agoReviewMountCreate a free account to mount
CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.