Borrowing it
Nothing to install: this file belongs to z29k/notabene. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/z29k/notabene/main/CLAUDE.mdgit clone --depth 1 https://github.com/z29k/notabeneWrote 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.
[](https://agentmods.dev/instructions/z29k/notabene/claude-md)<a href="https://agentmods.dev/instructions/z29k/notabene/claude-md"><img src="https://agentmods.dev/badge/instructions/z29k/notabene/claude-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.
<a href="https://agentmods.dev/instructions/z29k/notabene/claude-md"><img src="https://agentmods.dev/badge/instructions/z29k/notabene/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.11781 | $0.11781 |
| Opus 5.5 | $0.04712 | $0.04712 |
| Sonnet 5.5 | $0.02356 | $0.02356 |
| Haiku 4.5 | $0.01178 | $0.01178 |
Grade A, and why
notabene CLAUDE.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 16d 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.
How it starts
The opening of the file, as written. The whole thing — 599 lines — stays where its author put it; the contents beside it link to each section on GitHub.
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
What this is
notabene renders a repo's Markdown/MDX as a navigable site with Google-Docs-style commenting, and ships a human↔agent review protocol that turns those comments into edits. The viewer is the support; the protocol (the review skill) is the product.
Two installable pieces, one npm workspace:
packages/renderer— the@z29k/notabenenpm package: a generic Astro renderer- the
notabeneCLI (init/dev/build/preview/pdf/lint, plusdoctor/status/stop/migrate/comments/journal). Published to npm.
- the
packages/claude-plugin— the Claude Code plugin (3 skills + a forwarder). The canonical protocol lives indocs/(it is documentation, not a hidden artifact); the plugin skills and the npm-shipped copy are generated from it — see Architecture: the protocol is generated below.
Dogfood: this repo is also its own consumer — docs/ holds the user documentation
(two spaces, guide + reference), wired by the root notabene.config.mjs (store at
docs/.notabene, review: "approve"). .github/workflows/docs.yml publishes it to
GitHub Pages (z29k.github.io/notabene) on push to main via build --public. Review it
locally with node packages/renderer/bin/notabene.mjs dev --root .. The three READMEs
are short landings; the docs site is the single source of user-facing detail — update
docs/, not the READMEs, when documenting features.
Commands
Everything runs against a consumer repo (see run-from-package model below), so the CLI is never invoked bare in this repo. Develop and validate against a scratch consumer:
npm install # installs the renderer's deps (workspace root)
# Quality gates (run in packages/renderer — these are what CI enforces):
cd packages/renderer
npm test # Vitest — pure-logic unit tests (test/*.test.ts)
npm run lint # Biome — lint + format check on bin/src/test (JS/TS; .astro/.css excluded)
npm run format # Biome — apply formatting
NOTABENE_ROOT=/tmp/nb-scratch NOTABENE_CONFIG=/tmp/nb-scratch/notabene.config.mjs \
npm run check # astro check — type-checks .astro + .ts (needs a consumer via env)
# Point the CLI at a throwaway consumer repo (run-from-package):
mkdir -p /tmp/nb-scratch/docs && printf '# Hi\n' > /tmp/nb-scratch/docs/index.md
node bin/notabene.mjs init --root /tmp/nb-scratch # writes notabene.config.mjs + .notabene store
node bin/notabene.mjs dev --root /tmp/nb-scratch # review server → http://localhost:3009
node bin/notabene.mjs build --root /tmp/nb-scratch # verification build — must complete with 0 errors
node bin/notabene.mjs build --root /tmp/nb-scratch --public --site https://example.com \
--out /tmp/nb-public # public read-only static artifact (llms.txt, .md twins)
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.
- 16d ago Changed · +7 lines · +128 tokens per session d03cdbb3cd23
- 23d ago Changed · +45 lines · +856 tokens per session 703921cdba55
- 1mo ago First seen · 547 lines · 10,797 tokens per session scan A a2ffd005766f
notabene CLAUDE.md is an instructions file published in the GitHub repository z29k/notabene (5 stars, last pushed 17d ago), licensed MIT. It adds 11,781 tokens to every session, about $0.0471 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-31.
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).
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.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
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.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).
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.