Skip to main content
command CX Codex

audit-repo-docs — Claude Code command: documentation audit

The audit-repo-docs command checks repository documentation against 30 criteria and produces a scored report with prioritized fixes. It spots gaps in README files, docs structure, and automation.

CC-BY-SA-4.0 ★ 6,529 updated 2026-10-22

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/commands/audit-repo-docs.md
Open on GitHub

What audit-repo-docs does

The command scans root files, documentation folders, machine-readable resources, scripts, and examples. It then scores the repository across five areas: root files, documentation structure, machine-readable content, automation, and quality. The checks draw on patterns from the Claude Code guide.

A standard run produces a Markdown report with category scores and prioritized findings. With --generate, the command proposes creating missing files from templates, then asks for approval before making them. The scoring formula uses a maximum of 58 points and maps the result to a 0–100 scale, so compare reports using the final percentage rather than raw points.

What it helps with

  • check whether the README has a quick start and table of contents
  • find missing files in the repository root
  • assess the layout of documentation folders
  • rank documentation gaps by priority
  • propose template-based files for approval

Example prompts for the agent

  • Audit this repository's documentation and write a Markdown report: /audit-repo-docs
  • Audit the docs and propose creating missing files: /audit-repo-docs --generate

How to install audit-repo-docs

Manually: put the files in place

.claude/commands/audit-repo-docs.md

Call it with /audit-repo-docs. For all projects use ~/.claude/commands/

Questions about audit-repo-docs

How do I install audit-repo-docs in Claude Code?

Save the command as .claude/commands/audit-repo-docs.md.

What does audit-repo-docs do?

It checks repository documentation against 30 criteria and creates a scored report with prioritized recommendations. The review covers root files, documentation structure, automation, and quality.

What happens when I use --generate?

The command lists missing files and asks whether to create them. After approval, it creates the selected files from templates.

Similar slash commands

All slash commands for Writing and docs →

From the same set45

The whole set →
security-audit The security-audit command for Claude Code and Codex inspects a project alongside Claude Code settings. It checks for exposed secrets, dependency flaws, injection risks, and hook issues, then returns a score and remediation plan. CX Codex +1 ★ 6,529repo stars update-infos-release The update-infos-release command for Claude Code tracks upstream releases and syncs guide, landing page, and MCP server data; version increments are optional. CX Codex +1 ★ 6,529repo stars self-assessment The self-assessment skill for Claude Code tests your knowledge across ten Claude topics, identifies your level and gaps, then builds a learning path that respects prerequisites. CX Codex +1 ★ 6,529repo stars source-command-track-mentions source-command-track-mentions scans the web for third-party citations of the Claude Code guide or author projects and syncs confirmed links into tracking files. CX Codex +1 ★ 6,529repo stars source-command-audit-whitepapers source-command-audit-whitepapers scores every whitepaper and recap card for version freshness, FR/EN parity and metadata quality, then lists what falls short. CX Codex +1 ★ 6,529repo stars audit-whitepapers audit-whitepapers audits version gaps, French/English parity, and frontmatter metadata across Quarto whitepapers and recap cards. CX Codex +1 ★ 6,529repo stars audit-agents-skills audit-agents-skills — a command for Claude Code and Codex that audits agent, skill, and command quality in a project. Scans files, scores them against criteria (identity, prompt, validation, design), and grades production readiness. CX Codex +1 ★ 6,529repo stars Claude Code Ultimate Guide Claude Code Ultimate Guide searches the Claude Code guide and machine-readable reference indexes directly from any MCP-compatible environment. CX Codex +1 ★ 6,529repo stars

Project sponsors

Companies that keep this analytics open