Afaik
책 읽기클로드코드 완벽가이드

CLAUDE.md 파일에 대하여

CLAUDE.md 가 무엇인가?

  • 클로드 코드가 프로젝트의 아키텍처, 코딩 규칙, 작업 절차등을 깊이 있게 파악하는 파일
  • 새로운 팀원에게 프로젝트를 설명하는 브리핑 문서라고 생각하면 된다.

CLAUDE.md에 어떤 정보를 입력해야할까?

  • 자주 사용하는 bash 명렁어
  • 핵심 파일 및 유틸리티 함수
  • 코드 스타일 가이드라인
  • 테스트 지침
  • 일괄적으로 사용하고 싶은 라이브러리에 대한 정보
  • 아키텍처에 대한 정보

너무 많은 내용을 CLAUDE.md에 입력하면 클로드 코드가 실질적인 문제 해결에 쓸 콘텍스트 윈도우를 손해볼 수 있다.

CLAUDE.md 파일 종류 3가지

프로젝트 메모리 (./CLAUDE.md)

  • 가장 일반적인 유형의 메모리 파일, 프로젝트의 루트에 위치하며, 팀 전체에 적용할 규칙과 정보를 담는다.
  • 프로젝트 아키텍처, 코딩 표준, 일반적인 워크플로

로컬 프로젝트 메모리 (./claude.local.md)

  • 개인적인 프로젝트 관련 설정을 위한 파일
  • .gitignore에 추가해 개인 설정이 원격 저장소에 커밋되는 것을 방지

사용자 메모리(~/.claude/CLAUDE.md)

  • 모든 프로젝트에 적용되는 전역 설정
  • 일반적인 코드스타일 선호도, 개인 도구를 위한 단축키

정리

  • 프로젝트 전반에 걸쳐 적용하기 싶은 내 취향의 규칙은 사용자 메모리에 입력
  • 특정 프로젝트에 관련된 설정이거나 팀원과 공유할 때 프로젝트 메모리에 입력
  • 특정 프로젝트 관련 설정이지만 팀원에게 공유할 필요가 없는 설정은 로컬 메모리에 입력

CLAUDE.md 파일 관리 노하우

  • # 키로 메모리에 정보를 추가시켜 md 파일에 저장할 수 있다.
  • IMPORTANT, YOU MUST 등 강조 표현을 사용하면 좋다.

클로드 코드에게 주기적으로 관리하기

  • 하나의 대화가 끝날 때마다 클로드 코드에 현재까지 대화 내용을 기반으로 CLAUDE.md 파일에 추가할 만한 내용을 추천받아 내용 추가
  • 주기적으로 CLAUDE.md 파일을 정리해달라고 요청하기
Edit on GitHub

Last updated on