vibeusage AGENTS.md

Project instructions for AI assistants covering proposals, repository structure, SQLite usage, and rules for keeping a repository map up to date. It also explains when to read the project's OpenSpec instructions before coding.

In plain words
What is it for?
Use it before planning, proposing, or making changes that affect architecture, data flow, public interfaces, or multiple modules.
Why use it?
It prevents agents from missing required project guidance or crossing module boundaries without checking them. The repository map helps identify the right entry points and affected areas.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/victorgpt/vibeusage/agents-md
Clone the repo
git clone --depth 1 https://github.com/victorGPT/vibeusage

Made for: Codex, OpenCode.

Per session 2,320 This file is loaded in full into every session.
When invoked 2,320 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.02320 $0.02320
Opus 5 $0.01160 $0.01160
Sonnet 5 $0.00464 $0.00464
Haiku 4.5 $0.00232 $0.00232

Measured 2d ago against content hash 89e831d625f8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

vibeusage 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 2d 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 · 152 lines

How it starts

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

OpenSpec Instructions

These instructions are for AI assistants working in this project.

Always open @/openspec/AGENTS.md when the request:

  • Mentions planning or proposals (words like proposal, spec, change, plan)
  • Introduces new capabilities, breaking changes, architecture shifts, or big performance/security work
  • Sounds ambiguous and you need the authoritative spec before coding

Use @/openspec/AGENTS.md to learn:

  • How to create and apply change proposals
  • Spec format and conventions
  • Project structure and guidelines

Keep this managed block so 'openspec update' can refresh the instructions.

仓库站点地图规则

  • 非 trivial 变更前先阅读 docs/repo-sitemap.md,用它确定当前模块边界、入口文件与首读路径。
  • 当变更影响模块边界、跨模块数据流、公共接口、或首选入口文件时,必须同步更新 docs/repo-sitemap.md
  • 渐进式披露:先读站点地图里的顶层目录和目标模块小节,只在依赖仍不清楚时再扩大阅读范围。
  • 小改动聚焦单模块;中等改动扩展到相邻模块;跨模块/数据流改动沿着站点地图列出的路径逐步展开。

站点地图执行边界(强制 vs 可选)

强制(必须读 + 更新站点地图)

  • 架构变更或系统边界调整
  • 数据流/存储/同步路径变化
  • 公共接口或契约改变(API、事件、数据模型)
  • 跨模块耦合关系调整
  • 模块首选入口文件或作者路径变化

可选(允许跳过站点地图更新)

  • 局部 bugfix(不影响模块边界/数据流)
  • 纯文案/样式/格式类改动
  • 孤立脚本修补(不进入核心流程)

最小摩擦执行规则

  1. 变更前判断是否触发“强制”条件
  2. 触发则先读并在结束后更新 docs/repo-sitemap.md;不触发可跳过
  3. 提交信息或 PR 描述可附一句:Repo sitemap: updatedRepo sitemap: not required

SQLite 使用习惯(渐进式披露)

  • 定位顺序:先用 docs/repo-sitemap.md 缩小范围(模块/路径前缀),再用 SQLite 精确查询。
  • 查询原则:只输出最小结果集(几十/几百行以内),禁止全量导出。
  • 模板优先:使用 docs/graph/sql-templates.md 的固定 SQL,避免手写出错。
  • 目标定位:SQLite 仅负责“符号级事实定位”,输出结果再交给 AI。

OpenSpec 使用范围

  • 默认使用 skill 工作流,不强制走 OpenSpec。
  • 仅在以下“重大模块”场景触发 OpenSpec:外部集成、跨模块核心流程、DB schema 变更、安全/权限边界变化、破坏性变更。

文案规则(Copy Registry)

  • 本项目页面上所有展示文字必须来自 dashboard/src/content/copy.csv
  • 任何文案改动必须汇总到文案表,不允许在组件内新增/修改硬编码文本。
  • 文案表与项目官网内容必须双向同步:官网改动需回写文案表,文案表更新需同步到官网。

回归用例要求

  • 每次提交必须执行回归用例(至少覆盖本次变更相关路径),并记录执行命令与结果。

PR 预检与风险层门禁

  • PR 模板必须填写 Affected Modules / ContractsValidationRisk Flags;跨模块变更需附 repo sitemap evidence(更新说明或受影响小节)。
  • Risk Flags 勾选任一项,必须补全 Risk AddendumRules / InvariantsBoundary Matrix ≥ 3Evidence)。
  • 若勾选 Public exposure / share links / unauthenticated access,必须补全 Public Exposure Addendum
  • Reviewer Context 仅供 reviewer / AI 复审参考,不属于硬门禁。
  • CI 会执行 node scripts/ops/pr-risk-layer-gate.cjs;在 CI 中优先读取 live PR body,event payload 仅作为 fallback;本地可用 --body-file 预检。
  • 详细流程见 docs/ops/pr-review-preflight.md

Read the full file on GitHub · 152 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. 2d ago First seen · 152 lines · 2,320 tokens per session scan A 89e831d625f8

Subscribe to this mod's changes

vibeusage AGENTS.md is an instructions file published in the GitHub repository victorGPT/vibeusage (131 stars, last pushed 1mo ago), licensed MIT. It adds 2,320 tokens to every session, about $0.0116 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

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

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,182 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,345 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

next.js 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