skills.rest
munlucky
munluckyCOMMUNITY
Explore all skills by this author →
GitHub

project-md-refresh

Generate and update PROJECT.md from repository structure and config files.

Updated Jan 8, 2026
Search Tags:#automation#workflow#devops#documentation#repo-analysis#project-md
One-click install
npx skills add https://github.com/munlucky/claude-settings --skill project-md-refresh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-md-refresh
Source: https://github.com/munlucky/claude-settings/tree/main/.claude/skills/project-md-refresh
Command: npx skills add https://github.com/munlucky/claude-settings --skill project-md-refresh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

This skill automates the creation and updating of the PROJECT.md file to reflect the current repository, ensuring documentation stays accurate as code and structure evolve.

Core Features & Use Cases

  • Generate an evidence-based overview (name, stack, language) from repository signals.
  • Infer directory structure, API patterns, auth details, and recommended dev/build commands.
  • Update or create .claude/PROJECT.md using existing templates in assets when missing.

Quick Start

Run the project-md-refresh skill to analyze the repository and refresh .claude/PROJECT.md.

Frequently Asked Questions about project-md-refresh

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

FAQPage Schema
How do I keep PROJECT.md documentation in sync with my repository?▼

To keep PROJECT.md in sync, use project-md-refresh to automatically scan config files, project docs, and directory structure. It updates the documentation to accurately reflect the current repository state.

How do I generate an overview of my project's stack and directory structure?▼

Generate an evidence-based overview of your project stack by scanning repository signals. This process extracts the project name, language, API patterns, and authentication details into a structured documentation format.

Can I automatically infer dev, build, and lint commands for my repository?▼

Yes, you can automatically infer recommended dev, build, lint, test, and typecheck commands. The tool analyzes your repository config files to capture and document these commands in a structured format.

Does project-md-refresh work if my repository is missing PROJECT.md?▼

Yes, project-md-refresh works if PROJECT.md is missing. It creates the .claude/PROJECT.md file using existing templates in assets, applying when documentation is completely missing or currently outdated.

What is the best way to automate project documentation updates?▼

The best way to automate project documentation updates is scanning repository structure and config files to produce an evidence-based overview. This ensures documentation stays accurate as code and structure evolve.

Related Skills

Explore More Software Engineering Skills→
lv416elv416e
6

repository-analyzer

Analyze repository structure, technology stack, and documentation quality.

Community
Advanced
h-4vokh-4vok

repo-validate

Run lint, typecheck, test, smoke, and build checks across a repository and emit a pass/fail report.

Community
Intermediate
vm0-aivm0-ai
76

github-automation

Automate GitHub repository, issue, PR, release, and workflow operations via gh CLI.

Official
Advanced
nashgaonashgao
3

doc

Generate READMEs, API references, and getting started guides for projects.

Community
Advanced