rules-generator

A codebase documentation generator that creates `.claude/rules/` files describing a project's structure, technologies, patterns, and commands.

In plain words
What is it for?
Use it to document a project's architecture, technology stack, coding patterns, and build, test, or run commands.
Why use it?
It gives an agent written guidance when starting work in an unfamiliar project, so the developer does not have to explain the codebase from scratch.

Skill for Claude CodeCodex

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 skills/drag88/claude-dev-framework/rules-generator
Any agent
npx skills add drag88/claude-dev-framework --skill rules-generator
Clone the repo
git clone --depth 1 https://github.com/drag88/claude-dev-framework

Made for: Claude Code, Codex.

Per session 17 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 664 The whole file, excluding the scripts and references it only reads on demand.
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.00017 $0.00664
Opus 5 $0.00009 $0.00332
Sonnet 5 $0.00003 $0.00133
Haiku 4.5 $0.00002 $0.00066

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

Security

Grade A, and why

rules-generator 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.

skills/rules-generator/SKILL.md · 60 lines

How it starts

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

Rules Generator Skill

Auto-generate .claude/rules/ documentation for any codebase.

When to Activate

  • No .claude/rules/ directory exists in the current project
  • User asks about codebase structure or architecture
  • User asks "what does this project do"
  • Starting work on an unfamiliar codebase
  • User explicitly asks to generate rules

Actions

  1. Load rulebook: Read rules-templates/claudemd-rulebook.md (vendored into CDF) as the authoritative reference for rule framing (positive imperatives, explicit scope, why-statements, neutral tone). Falls back to the embedded principles in this file only if the rulebook is missing.

  2. Explore codebase using the Explore agent to understand:

    • Directory structure and key files
    • Tech stack (languages, frameworks, libraries)
    • Architectural patterns and conventions
    • Build/test/run commands
  3. Generate .claude/rules/ files with YAML frontmatter on every file:

    • architecture.md — Directory structure, key files, component relationships, data flow. Frontmatter: description: only (loads broadly).
    • tech-stack.md — Languages, frameworks, libraries with purposes. Frontmatter: description: only.
    • patterns.md — Architectural patterns, code conventions, error handling. Frontmatter: description: + paths: scoped to source dirs (e.g. ["src/**", "lib/**"]).
    • commands.md — Setup, build, test, lint, run commands. Frontmatter: description: only.
    • Project-type files (api-conventions.md, component-conventions.md, etc.) — Always include paths: scoped to the relevant directory glob so they only load when matching files are touched.
  4. Frame rules as positive imperatives, with explicit scope and the why where non-obvious. Example: "Apply to every API route, including admin routes. Reason: centralized auth check." Avoid CAPS, MUST, CRITICAL, "ANY", "ALWAYS".

  5. Confirm completion with a summary listing each generated file, its line count, and whether it is path-scoped or always-loaded.

Read the full file on GitHub · 60 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 · 60 lines · 17 tokens per session scan A e8b50ac234d4

Subscribe to this mod's changes

rules-generator is a skill published in the GitHub repository drag88/claude-dev-framework (2 stars, last pushed 1mo ago), licensed MIT. It adds 17 tokens to every session and 664 once invoked, about $0.0001 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.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

agent-host-chat-contributions

Build and review cross-cutting agent-host chat behavior through lifecycle contributions. Use when adding turn lifecycle side effects, prompt or context injection, restored-history transformation, protocol-action observation, or when reviewing changes that add code to AgentSideEffects or AgentService.

microsoft/vscode · 56 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens