create-or-audit-claude-md

Audit or generate CLAUDE.md files from codebase evidence.

9|2|Updated Nov 29, 2024
One-click install
npx skills add https://github.com/bbvch-ai/aihub-core --skill create-or-audit-claude-md
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-or-audit-claude-md
Source: https://github.com/bbvch-ai/aihub-core/tree/main/.claude/skills/create-or-audit-claude-md
Command: npx skills add https://github.com/bbvch-ai/aihub-core --skill create-or-audit-claude-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

CLAUDE.md files for AI coding assistants are often written from memory, outdated, or filled with generic rules that don't match a project's actual conventions, leading to incorrect AI suggestions and wasted time for engineering teams.

Core Features & Use Cases

  • Codebase Evidence Analysis: Scans configuration files, CI/CD pipelines, git history, code patterns, and existing documentation to extract real, enforced project conventions.
  • Dual Mode Operation: Either audits an existing CLAUDE.md for inaccuracies, gaps, and stale content, or builds a new one from scratch that reflects the project's true workflows.
  • Use Case: A team onboarding Claude Code to a new monorepo can use this skill to generate a CLAUDE.md that captures their actual build commands, directory structure, and code quality rules instead of manually writing an incomplete file.

Quick Start

Use the create-or-audit-claude-md skill to audit the root CLAUDE.md of this repository and produce a prioritized list of missing conventions, suggested revisions, and companion tooling recommendations.

Frequently Asked Questions about create-or-audit-claude-md

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a CLAUDE.md file from my existing codebase conventions?

To generate a CLAUDE.md from your codebase, scan configuration files, CI/CD pipelines, git history, and code patterns to extract verified project conventions. This ensures the generated file reflects actual enforced tooling, build commands, and directory structure rather than manual assumptions.

Why does my AI coding assistant give incorrect suggestions for my project?

AI coding assistants give incorrect suggestions when your CLAUDE.md file is outdated or contains generic rules that don't match actual project conventions. Auditing the file against real codebase evidence fixes gaps and removes stale content that misleads the AI.

Can I audit an existing CLAUDE.md file for inaccuracies and missing conventions?

Yes, you can audit an existing CLAUDE.md for inaccuracies by comparing it against verified codebase evidence like configuration files and CI/CD pipelines. This produces a prioritized list of missing conventions, suggested revisions, and companion tooling recommendations.

What should I include in a CLAUDE.md file for Claude Code onboarding?

A CLAUDE.md for Claude Code onboarding should include universal build/test commands, directory structure, and non-standard code conventions extracted from real codebase evidence. It must avoid duplicating content already enforced by linters, formatters, or CI checks.

Does this work for generating AI context files for a monorepo?

Yes, this works for generating AI context files for a monorepo by scanning the full project to capture actual build commands, directory structure, and code quality rules. It replaces manually writing an incomplete file with a verified, project-specific context.

When should I not use a CLAUDE.md file for AI coding context?

You should not use a CLAUDE.md file to document conventions that are already enforced by linters, formatters, or CI checks. Duplicating automated checks creates stale content; the file should only capture non-standard rules and universal build commands not enforced elsewhere.