Get the FREE Ultimate OpenClaw Setup Guide →

claude-md-template

npx machina-cli add skill claude-world/director-mode-lite/claude-md-template --openclaw
Files (1)
SKILL.md
1.2 KB

CLAUDE.md Template Generator

Generate a customized CLAUDE.md template based on detected project type.


Detection

  1. Language: package.json, requirements.txt, Cargo.toml, go.mod
  2. Framework: Parse dependencies
  3. Package Manager: npm, pnpm, yarn, pip, cargo
  4. Test Framework: jest, pytest, cargo test
  5. Existing Patterns: .eslintrc, .prettierrc, tsconfig.json

Template Structure

# [Project Name] - Project Instructions

## Overview
[Auto-detected description]

## Tech Stack
| Category | Technology |
|----------|------------|
| Language | [detected] |
| Framework | [detected] |

## Development Commands
- Install: [detected]
- Dev: [detected]
- Test: [detected]
- Build: [detected]

## Project Structure
[Auto-generated tree]

## Coding Conventions
[Inferred from configs]

## Key Files
| File | Purpose |
|------|---------|
| [entry] | Main entry |

## Director Mode Commands
- /workflow - Start development
- /auto-loop - Autonomous TDD

After Generation

  1. Show generated CLAUDE.md
  2. Highlight [TODO] sections
  3. Offer to run /claude-md-check

Source

git clone https://github.com/claude-world/director-mode-lite/blob/main/skills/claude-md-template/SKILL.mdView on GitHub

Overview

CLAUDE.md Template Generator creates a project-specific CLAUDE.md by analyzing repository signals such as language, framework, package manager, test framework, and existing config patterns. It then renders a standardized template with project details, ready for review and onboarding.

How This Skill Works

It inspects key files (package.json, requirements.txt, Cargo.toml, go.mod) and indicators like .eslintrc or tsconfig.json to infer language, framework, package manager, and test framework. It then renders the Template Structure with these detections, shows the generated CLAUDE.md, highlights [TODO] sections, and optionally runs /claude-md-check for validation.

When to Use It

  • Initializing a new project and wanting a ready-made CLAUDE.md scaffold
  • Onboarding teammates with a consistent documentation template
  • Standardizing CLAUDE workflows across a repo with detected language/framework
  • Maintaining a multi-language monorepo where each package needs its own CLAUDE.md
  • Preparing a template before code reviews or automation passes that rely on CLAUDE.md

Quick Start

  1. Step 1: Trigger the claude-md-template skill for the current project to generate CLAUDE.md
  2. Step 2: Review the generated CLAUDE.md, focusing on detected language/framework and the [TODO] sections
  3. Step 3: Optionally run /claude-md-check to validate formatting and readiness

Best Practices

  • Ensure the detection logic matches your project by validating language, framework, and patterns against actual files
  • Review and fill all [TODO] sections before sharing or merging
  • Keep Tech Stack and Key Files tables consistent in formatting and terminology
  • Validate the generated CLAUDE.md with /claude-md-check if available
  • Iterate on the template to reflect project-specific conventions and tooling

Example Use Cases

  • React app (package.json, tsconfig.json) generating a CLAUDE.md with Language: TypeScript and Framework: React
  • Python Flask app (requirements.txt) generating a CLAUDE.md with Language: Python and Test Framework: pytest
  • Rust CLI (Cargo.toml) generating a CLAUDE.md with Language: Rust and Test Framework: cargo test
  • Go web service (go.mod) generating a CLAUDE.md with Language: Go and Test Framework: go test
  • Monorepo with multiple languages generating per-package CLAUDE.md templates and a root CLAUDE.md

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers