# Claude Md Init

> Generate a CLAUDE.md project file that orients Claude Code to the repo's structure, commands, and constraints. Use when this capability is needed.

- Skill: `tomevault-io/claude-md-init` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/claude-md-init`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/claude-md-init/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/claude-md-init

---


# CLAUDE.md Generator

## When to use
Use when a repository needs a `CLAUDE.md` file so Claude Code automatically understands the project's structure, commands, and conventions at session start.

## Procedure
1. Copy the template to the repo root:

```bash
cp .agent/skills/claude-md-init/templates/CLAUDE.md.template CLAUDE.md
```

2. Replace the placeholders:
   - `${PROJECT_NAME}` -- repo or project name
   - `${PROJECT_DESCRIPTION}` -- one-line description
   - Fill in the Architecture, Commands, and Constraints sections

3. Scan the repo and add relevant details:
   - Key directories and their purpose
   - Build/test/lint commands (from Makefile, package.json, etc.)
   - Available skills (if PACK is deployed)
   - Project-specific constraints and conventions

4. Verify Claude Code picks it up:

```bash
cat CLAUDE.md
```

## Inputs and outputs
- Inputs: Repository with established structure, optional `.agent/` directory
- Outputs: `CLAUDE.md` at the repo root

## Constraints
- Keep it concise -- Claude Code loads this on every interaction
- Do not duplicate content that lives in other files -- reference them instead
- ASCII-only

## Examples
- $claude-md-init

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/cdrguru) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-13 -->