claude-md-init

Generate a CLAUDE.md at the repository root with project structure, commands, and constraints.

1|Updated Dec 21, 2025
One-click install
npx skills add https://github.com/cdrguru/portable-agent-kit --skill claude-md-init
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: claude-md-init
Source: https://github.com/cdrguru/portable-agent-kit/tree/main/.agent/skills/claude-md-init
Command: npx skills add https://github.com/cdrguru/portable-agent-kit --skill claude-md-init

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates a CLAUDE.md at the repository root to orient Claude Code with the project's structure, commands, and constraints, ensuring a consistent startup context.

Core Features & Use Cases

  • Template-based CLAUDE.md generation tailored to the repository, summarizing architecture, commands, and constraints.
  • Inlines an optional Agent Context reference for PACK-enabled projects and a guide for session initialization.
  • Helps teams standardize onboarding and ensure Claude Code loads correct project conventions on startup.

Quick Start

Copy the template to the repo root, replace placeholders, and commit CLAUDE.md so Claude Code can load it on startup.

Frequently Asked Questions about claude-md-init

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

FAQPage Schema
How do I generate a CLAUDE.md file to provide project context for Claude Code?

To generate a CLAUDE.md file, you copy a template to the repository root, replace placeholders with architecture and commands, and commit it so Claude Code loads the project conventions on startup.

What is a CLAUDE.md file used for in a software repository?

A CLAUDE.md file is used to orient Claude Code by summarizing project architecture, commands, key files, and constraints, ensuring a consistent startup context for AI agent sessions.

Can I standardize Claude Code onboarding across my team using a template?

Yes, you can standardize onboarding by applying a template-derived CLAUDE.md at the repository root, ensuring the entire team loads correct project conventions and consistent session context.

Does the generated CLAUDE.md support PACK-enabled projects?

Yes, the generated CLAUDE.md supports PACK-enabled projects by inlining an optional Agent Context reference section to guide session initialization and maintain agent context.

What sections are included in the auto-generated CLAUDE.md?

The auto-generated CLAUDE.md includes Architecture, Commands, Key Files, Constraints, and an optional Agent Context section to comprehensively orient Claude Code with the repository.

Why do I need to commit CLAUDE.md to the repository root?

You need to commit CLAUDE.md to the repository root so Claude Code can automatically discover and load the project structure, commands, and constraints on startup.