creating-claude-md

Generate a lean CLAUDE.md by scanning repository content and conducting a six-question interview.

64|4|Updated May 17, 2026
One-click install
npx skills add https://github.com/sruthik27/creating-claude-md --skill creating-claude-md
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: creating-claude-md
Source: https://github.com/sruthik27/creating-claude-md/tree/main
Command: npx skills add https://github.com/sruthik27/creating-claude-md --skill creating-claude-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams generate a lean CLAUDE.md for a repository from scratch, consolidating scanning, interviewing, and decision-making into a compact, high-signal document under 80 lines (120 hard cap).

Core Features & Use Cases

  • Autonomous repo scan to gather mechanical content (manifests, structure, configs, git history, existing docs).
  • A focused 6-question interview to capture judgment content (WHY, gotchas, out-of-scope, approval gates, testing philosophy, external docs like Confluence pages).
  • Enforces an 80-line target; splits oversized sections into agent_docs/*.md when needed; writes CLAUDE.md at repo root.
  • NOT for auditing or incremental improvements; this is the bootstrap workflow for a fresh CLAUDE.md.

Quick Start

Ask Claude Code to generate a CLAUDE.md for your repository by running the bootstrap workflow.

Frequently Asked Questions about creating-claude-md

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

FAQPage Schema
How do I generate a CLAUDE.md for a new repository?

To generate a CLAUDE.md for a new repository, run the bootstrap workflow to scan manifests and configs, answer a six-question interview, and output a lean file under 80 lines at the repo root.

What is the best way to bootstrap a CLAUDE.md from scratch?

The best way to bootstrap a CLAUDE.md from scratch is using an automated workflow that combines mechanical repo scanning with a focused user interview to capture project WHY, gotchas, and testing philosophy into a high-signal document.

Does CLAUDE.md generation work with existing documentation and configs?

Yes, CLAUDE.md generation works with existing documentation by scanning mechanical content like manifests, repo structure, configs, and git history to consolidate existing project details into a single high-signal file.

How do I keep CLAUDE.md under 80 lines when documenting complex repos?

To keep CLAUDE.md under 80 lines for complex repos, the bootstrap workflow enforces a 120-line hard cap and automatically splits oversized sections into auxiliary agent_docs/*.md files while retaining core context in the main file.

When should I not use an automated CLAUDE.md bootstrap workflow?

You should not use an automated CLAUDE.md bootstrap workflow for auditing existing files or making incremental improvements, as this process is strictly designed for generating a fresh CLAUDE.md from scratch.

What should a CLAUDE.md contain to guide AI coding agents?

A CLAUDE.md should contain mechanical repo details from scanning plus judgment content captured via a six-question interview, covering project WHY, gotchas, out-of-scope areas, approval gates, and testing philosophy to effectively guide AI agents.