Skip to main content
Template

Template CLAUDE.md untuk Repository Apa Pun

CLAUDE.md awal 70 baris: proyek, stack, perintah, aturan keras, cara memverifikasi pekerjaan, dan yang tidak boleh dilakukan.

Oleh Matthews WongDiperbarui Dicek dengan Claude Code 2.1.323 docs

Poin utama

CLAUDE.md awal yang Anda salin ke root repository lalu sunting. Isinya delapan bagian pendek dengan placeholder dalam kurung siku: apa proyeknya, stack, perintah, peta direktori, aturan keras, konvensi, cara memverifikasi pekerjaan, dan yang tidak boleh dilakukan. Claude Code membaca file ini di awal setiap sesi, jadi template dijaga sekitar 70 baris dan prosedur panjang diserahkan ke skill.

1 file

File-nya

Persis isi unduhannya. Baca dulu, lalu salin atau unduh.

CLAUDE.md
# [Project name]

<!--
Starter CLAUDE.md. Save it at the repository root, replace every [bracketed]
part, and delete any section that has nothing true to say. Claude reads this
file at the start of every session, so each line should earn its place.
Comments like this one are for people; delete them when you are done.
-->

## What this project is

[One or two sentences: what it does, who uses it, and where it runs.]

## Stack

- Language and runtime: [for example TypeScript on Node.js 22]
- Framework: [name and major version]
- Data: [database, ORM or query layer]
- Tests: [test runner]
- Deploy: [how and where it ships]

## Commands

```bash
[dev command]     # start the app locally
[test command]    # run the tests; single file: [how]
[lint command]    # lint and format check
[build command]   # production build
```

## Directory map

```text
[src/app/]        [routes or entry points]
[src/lib/]        [shared logic]
[src/db/]         [schema and migrations]
[tests/]          [where tests live and how they are named]
```

## Hard rules

These break the build or production when ignored.

1. [Rule, and what fails when it is broken]
2. [Rule, and what fails when it is broken]
3. Never commit secrets. Configuration comes from [where].

## Conventions

- [Naming: files, functions, database columns]
- [Imports: the alias or the order to use]
- [Errors: how they are raised, logged and returned]
- Follow the patterns in the file you are editing before adding a new one.

## How to verify work

- Read a file before editing it, and the files that call it.
- For a bug, reproduce it first, then fix it, then run the same reproduction.
- After each change run `[test command]` and `[lint command]`, and report
  the real output. Do not say it works without running it.
- [Any check specific to this project, such as a type check or a migration
  dry run]

## What not to do

- Do not refactor or rename things outside the task unless asked.
- Do not add a dependency without asking.
- Do not edit [generated files or folders]; change [their source] instead.
- Do not commit or push unless asked. One logical change per commit.
- [Anything this team has been burned by before]
Cara memakainya

Dari unduh sampai jalan

Pakai saat

  • Anda mulai memakai Claude Code di repository yang belum punya CLAUDE.md.
  • Claude terus menebak perintah tes atau build Anda, atau terus melanggar aturan yang sama.
  • CLAUDE.md Anda sekarang sudah panjang dan Anda ingin struktur ramping untuk memindahkannya.
  • Tim Anda ingin bagian yang sama di setiap repository.
  1. Simpan di root repository

    Unduh filenya dan simpan sebagai CLAUDE.md di root repository Anda. Claude Code juga menerima .claude/CLAUDE.md. Commit agar seluruh tim memakai instruksi yang sama.

  2. Isi bagian perintah lebih dulu

    Ganti empat placeholder perintah dengan perintah dev, test, lint, dan build yang persis. Inilah baris yang paling sering dipakai Claude, dan yang tidak bisa ditebaknya dengan andal.

  3. Tulis aturan keras dari kegagalan nyata

    Daftarkan beberapa hal yang merusak build atau production, masing-masing dengan apa yang gagal. Tulis secara spesifik: aturan yang menyebut file dan pemeriksaannya diikuti lebih konsisten daripada aturan umum.

  4. Hapus yang tidak bisa Anda isi

    Buang bagian atau butir yang tidak punya isi yang benar, dan hapus komentar di bagian atas. Placeholder kosong memakan konteks di setiap sesi dan tidak memberi tahu Claude apa pun.

  5. Mulai sesi baru dan periksa

    Jalankan Claude Code di repository itu dan jalankan /memory, yang menampilkan daftar file CLAUDE.md Anda, dan pastikan file proyeknya ada. Lalu minta perubahan kecil dan perhatikan apakah Claude menjalankan perintah tes Anda tanpa disuruh.

Isinya

Kenapa ditulis seperti ini

Pendek, karena dimuat di setiap sesi

Claude membaca CLAUDE.md di awal setiap sesi, dan dokumentasi menargetkan di bawah 200 baris per file karena file yang lebih panjang memakan lebih banyak konteks dan menurunkan kepatuhan. Template ini sekitar 70 baris, sehingga masih ada ruang untuk aturan Anda sendiri.

Perintah dalam satu code block

