skills.rest
pekral
pekralCOMMUNITY
Explore all skills by this author →
Website𝕏@kral_petr_88GitHub

refresh-claude-md

Regenerate CLAUDE.md documentation to reflect the current codebase structure.

Updated Jan 6, 2023
Search Tags:#automation#documentation#onboarding#codebase#maintenance#phpstan
One-click install
npx skills add https://github.com/pekral/phpstan-rules --skill refresh-claude-md
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: refresh-claude-md
Source: https://github.com/pekral/phpstan-rules/tree/main/.claude/skills/refresh-claude-md
Command: npx skills add https://github.com/pekral/phpstan-rules --skill refresh-claude-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of documentation drift by automatically regenerating the CLAUDE.md file to reflect the current state of your codebase, ensuring that project conventions, commands, and tech stack details are always accurate.

Core Features & Use Cases

  • Automated Reconnaissance: Scans project manifests, framework fingerprints, and directory structures to detect the current tech stack and tooling.
  • Intelligent Merging: Updates auto-generated sections while strictly preserving all human-authored content and custom project rules.
  • Verification: Validates documented build and test commands to ensure they are functional and correct.

Quick Start

Use the refresh-claude-md skill to update the project CLAUDE.md file based on the current codebase structure and configuration.

Frequently Asked Questions about refresh-claude-md

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

FAQPage Schema
How do I keep CLAUDE.md documentation in sync with my codebase?▼

To keep CLAUDE.md in sync, automated reconnaissance scans project manifests and directory structures to detect the current tech stack, then intelligently merges updates while preserving human-authored content.

What is the best way to automate CLAUDE.md updates when project conventions change?▼

Automating CLAUDE.md updates requires scanning framework fingerprints and configuration files to map the current development environment, ensuring documented conventions and build commands reflect actual project structures.

Does refreshing CLAUDE.md overwrite custom project rules I wrote manually?▼

Refreshing CLAUDE.md does not overwrite manual rules; the intelligent merging process strictly preserves human-authored content and custom configurations while updating only auto-generated sections based on codebase changes.

How do I verify that build commands documented in CLAUDE.md are still functional?▼

To verify build commands in CLAUDE.md, the synchronization process validates documented build and test commands against the actual project configuration to ensure they remain functional and correct.

Can I use CLAUDE.md synchronization for projects where the tech stack evolves over time?▼

Yes, CLAUDE.md synchronization applies to software development workflows where tech stacks, build commands, or project structures evolve, requiring read access to manifests to accurately map the current environment.

Why does my CLAUDE.md file have outdated build commands after framework upgrades?▼

Your CLAUDE.md has outdated build commands due to documentation drift, which happens when project structures evolve without automatically regenerating the file to reflect the current configuration and tooling.

Related Skills

Explore More Software Engineering Skills→
skanimesh10skanimesh10

scan-to-skill

Scan project manifests and configurations to map tech stack skills and gaps.

Community
Advanced
GolferGeekGolferGeek

Quality Gates

Run npm lint, format, test, and build before commits.

Community
Advanced
garethdainegarethdaine

code-quality

Run Laravel Pint, PHPStan, and PHPUnit code quality checks.

Community
Intermediate
toilahuonggtoilahuongg
10

readme

Update README.md with documentation from codebase analysis.

Community
Basic