claude-md · luongnv89 — Claude Code skill: write and prune CLAUDE.md
Creates, updates or audits CLAUDE.md following agent-onboarding practice. Handy once the file grows long and the agent stops following it.
npx skills add luongnv89/claude-howto --skill claude-md -a claude-codeWhat claude-md does
The skill runs in three modes: create writes CLAUDE.md from scratch, update cleans up an existing one, audit only reports and leaves the file alone. You can pass a path like src/api/CLAUDE.md when a directory needs its own instructions.
It starts by reading the project: looks for CLAUDE.md at the root, in .claude/, across directories and in ~/.claude/CLAUDE.md, then works out the stack and project type and reads README.md plus files such as package.json or pyproject.toml. Content is organised around three questions: what the technology and structure are, why the project exists, how to work in it. A draft goes up for review, and writing happens after you approve it.
The hard limit is length: under 200 lines. Style and formatting rules get dropped, since prettier and eslint handle those better than a model does. Code snippets are replaced with file:line references, because pasted code goes stale. For larger projects the skill suggests moving detail into agent_docs/ and pointing at it from CLAUDE.md. If you ask for AGENTS.md, it covers how Claude reads that file directly and when you need an @AGENTS.md import or a symlink instead.
What it helps with
- write a CLAUDE.md for a fresh repository
- strip lint rules and code blocks out of project instructions
- cut an oversized CLAUDE.md down to a workable length
- audit the file's quality without editing it
- move build and test detail into separate docs
Example prompts for the agent
- create a CLAUDE.md for this project
- update CLAUDE.md and remove everything unnecessary
- audit CLAUDE.md and show me the report
How to install claude-md
1Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill claude-md -a claude-code2Manually: put the files in place
~/.claude/skills/claude-md/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/claude-md/
1Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill claude-md -a codex2Manually: put the files in place
.agents/skills/claude-md/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill claude-md -a cursor2Manually: put the files in place
.cursor/skills/claude-md/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install luongnv89/claude-howto claude-md2Manually: put the files in place
.github/skills/claude-md/SKILL.md1Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill claude-md -a gemini-cli2Platform CLI
gemini skills install https://github.com/luongnv89/claude-howto --path uk/03-skills/claude-mdManually: put the files in place
.devin/skills/claude-md/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill claude-md -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about claude-md
How do I install claude-md in Claude?
Run npx skills add luongnv89/claude-howto --skill claude-md -a claude-code. The skill file then sits at ~/.claude/skills/claude-md/SKILL.md.
What does claude-md do?
It writes a new CLAUDE.md, rewrites an existing one, or produces a quality report. In audit mode the file stays untouched.
Why should CLAUDE.md stay under 200 lines?
Models can follow only so many instructions, and the Claude system prompt already uses part of that budget. So the skill cuts style rules and anything that is not relevant to every session.
Source text
SKILL.md · MIT
--- name: claude-md description: Створення або оновлення файлів CLAUDE.md відповідно до найкращих практик для оптимального онбордингу AI-агента --- ## Введення користувача ```text $ARGUMENTS ``` Ви **ПОВИННІ** врахувати введення користувача перед продовженням (якщо не порожнє). Користувач може вказати: - `create` — створити новий CLAUDE.md з нуля - `update` — покращити існуючий CLAUDE.md - `audit` — проаналізувати та звітувати про якість поточного CLAUDE.md - Конкретний шлях для створення/оновлення (напр., `src/api/CLAUDE.md` для інструкцій, специфічних для каталогу) ## Основні принципи **LLM не мають стану**: CLAUDE.md — головний файл проєкту, що завантажується в кожну розмову (разом з автоматичною пам'яттю та правилами без обмеження області). Він слугує головним документом онбордингу AI-агентів у вашу кодову базу. ### Золоті правила 1. **Менше — краще**: Найсучасніші LLM можуть дотримуватись ~150-200 інструкцій. Системний промпт Claude Code вже використовує ~50. Тримайте CLAUDE.md зосередженим та лаконічним. 2. **Універсальна застосовність**: Включайте лише інформацію, релевантну для КОЖНОЇ сесії. Інструкції для конкретних завдань належать до окремих файлів. 3. **Не використовуйте Claude як лінтер**: Рекомендації зі стилю роздувають контекст та погіршують дотримання інструкцій. Використовуйте натомість детерміністичні інструменти (prettier, eslint тощо). 4. **Ніколи не генеруйте автоматично**: CLAUDE.md — найвпливовіша точка AI-системи. Створюйте його вручну з ретельним обмірковуванням. ## Потік виконання ### 1. Аналіз проєкту Спочатку проаналізуйте поточний стан проєкту: 1. Перевірити наявні файли CLAUDE.md: - Кореневий рівень: `./CLAUDE.md` або `.claude/CLAUDE.md` - Специфічні для каталогу: `**/CLAUDE.md` - Глобальний конфіг користувача: `~/.claude/CLAUDE.md` 2. Визначити структуру проєкту: - Технологічний стек (мови, фреймворки) - Тип проєкту (монорепо, окремий додаток, бібліотека) - Інструменти розробки (пакетний менеджер, система збірки, тест-раннер) 3. Переглянути існуючу документацію: - README.md - CONTRIBUTING.md - package.json, pyproject.toml, Cargo.toml тощо ### 2. Стратегія контенту (ЩО, ЧОМУ, ЯК) Структуруйте CLAUDE.md навколо трьох вимірів: #### ЩО — Технологія та структура - Огляд технологічного стеку - Організація проєкту (особливо важливо для монорепо) - Ключові каталоги та їхнє призначення #### ЧОМУ — Призначення та контекст - Що робить проєкт - Чому були прийняті певні архітектурні рішення - За що відповідає кожен основний компонент #### ЯК — Робочий процес та конвенції - Робочий процес розробки (bun vs node, pip vs uv тощо) - Процедури та команди тестування - Методи верифікації та збірки - Критичні «підводні камені» або неочевидні вимоги ### 3. Стратегія поступового розкриття Для великих проєктів рекомендуйте створити папку `agent_docs/`: ``` agent_docs/ |- building_the_project.md |- running_tests.md |- code_conventions.md |- architecture_decisions.md ``` У CLAUDE.md посилайтесь на ці файли інструкціями: ```markdown For detailed build instructions, refer to `agent_docs/building_the_project.md` ``` **Важливо**: Використовуйте посилання `файл:рядок` замість фрагментів коду, щоб уникнути застарілого контексту. ### 4. Обмеження якості При створенні або оновленні CLAUDE.md: 1. **Цільова довжина**: Менше 200 рядків 2. **Без правил стилю**: Видалити будь-які інструкції лінтингу/форматування 3. **Без інструкцій для конкретних завдань**: Перемістити до окремих файлів 4. **Без фрагментів коду**: Використовувати посилання на файли замість цього 5. **Без надлишкової інформації**: Не повторювати те, що є в package.json або README ### 5. Обовʼязкові секції Добре структурований CLAUDE.md має включати: ```markdown # Назва проєкту Короткий однорядковий опис. ## Технологічний стек - Основна мова та версія - Ключові фреймворки/бібліотеки - База даних/сховище (якщо є) ## Структура проєкту [Лише для монорепо або складних структур] - `apps/` - Точки входу додатків - `packages/` - Спільні бібліотеки ## Команди розробки - Встановлення: `команда` - Тестування: `команда` - Збірка: `команда` ## Критичні конвенції [Лише неочевидні, високовпливові конвенції] - Конвенція 1 з коротким поясненням - Конвенція 2 з коротким поясненням ## Відомі проблеми / Підводні камені [Речі, що постійно створюють труднощі розробникам] - Проблема 1 - Проблема 2 ``` ### 6. Антипатерни, яких слід уникати **НЕ включайте:** - Рекомендації зі стилю коду (використовуйте лінтери) - Документацію щодо використання Claude - Довгі пояснення очевидних патернів - Скопійовані приклади коду - Загальні найкращі практики («пишіть чистий код») - Інструкції для конкретних завдань - Автозгенерований контент - Розлогі списки TODO ### 7. Контрольний список валідації Перед фіналізацією перевірте: - [ ] Менше 200 рядків - [ ] Кожен рядок застосовний до ВСІХ сесій - [ ] Без правил стилю/форматування - [ ] Без фрагментів коду (використані посилання на файли) - [ ] Команди перевірені на працездатність - [ ] Поступове розкриття використано для складних проєктів - [ ] Критичні підводні камені задокументовані - [ ] Немає надлишковості з README.md ## Формат виводу ### Для `create` або за замовчуванням: 1. Проаналізувати проєкт 2. Створити чернетку CLAUDE.md за структурою вище 3. Представити чернетку для перегляду 4. Записати у відповідне місце після затвердження ### Для `update`: 1. Прочитати існуючий CLAUDE.md 2. Аудит за найкращими практиками 3. Визначити: - Контент для видалення (правила стилю, фрагменти коду, специфічне для завдань) - Контент для скорочення - Відсутню важливу інформацію 4. Представити зміни для перегляду 5. Застосувати зміни після затвердження ### Для `audit`: 1. Прочитати існуючий CLAUDE.md 2. Згенерувати звіт з: - Поточна кількість рядків vs ціль - Відсоток універсально застосовного контенту - Список знайдених антипатернів - Рекомендації для покращення 3. НЕ модифікувати файл, лише звітувати ## Обробка AGENTS.md Якщо користувач запитує створення/оновлення AGENTS.md: **Починаючи з v2.1.277, Claude Code читає `AGENTS.md` напряму як інструкції проєкту** — але лише тоді, коли ні в робочому каталозі, ні в жодному каталозі вище немає `CLAUDE.md`, `.claude/CLAUDE.md` чи `CLAUDE.local.md`. `~/.claude/CLAUDE.md`, керований CLAUDE.md і `.claude/rules/` не враховуються в цій перевірці та завантажуються паралельно. Поведінку визначає **Project instructions** у `/config`: `claude-md-or-agents-md` (за замовчуванням), `claude-md-and-agents-md`, `claude-md` або `managed-only`. Там, де пряме читання недоступне — версії до v2.1.277 (до v2.1.281 на Bedrock/Vertex/Foundry, за LLM-шлюзами або з вимкненою телеметрією) або перша сесія після оновлення — використовуйте запасний варіант: імпортуйте файл з CLAUDE.md через `@AGENTS.md` або зробіть `CLAUDE.md` символічним посиланням на нього. AGENTS.md — це міжінструментальний файл контексту проєкту, тобто документ тієї ж *категорії*, що й CLAUDE.md, а не формат визначення агентів. Він існує для того, щоб кілька кодових агентів могли користуватися спільним набором конвенцій проєкту: - Команди збірки, тестування та лінтингу - Стиль коду та архітектурні конвенції - Структура репозиторію та розташування компонентів Субагенти визначаються окремо — у `.claude/agents/*.md`, а не в AGENTS.md. Застосовуйте аналогічні принципи: - Тримайте зосередженим та лаконічним - Використовуйте поступове розкриття - Посилайтесь на зовнішні документи замість вбудовування контенту ## Примітки - Завжди перевіряйте працездатність команд перед їх включенням - Якщо сумніваєтесь — не включайте; менше — краще - Системне нагадування повідомляє Claude, що CLAUDE.md «може бути або не бути релевантним» — чим більше шуму, тим більше він ігнорується - Монорепо найбільше виграють від чіткої структури ЩО/ЧОМУ/ЯК - Файли CLAUDE.md для конкретних каталогів мають бути ще більш зосередженими --- **Останнє оновлення**: 18 жовтня 2026 **Версія Claude Code**: 2.1.302 **Джерела**: - https://code.claude.com/docs/en/memory
© luongnv89 · MIT · luongnv89/claude-howto
Similar skills
All skills for Agent setup: memory, context, orchestration →claude-md by other authors comes first.