Dev, test, lint, dan build ditaruh bersama dengan komentar masing-masing, termasuk cara menjalankan satu file tes. Claude bisa menyalin perintah yang persis alih-alih menebaknya dari file package.

Aturan keras dipisah dari konvensi

Hal yang merusak build diberi nomor dan menyebut apa yang gagal. Preferensi gaya masuk ke Conventions. Memisahkan keduanya memperlihatkan baris mana yang tidak bisa ditawar.

Bagian tentang cara memverifikasi pekerjaan

Baca sebelum menyunting, reproduksi bug sebelum memperbaikinya, jalankan tes setelah setiap perubahan, dan laporkan output yang sebenarnya. Kebiasaan kerja ini sudah terisi, karena berlaku di hampir semua repository.

Catatan untuk manusia dalam komentar HTML

Catatan petunjuk di bagian atas berupa komentar HTML tingkat blok. Claude Code membuang komentar seperti itu sebelum file masuk ke konteks Claude, jadi Anda bisa menyimpan catatan maintainer di sana tanpa menghabiskan token.

Perhatikan

Yang sering salah

  • CLAUDE.md adalah konteks, bukan penegakan. Untuk aturan yang tidak boleh dilanggar sama sekali, tambahkan juga hook atau aturan deny pada permission.
  • Jangan menempelkan seluruh README atau panduan gaya ke dalamnya. Prosedur panjang yang hanya penting untuk satu jenis tugas tempatnya di skill, yang dimuat hanya saat diperlukan.
  • Dua instruksi yang saling bertentangan membuat Claude memilih salah satunya. Tinjau file ini saat proyek berubah dan buang yang sudah usang.
  • Jangan pernah menaruh secret, token, atau password di CLAUDE.md. File ini di-commit ke repository dan dibaca di setiap sesi.
Pertanyaan

Yang sering ditanyakan

Jawaban singkat sebelum Anda mengunduhnya.

Di mana CLAUDE.md diletakkan?

Instruksi proyek ditaruh di CLAUDE.md pada root repository, atau di .claude/CLAUDE.md, dan dibagikan ke tim lewat version control. Instruksi pribadi untuk semua proyek Anda ditaruh di ~/.claude/CLAUDE.md. Catatan pribadi untuk satu proyek ditaruh di CLAUDE.local.md, yang Anda tambahkan ke .gitignore.

Seberapa panjang CLAUDE.md sebaiknya?

Dokumentasi Claude Code menargetkan di bawah 200 baris per file, karena file yang lebih panjang memakan lebih banyak konteks dan menurunkan kepatuhan. Template ini berangkat dari sekitar 70 baris. Saat bertambah panjang, pindahkan instruksi yang hanya penting untuk sebagian codebase ke rules berbasis path atau ke skill.

Sebaiknya pakai /init atau template ini?

Keduanya saling melengkapi. /init meminta Claude menganalisis codebase Anda dan membuat CLAUDE.md awal berisi perintah dan konvensi yang ditemukannya. Template ini memberi Anda bagian-bagian untuk mencocokkan draf tersebut, termasuk aturan keras dan daftar larangan yang tidak bisa ditemukan Claude sendiri.

Apakah Claude selalu mengikuti CLAUDE.md?

Tidak selalu. Dokumentasi menyatakan Claude memperlakukan file ini sebagai konteks, bukan konfigurasi yang dipaksakan, dan instruksi yang spesifik serta ringkas diikuti lebih konsisten. Untuk memblokir sebuah tindakan apa pun keputusan Claude, pakai PreToolUse hook.

Apakah CLAUDE.md di subfolder ikut dimuat?

Ya, tetapi belakangan. File di working directory dan semua direktori di atasnya dimuat saat mulai. CLAUDE.md di subdirektori dimuat saat dibutuhkan, yaitu ketika Claude membaca atau menyunting file di subdirektori itu. Karena itu file di subfolder cocok untuk aturan yang berlaku di satu bagian repository besar.

Pelajari lebih dalam

Pelajari apa yang dikemas file ini

Pelajaran dan artikel gratis di situs ini yang menjelaskan gagasan di baliknya.

Sumber

Sumber primer yang diperiksa pada tanggal riset. Ikuti tautannya untuk versi terbaru.

Lainnya dari toolkit

Ambil ini juga

TemplateGratis

Template .mcp.json untuk MCP Server Tim

File .mcp.json proyek dengan satu server stdio dan satu server HTTP, dengan secret dan path disimpan di environment variable.

  • Claude Code

2 file5.1 KB.zip

PromptGratis

Prompt Rencana Sebelum Coding

Prompt perencanaan yang mencakup bisnis, domain, tech design, dan langkah kerja, lalu mendaftar keputusan yang perlu Anda ambil.

  • Claude Code
  • Cursor
  • Claude.ai

1 file2.3 KB.md

Starter MCPGratis

Starter MCP Server dengan TypeScript

MCP server stdio dengan dua tool, satu resource, satu prompt, dan smoke test, memakai SDK v2.

  • Claude Code
  • Claude Desktop
  • Any MCP client

9 file11.1 KB.zip

Semua item toolkit