docvet: Instructions file for Claude Code

CLAUDE.md

docvet CLAUDE.md is an instructions file for Claude Code from Alberto-Codes/docvet. It costs 2,149 tokens per session, scanned A, original, MIT.

A set of project instructions for docvet, a Python command-line tool that checks whether documentation strings in code are present, complete, accurate, and render correctly.

In plain words
What is it for?
Use it to install, configure, lint, type-check, test, and run docvet checks in a Python project.
Why use it?
It helps catch missing or outdated code documentation and problems that could break generated documentation sites.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is Alberto-Codes/docvet's own configuration. It tells Claude Code how to work on docvet 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 docvet configures →

Reuse

Borrowing it

Nothing to install: this file belongs to Alberto-Codes/docvet. 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/Alberto-Codes/docvet/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/Alberto-Codes/docvet

Made for: Claude Code.

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 docvet CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/alberto-codes/docvet/claude-md/github.svg)](https://agentmods.dev/instructions/alberto-codes/docvet/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/alberto-codes/docvet/claude-md"><img src="https://agentmods.dev/badge/instructions/alberto-codes/docvet/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.

agentmods 80×15 button for docvet CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/alberto-codes/docvet/claude-md"><img src="https://agentmods.dev/badge/instructions/alberto-codes/docvet/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 2,149 This file is loaded in full into every session.
When invoked 2,149 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.02149 $0.02149
Opus 5.5 $0.00860 $0.00860
Sonnet 5.5 $0.00430 $0.00430
Haiku 4.5 $0.00215 $0.00215

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

Security

Grade A, and why

docvet 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 4d 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.

CLAUDE.md · 153 lines

How it starts

The opening of the file, as written. The whole thing — 153 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.

Project Overview

docvet is a Python 3.12+ CLI tool for comprehensive docstring quality vetting. It goes beyond style linting (ruff D rules) by verifying docstrings are present, complete, accurate, and renderable for mkdocs-material + mkdocstrings workflows. Targets PyPI publication as docvet.

Build & Development

Build system: uv_build (PEP 517/518). Entry point: docvet = "docvet:main" in src/docvet/__init__.py. Published to PyPI as docvet v1.0.0.

# Install in development mode
uv sync

# With optional griffe support
uv sync --extra griffe

# With dev tools (pytest, ruff, ty)
uv sync --dev

# Run the CLI
docvet check

Commands

# Linting & formatting
uv run ruff check .            # Lint
uv run ruff check --fix .      # Lint with auto-fix
uv run ruff format .           # Format

# Type checking
uv run ty check

# Tests
uv run pytest                  # All tests
uv run pytest tests/unit       # Unit tests only (by directory)
uv run pytest -m unit           # Unit tests only (by marker)
uv run pytest -m integration    # Integration tests only (by marker)
uv run pytest -k test_name     # Single test by name
uv run pytest -m "not slow"    # Skip slow tests
uv run pytest --cov=docvet --cov-report=term-missing  # With coverage

# CLI (installed as `docvet` console script)
docvet check                   # Run all checks on git diff files
docvet check --staged          # Run checks on staged files
docvet check --all             # Run checks on entire codebase
docvet presence                # Run presence check only
docvet enrichment              # Run enrichment check only
docvet freshness               # Run freshness check only
docvet freshness --mode drift  # Run freshness drift sweep via git blame
docvet coverage                # Run coverage check only
docvet griffe                  # Run griffe compatibility check only
docvet fix                     # Scaffold missing docstring sections
docvet fix --dry-run           # Preview scaffolding without writing files
docvet config                  # Show effective configuration
docvet lsp                     # Start LSP server for editor diagnostics
docvet mcp                     # Start MCP server for AI agents

Read the full file on GitHub · 153 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. 4d ago Changed · +1 lines · +76 tokens per session fbf34016d82a
  2. 5d ago Changed · +7 lines · +199 tokens per session 29a04a936874
  3. 1mo ago Changed · +37 tokens per session 94d8499fece5
  4. 1mo ago Changed · +1 lines · +87 tokens per session 02d4b08d46d6
  5. 1mo ago First seen · 144 lines · 1,750 tokens per session scan A e9d4282bf12c

Subscribe to this mod's changes

docvet CLAUDE.md is an instructions file published in the GitHub repository Alberto-Codes/docvet (10 stars, last pushed yesterday), licensed MIT. It adds 2,149 tokens to every session, about $0.0086 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-09-03.

Related

Other instructions, from other repositories

agent-ready copilot-instructions.md

Instructions for vb-nattamai/agent-ready, covering copilot instructions — helloworld, project summary, commands, module layout and restricted paths.

vb-nattamai/agent-ready · 578 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 · 9,715 tokens

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,786 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

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).

microsoft/vscode · 2,731 tokens