Home / Glossary / CLAUDE.md

Definition

CLAUDE.md

CLAUDE.md to plik konfiguracyjny w formacie Markdown umieszczany w katalogu głównym projektu, który dostarcza Claude Code trwałych, specyficznych dla projektu instrukcji. Informuje agenta o konwencjach kodowania, architekturze, typowych poleceniach i zasadach — działając jako forma długotrwałej pamięci stosowanej podczas każdej sesji w tym projekcie.

Jak działa CLAUDE.md

Gdy Claude Code uruchamia sesję, automatycznie odczytuje plik CLAUDE.md w katalogu głównym projektu (oraz wszelkie pliki CLAUDE.md w katalogach nadrzędnych lub podkatalogach). Zawartość staje się częścią kontekstu systemowego agenta, dzięki czemu przestrzega Twoich instrukcji bez konieczności przypominania mu o nich przy każdej sesji. Sprawia to, że agent zachowuje się spójnie z konwencjami Twojego zespołu.

Co umieszczać w CLAUDE.md

  • +Przegląd architektury projektu i lokalizacje kluczowych plików
  • +Konwencje kodowania (nazewnictwo, formatowanie, wzorce do stosowania lub unikania)
  • +Typowe polecenia do testowania, budowania i wdrażania
  • +Zasady, takie jak „zawsze pisz testy do nowych funkcji" lub „nigdy nie modyfikuj modułu auth bezpośrednio"
  • +Szczegóły stosu technologicznego, o których agent powinien wiedzieć
markdown
# CLAUDE.md

## Project
Next.js 14 app with App Router, TypeScript, Tailwind CSS.

## Commands
- `npm run dev` — start dev server
- `npm test` — run Jest tests
- `npm run lint` — ESLint check

## Conventions
- Use server components by default
- Client components go in `components/client/`
- All API routes must validate input with Zod
- Write tests for every new utility function

## Do NOT
- Modify files in `lib/core/` without explicit approval
- Use `any` type in TypeScript
- Add new dependencies without justification

Trzymaj CLAUDE.md zwięzłe. Agent czyta go podczas każdej sesji, więc umieszczaj tylko informacje istotne w wielu zadaniach. Zamiast tego przenoś szczegóły dotyczące konkretnych zadań do swoich promptów.

Gdzie umieścić plik CLAUDE.md?+
Umieść go w katalogu głównym projektu. Claude Code obsługuje również pliki CLAUDE.md w podkatalogach do instrukcji specyficznych dla modułu oraz w katalogach nadrzędnych do zasad obowiązujących w całej organizacji. Wszystkie odpowiednie pliki są łączone.
Czy CLAUDE.md działa z innymi narzędziami AI?+
CLAUDE.md jest specyficzny dla Claude Code. Jednak niektóre inne narzędzia przyjęły podobne koncepcje. Cursor używa .cursorrules, a inne agenty mogą odczytywać niestandardowe pliki konfiguracyjne. Koncepcja instrukcji AI na poziomie projektu staje się powszechnym wzorcem.
Jak długi powinien być CLAUDE.md?+
Trzymaj go poniżej 500 linii. Skup się na najważniejszych konwencjach i zasadach. Agent zawsze może odczytać poszczególne pliki w celu uzyskania szczegółów — CLAUDE.md powinien zapewniać ogólny kontekst mający zastosowanie w różnych zadaniach.

Related terms

Agentic CodingClaude CodePrompt engineering dla kodu

Master Claude Code in days, not months

37 hands-on lessons from beginner to CI/CD automation. Module 1 is free.

START FREE →
← ALL TERMS