agentready: Instructions file for Claude Code

CLAUDE.md

agentready CLAUDE.md is an instructions file for Claude Code from makalin/agentready. It costs 508 tokens per session, scanned C, original, MIT.

A repository guide that gives AI agents an overview of a TypeScript project. It records the project files, package manager, source layout, build and test setup, and whether the repository uses a monorepo, meaning several packages managed together.

In plain words
What is it for?
Use it to find likely entry files, inspect TypeScript settings, understand the package structure, check deployment-related files, and locate the README.
Why use it?
It saves time spent searching through the repository before making changes. It also makes missing tools or configuration visible, such as the absence of tests, bundling tools, or continuous-integration workflows.

Instructions file for Claude Code

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

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

Not installable: its command points at a path on the author’s own machine, so it runs nowhere else. The line is /Users/makalin/Public/htdocs/agentready.

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/makalin/agentready/claude-md"><img src="https://agentmods.dev/badge/instructions/makalin/agentready/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 508 This file is loaded in full into every session.
When invoked 508 The same file — it is already loaded in full.
Security scan C 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.00508 $0.00508
Opus 5.5 $0.00203 $0.00203
Sonnet 5.5 $0.00102 $0.00102
Haiku 4.5 $0.00051 $0.00051

Measured 2mo ago against content hash 328e79d5a179, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade C, and why

agentready CLAUDE.md scanned grade C 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 2mo 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.

Recursive force deletehighDestructive command

rm -rf with a variable or a broad path is one typo away from removing the wrong tree.

| `npm run clean` | rm -rf dist |
CLAUDE.md · 89 lines

How it starts

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

agentready — agent context

Overview

High-fidelity repository context for AI agents — generates CLAUDE.md and CONTRIBUTING.md from your codebase.

Stack & tooling

  • TypeScript (tsconfig present)

Repository landmarks

  • Root: /Users/makalin/Public/htdocs/agentready
  • Nearest package.json: package.json
  • TypeScript config: tsconfig.json
  • ESLint: none detected
  • Prettier: none detected

Top-level directories

  • src/

Likely entry / index files (sample)

src/index.ts

Source files by extension

  • .ts: 16 file(s)

Total scanned source files: 16

Shipping, CI, and environments

Package manager

npm — install with npm install

Monorepo

No (single package at root, or no workspaces field).

Continuous integration (GitHub Actions)

No GitHub Actions workflows under .github/workflows.

Containers

No Dockerfile or compose files matched common path patterns.

Environment templates

No .env.example / .env.sample files detected.

Quality and build tooling

No common test or bundler packages detected in package.json dependencies.

  • README: README.md

TypeScript compiler options (summary)

  • strict: true
  • module: commonjs
  • target: ES2022

Commands agents should use

Use the project’s real scripts where they exist:

Script Command
npm run build tsc
npm run agentready node dist/cli.js
npm run clean rm -rf dist
npm run prepack npm run build

Guardrails for agents

  • Prefer existing patterns, naming, and folder layout over new conventions.
  • Run the test and lint scripts from package.json after non-trivial edits when those scripts exist.
  • Do not commit secrets, .env files, or credentials.
  • Respect .gitignore; generated folders like node_modules and dist are out of scope unless the task explicitly requires them.

Generated by AgentReady. Re-run agentready build after major structural changes.

Read the full file on GitHub · 89 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. 2mo ago First seen · 89 lines · 508 tokens per session scan C 328e79d5a179

Subscribe to this mod's changes

agentready CLAUDE.md is an instructions file published in the GitHub repository makalin/agentready (2 stars, last pushed 7mo ago), licensed MIT. It adds 508 tokens to every session, about $0.0020 per session on Opus 5.5. A static security scan graded it C with 1 finding (recursive force delete). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

agentready CLAUDE.md compared with instructions from other repositories

agentready CLAUDE.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
agentready CLAUDE.mdmakalin/agentreadyInstructions file27mo agoMITC508Claude Code
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
vscode model-prompts.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA2,022GitHub Copilot