ddasy/claude-md-index-skill

claude-md-index-skill은(는) 무엇을 하나요?

Claude Code 스킬: 코드베이스에 계층형 Markdown 인덱스(INDEX.md + 디렉토리별 README + CLAUDE.md 규칙)를 부트스트래핑하여, Claude가 컨텍스트 소모 없이 빠르게 코드를 찾을 수 있도록 지원합니다.

개요

이 스킬은 코드베이스의 구조를 자동으로 분석하여 다음과 같은 파일들을 생성합니다:

• INDEX.md: 프로젝트 루트에 생성되는 최상위 인덱스로, 전체 디렉토리 구조를 개괄합니다.
• 각 디렉토리의 README.md: 해당 디렉토리의 파일과 하위 디렉토리에 대한 간결한 설명을 제공합니다.
• CLAUDE.md: Claude의 동작을 안내하는 규칙 파일로, 인덱스 파일을 우선 참조하도록 지시합니다.

이를 통해 Claude는 전체 코드를 읽지 않고도 필요한 파일을 빠르게 찾을 수 있습니다.

사용 방법

1. 터미널에서 다음 명령어를 실행하여 스킬을 설치합니다:

   claude add-skill ddasy/claude-md-index-skill
   

2. Claude Code 세션에서 다음 명령어를 사용합니다:

   /bootstrap-index
   

3. 스킬이 코드베이스를 스캔하고 인덱스 파일을 생성합니다.

설정

생성되는 파일의 위치와 형식은 claude-skills.yml 파일에서 커스터마이즈할 수 있습니다:

skills:
  ddasy/claude-md-index-skill:
    index_file: INDEX.md
    readme_file: README.md
    claude_rules_file: CLAUDE.md
    include_patterns:
      - "*.py"
      - "*.js"
      - "*.ts"
    exclude_patterns:
      - "node_modules"
      - ".git"

지원 플랫폼

• Claude Code: 기본 지원
• Cursor: 호환 가능 (수동 설정 필요)
• Codex: 호환 가능 (수동 설정 필요)

라이선스

MIT

# 예시: 생성된 INDEX.md
# 프로젝트 인덱스

- `/src` - 소스 코드
  - `/src/components` - UI 컴포넌트
  - `/src/utils` - 유틸리티 함수
- `/docs` - 문서
- `/tests` - 테스트 파일