Home / Glossary / CLAUDE.md

Definition

CLAUDE.md

CLAUDE.md ialah fail konfigurasi markdown yang diletakkan di akar projek anda yang memberikan Claude Code arahan berterusan khusus projek. Ia memberitahu ejen tentang konvensyen pengekodan, seni bina, arahan biasa dan peraturan anda — bertindak sebagai bentuk memori jangka panjang yang digunakan dalam setiap sesi dalam projek tersebut.

Cara CLAUDE.md berfungsi

Apabila Claude Code memulakan sesi, ia secara automatik membaca fail CLAUDE.md di akar projek anda (dan mana-mana fail CLAUDE.md dalam direktori induk atau subdirektori). Kandungan menjadi sebahagian daripada konteks sistem ejen, jadi ia mengikut arahan anda tanpa perlu diingatkan setiap sesi. Ini menjadikan ejen berkelakuan konsisten dengan konvensyen pasukan anda.

Apa yang perlu disertakan dalam CLAUDE.md

  • +Gambaran keseluruhan seni bina projek dan lokasi fail utama
  • +Konvensyen pengekodan (penamaan, pemformatan, corak yang perlu digunakan atau dielakkan)
  • +Arahan biasa untuk menguji, membina dan menggunakan
  • +Peraturan seperti "sentiasa tulis ujian untuk fungsi baru" atau "jangan ubah suai modul auth secara langsung"
  • +Butiran tindanan teknologi yang perlu diketahui oleh ejen
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

Pastikan CLAUDE.md ringkas. Ejen membacanya setiap sesi, jadi hanya sertakan maklumat yang relevan merentasi pelbagai tugasan. Pindahkan butiran khusus tugasan ke dalam gesaan anda.

Di mana saya harus meletakkan fail CLAUDE.md?+
Letakkan di akar direktori projek anda. Claude Code juga menyokong fail CLAUDE.md dalam subdirektori untuk arahan khusus modul dan dalam direktori induk untuk peraturan seluruh organisasi. Semua fail yang berkenaan digabungkan bersama.
Adakah CLAUDE.md berfungsi dengan alat AI lain?+
CLAUDE.md khusus untuk Claude Code. Walau bagaimanapun, beberapa alat lain telah mengamalkan konsep yang serupa. Cursor menggunakan .cursorrules dan ejen lain mungkin membaca fail konfigurasi tersuai. Konsep arahan AI peringkat projek semakin menjadi corak biasa.
Berapa panjang CLAUDE.md seharusnya?+
Pastikan di bawah 500 baris. Fokus pada konvensyen dan peraturan yang paling penting. Ejen sentiasa boleh membaca fail individu untuk mendapatkan butiran — CLAUDE.md harus memberikan konteks peringkat tinggi yang digunakan merentasi tugasan.

Related terms

Agentic CodingClaude CodeKejuruteraan Gesaan untuk Kod

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