어디에 놓는 파일인가

Claude Code 공식 문서는 프로젝트 루트의 CLAUDE.md를 그 저장소에서 쓰는 안내 파일로 설명한다. 개인 설정은 사용자 홈의 ~/.claude에 둘 수 있다. 팀이 함께 쓰는 프로젝트 정보라면 저장소에 포함할지 결정할 수 있다.

CLAUDE.md에 기술 스택과 실행 명령을 적은 기본 예시
공식 문서의 프로젝트 안내 파일 용도를 바탕으로 재구성한 예시다.

이런 내용으로 시작할 수 있다

기술 스택이 React와 TypeScript라면 그 이름을 적고, 실행 명령이 npm run dev, npm test라면 그대로 적는다. 주요 화면이 src/pages에 있다는 식의 폴더 소개도 처음 저장소를 읽는 사람에게 도움이 된다. 명령어와 폴더 이름은 자기 프로젝트의 실제 값으로 바꿔야 한다.

민감한 값은 적지 않는다

저장소에 올라가는 파일에는 API 키, 비밀번호, 고객 데이터 같은 비밀 값을 넣지 않는다. 개인용 설정과 팀이 공유할 프로젝트 문서를 구분하고, 저장소의 실제 사용 방법이 바뀌면 안내 내용도 갱신한다.

기본 역할

프로젝트를 소개하는 짧은 안내 파일이다. 설치·실행 명령과 폴더 위치처럼 공개 가능한 정보부터 시작하면 된다.