paper-piggy: Instructions file for Codex

AGENTS.md

paper-piggy AGENTS.md is an instructions file for Codex, OpenCode from DrinkTea905/paper-piggy. It costs 11,275 tokens per session, scanned A, original, Apache-2.0.

A project instruction file that tells a coding agent how to work on PaperPiggy, an application for managing research papers. It sets rules for research, user approval, spending, and keeping the development files separate from the installed app.

In plain words
What is it for?
It guides bug fixes, feature work, testing, and paid batch processing. It also tells the agent which project documents and folders to read and modify.
Why use it?
It prevents the agent from making costly or irreversible changes without approval, modifying the wrong copy of the application, or changing code before understanding the project.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md; mentions Codex.

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

Reuse

Borrowing it

Nothing to install: this file belongs to DrinkTea905/paper-piggy. 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/DrinkTea905/paper-piggy/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/DrinkTea905/paper-piggy

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 paper-piggy AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/drinktea905/paper-piggy/agents-md"><img src="https://agentmods.dev/badge/instructions/drinktea905/paper-piggy/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 11,275 This file is loaded in full into every session.
When invoked 11,275 The same file — it is already loaded in full.
Security scan A 1 finding. 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.11275 $0.11275
Opus 5 $0.05638 $0.05638
Sonnet 5 $0.02255 $0.02255
Haiku 4.5 $0.01128 $0.01128

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

Security

Grade A, and why

paper-piggy AGENTS.md scanned grade A with 1 finding 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 9d 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.

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

所有 `subprocess.Popen/run` 在 Windows 上必须 `pythonw.exe` + `creationflags=0x08000000`
AGENTS.md · 372 lines

How it starts

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

PaperPiggy · 论文小猪 —— AI 开发 agent 总纲

你是接手这个项目的 AI agent。这份文件是你的唯一入口。 读完它 + docs/ARCHITECTURE.md + docs/MAINTENANCE.md,你就具备了动手的全部前提。 本文件与任何其他文档冲突时,以本文件为准


0. 工作规则(最高优先级,先读这一节)

0.1 先调研,需要决策的问用户

任何涉及以下情形的动作,先给「问题 + 2~4 个选项 + 你的推荐 + 一句话理由」,等用户拍板,绝不自作主张执行:

  • 删除数据、删除文件、删除目录
  • 改动目录结构
  • 花钱(批量 LLM 调用:嵌入 1400+ 篇、期刊分级、SAC 补生成,都是真金白银)
  • 外部账号与发布(GitHub 建仓/推送/Release、密钥、云存储)
  • 产品取舍(功能怎么做、UI 怎么改、默认值定成什么)

动手之前先调研。 不要看到一个文件名就开始改;先把相关链路读通,再动。 这条规则是用户明确要求写进项目指引的,不是建议,是要求。

0.1b ★ 用户机器上装了正式版应用 —— 那个目录你只读,绝不写

用户本人在这台机器上装了 PaperPiggy 正式版,和这个开发仓库是两码事

路径 你能做什么
开发仓库(本项目) D:\Onedrive\AI\知识库应用 ✅ 读、改、跑、打包 —— 所有修复都在这里做
用户的正式安装 D:\PaperPiggy\ 👀 只读(看日志、看文件是否存在、复现问题)⛔ 绝不修改任何文件,不改代码、不改配置、不删数据、不"顺手帮他修一下"

用户反馈 bug 时的正确姿势:

  1. 需要的话,只读地去安装目录看现象(日志、文件在不在、版本号)
  2. src\ 里定位并修复
  3. 开发态build\py312\python.exe src\launcher.py)或临时目录里验证
  4. 报告修好了 —— 用户自己会去更新他的应用,不用你代劳

这是用户明确要求的:开发文件和应用文件必须分开。他要改应用文件的话,会自己在应用文件夹里另开一个项目。 (理由也很实在:你在安装目录里的任何改动,都会在他下次更新时被覆盖,而且会让「到底跑的是哪份代码」变得不可知 —— 这正是旧铁律 sync_app.ps1 时代的幽灵 bug 来源,见 §3。)

0.2 花钱前先估算并报告

批量 LLM 调用之前,先估算「多少条 × 多少 token × 什么单价 ≈ 多少钱」,报给用户,等确认。 用户用的是硅基流动(SiliconFlow)。

0.3 _archive/ 是历史,不是待办

_archive/ 下的文档全部已实施完毕,每份开头都有「⛔ 归档件·请勿执行」戳。 它们是「当时为什么这么决定」的存档。不要照着它们重跑改造。 里面有几份写着「把这份文档整段发给一个新对话并从头到尾执行」——那是给 2026 年 7 月的那次对话的,不是给你的。

全仓 grep / 搜索时排除 _archive/,否则你会在过期副本里改错文件。

0.4 报告要诚实

跑失败了就说失败并贴输出;跳过了某步就说跳过;只有真正做完并验证过,才说做完了。 不要用「应该可以」「理论上」粉饰未经验证的改动。

0.5 两条硬约束(用户 2026-07-15 明确要求,写进指引长期生效)

① 每次 push / 发 GitHub Release 前,通读面向用户的文案,清掉过期表述和修订残留。 README / CHANGELOG / release notes 会被全世界看到。改文案时别留「修一半」的痕迹—— 典型反例:(…比如 D:\PaperPiggy\,不在你的 Zotero 文库旁边)多出两个文件夹 这种 把旧错误的否定式硬塞进括号、读起来别扭的句子。发布前整体读一遍,当成新读者第一次看。

② 绝不弹终端 / 控制台黑窗。 所有 subprocess.Popen/run 在 Windows 上必须 pythonw.exe + creationflags=0x08000000 (CREATE_NO_WINDOW)。以后加任何拉起进程的新功能(更新、导出、外部工具…), 默认就得无窗。踩过:updater 的 _importable 少了这个 flag,升级时闪黑窗。

Read the full file on GitHub · 372 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. 9d ago First seen · 372 lines · 11,275 tokens per session scan A 7bf7b79f716a

Subscribe to this mod's changes

paper-piggy AGENTS.md is an instructions file published in the GitHub repository DrinkTea905/paper-piggy (2 stars, last pushed today), licensed Apache-2.0. It adds 11,275 tokens to every session, about $0.0564 per session on Opus 5. A static security scan graded it A with 1 finding (runs shell commands). 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

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens