agentmods.dev

ovellum: Instructions file for Claude Code

CLAUDE.md

ovellum CLAUDE.md is an instructions file for Claude Code from oinam/ovellum. It costs 938 tokens per session, scanned A, original, MIT.

A set of instructions for working on Ovellum, an open-source documentation tool for TypeScript and JavaScript. The project combines generated API documentation with handwritten text and includes a static-site builder.

In plain words
What is it for?
Use it when maintaining Ovellum, including implementing features, fixing bugs, updating its website, and keeping its user-facing documentation accurate.
Why use it?
It gives the coding agent the repository layout, commands, responsibilities, and documentation rules needed to work consistently in that project.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md.

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

not rated 1repo 1mo ago A scan 938 tokens original MIT
View source ↗ oinam/ovellum ovellum.oss.oinam.com
Reuse

Borrowing it

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

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/oinam/ovellum/claude-md.svg)](https://agentmods.dev/instructions/oinam/ovellum/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/oinam/ovellum/claude-md"><img src="https://agentmods.dev/badge/instructions/oinam/ovellum/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 938 This file is loaded in full into every session.
When invoked 938 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.00938 $0.00938
Opus 5 $0.00469 $0.00469
Sonnet 5 $0.00188 $0.00188
Haiku 4.5 $0.00094 $0.00094

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

Security

Grade A, and why

ovellum 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 7d 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 · 70 lines

How it starts

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

CLAUDE

Ovellum is an open-source documentation tool for TypeScript and JavaScript: a merge engine that lets auto-generated API docs and hand-written prose live in the same files, plus a Jekyll-style static-site builder for purely manual docs. TypeScript monorepo, pnpm + turbo. Published package: ovellum (0.21.0, live on npm). Site: https://ovellum.oss.oinam.com.

Your role

You are the maintainer's engineering partner here — implement features, fix bugs, keep the docs and the site honest. Default to acting, then reporting; ask only when a decision is genuinely the maintainer's to make.

How this repo is laid out

  • packages/* — core (types, config schema, IR), parser, generator, merger, reader, site (the static-site builder), and cli (ovellum, the published package and version source of truth).
  • website/ — the Ovellum site itself. Config is website/ovellum.config.ts (TypeScript, so snippets paste in unescaped). Content in website/content/.
  • website/content/docs/** — the canonical, user-facing docs (CLI, config, glossary, security, guides, concepts). When a feature changes behaviour, update these.
  • docs/internal/** — maintainer-only docs. TODO.md is the onboarding entry point: read its "Current state" block first. Keepers: DESIGN.md, SITE.md, STYLES.md, DEPLOY.md (this repo's own CI wiring), FEATURES.md, ROADMAP.md (the prioritized 10x plan — features/security/usability; pick next work from here), RELEASE.md (the npm publish runbook — run top to bottom when shipping), COMPETITIVE.md (study of the leading commercial docs platform — what to adopt vs. skip; never name the competitor in shipped surfaces), TODO.md. Human-only tasks now live in the repo-root TODO.md (relocated from docs/internal/TODO-Human.md). CLI/config/glossary/security live on the site.

Commands

  • Build the site (and its package deps): npm run build:website
  • Dev the site: npm run dev:website
  • Tests: npm test (turbo, per-package vitest)
  • Real CLI commands: init, build, dev, watch, serve, check, diff, orphans, clean, mcp, upgrade. (All shipping as of 0.20.x.)
  • Orphan archive lives at .ovellum/orphans/ (never .docsmith — that's a dead former name).

Read the full file on GitHub · 70 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. 7d ago First seen · 70 lines · 938 tokens per session scan A 92059acc92f2

Subscribe to this mod's changes

ovellum CLAUDE.md is an instructions file published in the GitHub repository oinam/ovellum (1 stars, last pushed 1mo ago), licensed MIT. It adds 938 tokens to every session, about $0.0047 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-31.

documentationdocumentation-tool
Related

Other instructions, from other repositories

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

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

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

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

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

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