claude-md-생성기은(는) 무엇을 하나요?
CLAUDE.md 파일을 빠르게 생성하는 간단한 도구로, 프로젝트와 워크플로에 대한 명확하고 체계적인 문서를 만들어 줍니다.
개요
이 도구는 개발자가 프로젝트 설정과 워크플로를 문서화하는 과정을 간소화합니다. CLAUDE.md 파일을 생성함으로써 AI 어시스턴트가 프로젝트의 구조, 규칙, 그리고 의도된 워크플로를 좀 더 잘 이해할 수 있습니다.
사용 방법
1. 설치
패키지를 글로벌 또는 로컬로 설치하세요:
npm install -g looseleaf-acrylic560/claude-md-generator
또는 프로젝트 내에서 바로 사용하려면:
npx looseleaf-acrylic560/claude-md-generator
2. 기본 사용법
터미널에서 다음 명령어를 실행하세요:
claude-md-generator init
이 명령어는 현재 디렉토리에 기본 CLAUDE.md 파일을 생성합니다.
3. 옵션
--template <name>: 사전 정의된 템플릿을 사용합니다 (예:node,python,go).--output <path>: 다른 출력 경로를 지정합니다.--force: 기존 파일을 덮어씁니다.
예시:
claude-md-generator init --template node --output ./docs/CLAUDE.md --force
예시 출력
# 프로젝트 이름
이 프로젝트는 Node.js로 작성된 웹 애플리케이션입니다.
## 기술 스택
- Node.js 18+
- Express.js
- PostgreSQL
## 개발 워크플로
1. `npm install`로 의존성을 설치합니다.
2. `npm run dev`로 개발 서버를 시작합니다.
3. `npm test`로 테스트를 실행합니다.
## 코드 규칙
- 함수는 설명적인 이름을 사용하세요.
- 오류 처리는 항상 try-catch를 사용하세요.
- commit 메시지는 [Conventional Commits](https://www.conventionalcommits.org/)을 따르세요.
FAQ
Q: 이 도구는 어떤 AI 플랫폼을 지원하나요?
A: 주로 Claude Code와 같은 AI 코딩 에이전트와 함께 사용하도록 설계되었습니다. CLAUDE.md 형식을 이해하는 모든 AI 어시스턴트와 호환됩니다.
Q: 나만의 템플릿을 커스터마이즈할 수 있나요?
A: 네, 사용자 정의 템플릿을 만들고 --template 옵션을 사용하여 지정할 수 있습니다. 템플릿 디렉토리에 대한 자세한 내용은 문서를 참조하세요.
Q: CLAUDE.md가 이미 존재하면 어떻게 되나요?
A: --force 플래그를 사용하지 않으면 기존 파일을 덮어쓰지 않습니다. 이 플래그를 사용하면 안전 확인 없이 덮어씁니다.
지원
문제가 발생하면 GitHub 저장소에서 이슈를 열어주세요.