Nika-HISK/ReadMe-maker: Mastra 프레임워크와 Claude AI 기반의 지능형 GitHub README 생성기

Mastra 프레임워크와 Claude AI를 활용한 지능형 GitHub README 생성기입니다. 이 프로젝트는 코드 구조, 커밋 기록 및 프로젝트 패턴을 검토하여 GitHub 리포지토리를 자동으로 분석하고 포괄적이며 잘 구조화된 README.md 파일을 생성합니다.

AI 기반 분석: 리포지토리 구조와 콘텐츠를 지능적으로 분석하기 위해 Claude 3.5 Sonnet을 사용합니다.
포괄적인 코드 스캔: TypeScript, JavaScript, Python, Java 파일 및 설정 파일을 검사합니다.
커밋 기록 통합: 프로젝트의 진화를 이해하기 위해 최근 커밋 메시지를 포함합니다.
에이전트 기반 아키텍처: 강력한 도구 오케스트레이션을 위해 Mastra 프레임워크로 구축되었습니다.
메모리 지속성: LibSQL 스토리지를 사용하여 대화 컨텍스트를 유지합니다.
자동 마크다운 생성: 깨끗하고 적절하게 형식화된 README 파일을 생성합니다.
다중 도구 통합: 파일 분석, 콘텐츠 가져오기 및 커밋 추적을 결합합니다.

생성되는 README에는 다음 내용이 포함됩니다:

• 적절한 이모지를 포함한 프로젝트 제목
• 기능 설명
• 설치 및 설정 지침
• 기술 스택 개요
• 프로젝트 구조 시각화
• 최근 커밋 활동
• 기여 가이드라인

git clone https://github.com/Nika-HISK/ReadMe-maker.git

cd ReadMe-maker

npm install

루트 디렉터리에 .env 파일을 생성합니다:

ANTHROPIC_API_KEY=your_anthropic_api_key_here
GITHUB_TOKEN=your_github_token_here

npm start

실행 후, GitHub 에이전트와 채팅할 수 있습니다:

# 예시 대화
You: "facebook/react에 대한 README를 생성해 줘"
Agent: [리포지토리를 분석하고 완전한 README.md 콘텐츠를 반환]
...

Mastra 프레임워크: 에이전트 오케스트레이션 및 도구 관리
Claude 3.5 Sonnet: 지능형 README 생성을 위한 AI 모델
Octokit: 리포지토리 데이터 가져오기를 위한 GitHub API 클라이언트
LibSQL: 대화 메모리를 위한 로컬 데이터베이스
Zod: 런타임 타입 검증 및 스키마 정의
TypeScript: 타입 안정적인 개발 환경

src/
├── mastra/
│ ├── agents/
...

GitHub 에이전트는 다음 기능으로 구성됩니다:

모델: Claude 3.5 Sonnet (claude-3-5-sonnet-20241022)메모리: LibSQL 기반 영구 저장소도구: 파일 분석, 콘텐츠 가져오기, 커밋 추적, README 생성

저장소 분석: 에이전트가 대상 저장소 구조를 스캔합니다.
콘텐츠 추출: 중요한 파일(TypeScript, JavaScript, Python, Java, configs)을 가져옵니다.
커밋 기록: 컨텍스트를 위해 최근 커밋 메시지를 검색합니다.
AI 처리: Claude가 수집된 데이터를 분석하여 프로젝트를 이해합니다.
README 생성: 적절한 형식으로 포맷팅된 종합적인 README를 만듭니다.
검증: 마크다운 형식이 정확하고 깔끔한지 확인합니다.

• 저장소를 포크(Fork)합니다.

• 기능 브랜치를 생성합니다 (git checkout -b feature/amazing-feature)

• 변경 사항을 커밋합니다 (git commit -m 'Add amazing feature')

• 브랜치에 푸시합니다 (git push origin feature/amazing-feature)

• 풀 리퀘스트(Pull Request)를 엽니다.

• Node.js (v18 이상)

• Anthropic API 키

• GitHub 개인 액세스 토큰

• TypeScript 및 AI 에이전트에 대한 기본적인 이해

• Anthropic 콘솔을 방문합니다.

• 계정을 생성하거나 로그인합니다.

• API 키를 생성합니다.

• .env 파일에 추가합니다.

• GitHub 설정 → 개발자 설정 → 개인 액세스 토큰으로 이동합니다.

• 저장소 접근 권한이 있는 새 토큰을 생성합니다.

• .env 파일에 추가합니다.

Generate a README for vercel/next.js

# Next.js ⚡
The React Framework for Production
## ✨ Features
...

MIT 라이선스 - 이 프로젝트를 자체 README 생성 필요에 자유롭게 사용하세요!

Mastra 프레임워크: 우수한 에이전트 오케스트레이션 기능을 제공합니다.
Anthropic: 강력한 Claude AI 모델을 제공합니다.
GitHub: 저장소 분석을 가능하게 하는 포괄적인 API를 제공합니다.